1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
|
#include <pybind11/functional.h>
#include <pybind11/operators.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <pybind11/stl/filesystem.h>
#include "camera.h"
#include "engine.h"
#include "image.h"
#include "interactor.h"
#include "log.h"
#include "options.h"
#include "scene.h"
#include "types.h"
#include "utils.h"
#include "window.h"
namespace py = pybind11;
template<typename T, size_t S>
bool load_array(const py::handle& src, bool convert, std::array<T, S>& value)
{
if (!py::isinstance<py::sequence>(src))
{
return false;
}
const py::sequence l = py::reinterpret_borrow<py::sequence>(src);
if (l.size() != S)
{
return false;
}
size_t i = 0;
for (auto it : l)
{
value[i++] = py::cast<T>(it);
}
return true;
}
template<>
class py::detail::type_caster<f3d::point3_t>
{
public:
bool load(handle src, bool convert)
{
return load_array(src, convert, value);
}
static handle cast(const f3d::point3_t& src, return_value_policy, handle /* parent */)
{
return Py_BuildValue("ddd", src[0], src[1], src[2]);
}
PYBIND11_TYPE_CASTER(f3d::point3_t, const_name("f3d.point3_t"));
};
template<>
class py::detail::type_caster<f3d::vector3_t>
{
public:
bool load(handle src, bool convert)
{
return load_array(src, convert, value);
}
static handle cast(const f3d::vector3_t& src, return_value_policy, handle /* parent */)
{
return Py_BuildValue("ddd", src[0], src[1], src[2]);
}
PYBIND11_TYPE_CASTER(f3d::vector3_t, const_name("f3d.vector3_t"));
};
PYBIND11_MODULE(pyf3d, module)
{
module.doc() = "f3d library bindings";
// f3d::image
py::class_<f3d::image> image(module, "Image");
py::enum_<f3d::image::SaveFormat>(image, "SaveFormat")
.value("PNG", f3d::image::SaveFormat::PNG)
.value("JPG", f3d::image::SaveFormat::JPG)
.value("TIF", f3d::image::SaveFormat::TIF)
.value("BMP", f3d::image::SaveFormat::BMP)
.export_values();
py::enum_<f3d::image::ChannelType>(image, "ChannelType")
.value("BYTE", f3d::image::ChannelType::BYTE)
.value("SHORT", f3d::image::ChannelType::SHORT)
.value("FLOAT", f3d::image::ChannelType::FLOAT)
.export_values();
auto setImageBytes = [](f3d::image& img, const py::bytes& data)
{
const py::buffer_info info(py::buffer(data).request());
size_t expectedSize =
img.getChannelCount() * img.getWidth() * img.getHeight() * img.getChannelTypeSize();
if (info.itemsize != 1 || info.size != expectedSize)
{
throw py::value_error();
}
img.setContent(info.ptr);
};
auto getImageBytes = [](const f3d::image& img)
{
size_t expectedSize =
img.getChannelCount() * img.getWidth() * img.getHeight() * img.getChannelTypeSize();
return py::bytes(static_cast<char*>(img.getContent()), expectedSize);
};
auto getFileBytes = [](const f3d::image& img, f3d::image::SaveFormat format)
{
std::vector<unsigned char> result = img.saveBuffer(format);
return py::bytes(reinterpret_cast<char*>(result.data()), result.size());
};
image //
.def(py::init<>())
.def(py::init<const std::filesystem::path&>())
.def(py::init<unsigned int, unsigned int, unsigned int, f3d::image::ChannelType>())
.def(py::self == py::self)
.def(py::self != py::self)
.def_static("supported_formats", &f3d::image::getSupportedFormats)
.def_property_readonly("width", &f3d::image::getWidth)
.def_property_readonly("height", &f3d::image::getHeight)
.def_property_readonly("channel_count", &f3d::image::getChannelCount)
.def_property_readonly("channel_type", &f3d::image::getChannelType)
.def_property_readonly("channel_type_size", &f3d::image::getChannelTypeSize)
.def_property("content", getImageBytes, setImageBytes)
.def("compare", &f3d::image::compare)
.def(
"save", &f3d::image::save, py::arg("path"), py::arg("format") = f3d::image::SaveFormat::PNG)
.def("save_buffer", getFileBytes, py::arg("format") = f3d::image::SaveFormat::PNG)
.def("_repr_png_",
[&](const f3d::image& img) { return getFileBytes(img, f3d::image::SaveFormat::PNG); })
.def("to_terminal_text", [](const f3d::image& img) { return img.toTerminalText(); })
.def("set_metadata", &f3d::image::setMetadata)
.def("get_metadata",
[](const f3d::image& img, std::string key)
{
try
{
return img.getMetadata(std::move(key));
}
catch (const f3d::image::metadata_exception&)
{
throw py::key_error(key);
}
})
.def("all_metadata", &f3d::image::allMetadata)
.def("normalized_pixel", &f3d::image::getNormalizedPixel);
// f3d::options
py::class_<f3d::options> options(module, "Options");
options //
.def(py::init<>())
.def("__setitem__",
[](f3d::options& opts, const std::string& key, const f3d::option_variant_t& value)
{
try
{
opts.set(key, value);
}
catch (const f3d::options::inexistent_exception&)
{
throw py::key_error(key);
}
catch (const f3d::options::incompatible_exception&)
{
if (std::holds_alternative<std::string>(value))
{
try
{
opts.setAsString(key, std::get<std::string>(value));
}
catch (const f3d::options::parsing_exception&)
{
throw py::value_error(std::get<std::string>(value));
}
}
else
{
throw py::attribute_error(key);
}
}
})
.def("__getitem__",
[](f3d::options& opts, const std::string& key)
{
try
{
return opts.get(key);
}
catch (const f3d::options::inexistent_exception&)
{
throw py::key_error(key);
}
})
.def("__len__", [](f3d::options& opts) { return opts.getNames().size(); })
.def(
"__iter__",
[](f3d::options& opts)
{
const auto names = py::cast(opts.getNames()); // won't work without cast
return make_iterator(names);
},
py::keep_alive<0, 1>())
.def("keys", &f3d::options::getNames) // to do `dict(options)`
.def("toggle", &f3d::options::toggle)
.def("is_same", &f3d::options::isSame)
.def("get_closest_option", &f3d::options::getClosestOption)
.def("copy", &f3d::options::copy);
// f3d::utils
py::class_<f3d::utils> utils(module, "Utils");
utils //
.def_static("text_distance", &f3d::utils::textDistance)
.def_static("collapse_path", &f3d::utils::collapsePath);
// f3d::interactor
py::class_<f3d::interaction_bind_t> interaction_bind(module, "InteractionBind");
py::enum_<f3d::interaction_bind_t::ModifierKeys>(interaction_bind, "ModifierKeys")
.value("ANY", f3d::interaction_bind_t::ModifierKeys::ANY)
.value("NONE", f3d::interaction_bind_t::ModifierKeys::NONE)
.value("CTRL", f3d::interaction_bind_t::ModifierKeys::CTRL)
.value("SHIFT", f3d::interaction_bind_t::ModifierKeys::SHIFT)
.value("CTRL_SHIFT", f3d::interaction_bind_t::ModifierKeys::CTRL_SHIFT)
.export_values();
interaction_bind.def(py::init<const f3d::interaction_bind_t::ModifierKeys&, const std::string&>())
.def_readwrite("mod", &f3d::interaction_bind_t::mod)
.def_readwrite("inter", &f3d::interaction_bind_t::inter)
.def("format", &f3d::interaction_bind_t::format);
py::class_<f3d::interactor, std::unique_ptr<f3d::interactor, py::nodelete>> interactor(
module, "Interactor");
interactor //
.def("toggle_animation", &f3d::interactor::toggleAnimation, "Toggle the animation")
.def("start_animation", &f3d::interactor::startAnimation, "Start the animation")
.def("stop_animation", &f3d::interactor::stopAnimation, "Stop the animation")
.def("is_playing_animation", &f3d::interactor::isPlayingAnimation,
"Returns True if the animation is currently started")
.def("enable_camera_movement", &f3d::interactor::enableCameraMovement,
"Enable the camera interaction")
.def("disable_camera_movement", &f3d::interactor::disableCameraMovement,
"Disable the camera interaction")
.def("play_interaction", &f3d::interactor::playInteraction, "Play an interaction file")
.def("record_interaction", &f3d::interactor::recordInteraction, "Record an interaction file")
.def("start", &f3d::interactor::start, "Start the interactor and the event loop",
py::arg("delta_time") = 1.0 / 30, py::arg("user_callback") = nullptr)
.def("stop", &f3d::interactor::stop, "Stop the interactor and the event loop")
.def(
"request_render", &f3d::interactor::requestRender, "Request a render on the next event loop")
.def("init_commands", &f3d::interactor::initCommands,
"Remove all commands and add all default command callbacks")
.def("add_command", &f3d::interactor::addCommand, "Add a command")
.def("remove_command", &f3d::interactor::removeCommand, "Remove a command")
.def("get_command_actions", &f3d::interactor::getCommandActions, "Get all command actions")
.def("trigger_command", &f3d::interactor::triggerCommand, "Trigger a command")
.def("init_bindings", &f3d::interactor::initBindings,
"Remove all bindings and add default bindings")
.def("add_binding",
py::overload_cast<const f3d::interaction_bind_t&, std::string, std::string,
std::function<std::pair<std::string, std::string>()>>(&f3d::interactor::addBinding),
"Add a binding command")
.def("add_binding",
py::overload_cast<const f3d::interaction_bind_t&, std::vector<std::string>, std::string,
std::function<std::pair<std::string, std::string>()>>(&f3d::interactor::addBinding),
"Add binding commands")
.def("remove_binding", &f3d::interactor::removeBinding, "Remove interaction commands")
.def("get_bind_groups", &f3d::interactor::getBindGroups)
.def("get_binds_for_group", &f3d::interactor::getBindsForGroup)
.def("get_binds", &f3d::interactor::getBinds)
.def("get_binding_documentation", &f3d::interactor::getBindingDocumentation);
// f3d::mesh_t
py::class_<f3d::mesh_t>(module, "Mesh")
.def(py::init<>())
.def(py::init<const std::vector<float>&, const std::vector<float>&, const std::vector<float>&,
const std::vector<unsigned int>&, const std::vector<unsigned int>&>(),
py::arg("points"), py::arg("normals") = std::vector<float>(),
py::arg("texture_coordinates") = std::vector<float>(),
py::arg("face_sides") = std::vector<unsigned int>(),
py::arg("face_indices") = std::vector<unsigned int>())
.def_readwrite("points", &f3d::mesh_t::points)
.def_readwrite("normals", &f3d::mesh_t::normals)
.def_readwrite("texture_coordinates", &f3d::mesh_t::texture_coordinates)
.def_readwrite("face_sides", &f3d::mesh_t::face_sides)
.def_readwrite("face_indices", &f3d::mesh_t::face_indices);
// f3d::scene
py::class_<f3d::scene, std::unique_ptr<f3d::scene, py::nodelete>> scene(module, "Scene");
scene //
.def("supports", &f3d::scene::supports)
.def("clear", &f3d::scene::clear)
.def("add", py::overload_cast<const std::filesystem::path&>(&f3d::scene::add),
"Add a file the scene", py::arg("file_path"))
.def("add", py::overload_cast<const std::vector<std::filesystem::path>&>(&f3d::scene::add),
"Add multiple filepaths to the scene", py::arg("file_path_vector"))
.def("add", py::overload_cast<const std::vector<std::string>&>(&f3d::scene::add),
"Add multiple filenames to the scene", py::arg("file_name_vector"))
.def("add", py::overload_cast<const f3d::mesh_t&>(&f3d::scene::add),
"Add a surfacic mesh from memory into the scene", py::arg("mesh"))
.def("load_animation_time", &f3d::scene::loadAnimationTime)
.def("animation_time_range", &f3d::scene::animationTimeRange);
// f3d::camera_state_t
py::class_<f3d::camera_state_t>(module, "CameraState")
.def(py::init<>())
.def(py::init<const f3d::point3_t&, const f3d::point3_t&, const f3d::vector3_t&,
const f3d::angle_deg_t&>(),
py::arg("position"), py::arg("focal_point"), py::arg("view_up"), py::arg("view_angle"))
.def_readwrite("position", &f3d::camera_state_t::position)
.def_readwrite("focal_point", &f3d::camera_state_t::focalPoint)
.def_readwrite("view_up", &f3d::camera_state_t::viewUp)
.def_readwrite("view_angle", &f3d::camera_state_t::viewAngle);
// f3d::camera
py::class_<f3d::camera, std::unique_ptr<f3d::camera, py::nodelete>> camera(module, "Camera");
camera //
.def_property(
"position", [](f3d::camera& cam) { return cam.getPosition(); }, &f3d::camera::setPosition)
.def_property(
"focal_point", [](f3d::camera& cam) { return cam.getFocalPoint(); },
&f3d::camera::setFocalPoint)
.def_property(
"view_up", [](f3d::camera& cam) { return cam.getViewUp(); }, &f3d::camera::setViewUp)
.def_property(
"view_angle", [](f3d::camera& cam) { return cam.getViewAngle(); }, &f3d::camera::setViewAngle)
.def_property(
"state", [](f3d::camera& cam) { return cam.getState(); }, &f3d::camera::setState)
.def("dolly", &f3d::camera::dolly)
.def("pan", &f3d::camera::pan, py::arg("right"), py::arg("up"), py::arg("forward") = 0.0)
.def("zoom", &f3d::camera::zoom)
.def("roll", &f3d::camera::roll)
.def("azimuth", &f3d::camera::azimuth)
.def("yaw", &f3d::camera::yaw)
.def("elevation", &f3d::camera::elevation)
.def("pitch", &f3d::camera::pitch)
.def("set_current_as_default", &f3d::camera::setCurrentAsDefault)
.def("reset_to_default", &f3d::camera::resetToDefault)
.def("reset_to_bounds", &f3d::camera::resetToBounds, py::arg("zoom_factor") = 0.9);
// f3d::window
py::class_<f3d::window, std::unique_ptr<f3d::window, py::nodelete>> window(module, "Window");
py::enum_<f3d::window::Type>(window, "Type")
.value("NONE", f3d::window::Type::NONE)
.value("EXTERNAL", f3d::window::Type::EXTERNAL)
.value("GLX", f3d::window::Type::GLX)
.value("WGL", f3d::window::Type::WGL)
.value("COCOA", f3d::window::Type::COCOA)
.value("EGL", f3d::window::Type::EGL)
.value("OSMESA", f3d::window::Type::OSMESA)
.value("UNKNOWN", f3d::window::Type::UNKNOWN)
.export_values();
window //
.def_property_readonly("type", &f3d::window::getType)
.def_property_readonly("offscreen", &f3d::window::isOffscreen)
.def_property_readonly("camera", &f3d::window::getCamera, py::return_value_policy::reference)
.def_property(
"size",
[](const f3d::window& win) { return std::make_pair(win.getWidth(), win.getHeight()); },
[](f3d::window& win, std::pair<int, int> wh) { win.setSize(wh.first, wh.second); })
.def_property("width", &f3d::window::getWidth,
[](f3d::window& win, int w) { win.setSize(w, win.getHeight()); })
.def_property("height", &f3d::window::getHeight,
[](f3d::window& win, int h) { win.setSize(win.getWidth(), h); })
.def("render", &f3d::window::render, "Render the window")
.def("render_to_image", &f3d::window::renderToImage, "Render the window to an image",
py::arg("no_background") = false)
.def("set_position", &f3d::window::setPosition)
.def("set_icon", &f3d::window::setIcon,
"Set the icon of the window using a memory buffer representing a PNG file")
.def("set_window_name", &f3d::window::setWindowName, "Set the window name")
.def("get_world_from_display", &f3d::window::getWorldFromDisplay,
"Get world coordinate point from display coordinate")
.def("get_display_from_world", &f3d::window::getDisplayFromWorld,
"Get display coordinate point from world coordinate");
// libInformation
py::class_<f3d::engine::libInformation>(module, "LibInformation")
.def_readonly("version", &f3d::engine::libInformation::Version)
.def_readonly("version_full", &f3d::engine::libInformation::VersionFull)
.def_readonly("build_date", &f3d::engine::libInformation::BuildDate)
.def_readonly("build_system", &f3d::engine::libInformation::BuildSystem)
.def_readonly("compiler", &f3d::engine::libInformation::Compiler)
.def_readonly("modules", &f3d::engine::libInformation::Modules)
.def_readonly("vtk_version", &f3d::engine::libInformation::VTKVersion)
.def_readonly("copyrights", &f3d::engine::libInformation::Copyrights)
.def_readonly("license", &f3d::engine::libInformation::License);
// readerInformation
py::class_<f3d::engine::readerInformation>(module, "ReaderInformation")
.def_readonly("name", &f3d::engine::readerInformation::Name)
.def_readonly("description", &f3d::engine::readerInformation::Description)
.def_readonly("extensions", &f3d::engine::readerInformation::Extensions)
.def_readonly("mime_types", &f3d::engine::readerInformation::MimeTypes)
.def_readonly("plugin_name", &f3d::engine::readerInformation::PluginName)
.def_readonly("has_scene_reader", &f3d::engine::readerInformation::HasSceneReader)
.def_readonly("has_geometry_reader", &f3d::engine::readerInformation::HasGeometryReader);
// f3d::engine
py::class_<f3d::engine> engine(module, "Engine");
engine //
.def_static("create", &f3d::engine::create, "Create an engine with a automatic window",
py::arg("offscreen") = false)
.def_static("create_none", &f3d::engine::createNone, "Create an engine with no window")
.def_static(
"create_glx", &f3d::engine::createGLX, "Create an engine with an GLX window (Linux only)")
.def_static(
"create_wgl", &f3d::engine::createWGL, "Create an engine with an WGL window (Windows only)")
.def_static("create_egl", &f3d::engine::createEGL,
"Create an engine with an EGL window (Windows/Linux only)")
.def_static("create_osmesa", &f3d::engine::createOSMesa,
"Create an engine with an OSMesa window (Windows/Linux only)")
.def_static("create_external_glx", &f3d::engine::createExternalGLX,
"Create an engine with an existing GLX context (Linux only)")
.def_static("create_external_wgl", &f3d::engine::createExternalWGL,
"Create an engine with an existing WGL context (Windows only)")
.def_static("create_external_cocoa", &f3d::engine::createExternalCOCOA,
"Create an engine with an existing COCOA context (macOS only)")
.def_static("create_external_egl", &f3d::engine::createExternalEGL,
"Create an engine with an existing EGL context (Windows/Linux only)")
.def_static("create_external_osmesa", &f3d::engine::createExternalOSMesa,
"Create an engine with an existing OSMesa context (Windows/Linux only)")
.def("set_cache_path", &f3d::engine::setCachePath, "Set the cache path directory")
.def_property("options", &f3d::engine::getOptions,
py::overload_cast<const f3d::options&>(&f3d::engine::setOptions),
py::return_value_policy::reference)
.def_property_readonly("window", &f3d::engine::getWindow, py::return_value_policy::reference)
.def_property_readonly("scene", &f3d::engine::getScene, py::return_value_policy::reference)
.def_property_readonly(
"interactor", &f3d::engine::getInteractor, py::return_value_policy::reference)
.def_static("load_plugin", &f3d::engine::loadPlugin, "Load a plugin")
.def_static(
"autoload_plugins", &f3d::engine::autoloadPlugins, "Automatically load internal plugins")
.def_static("get_plugins_list", &f3d::engine::getPluginsList)
.def_static("get_lib_info", &f3d::engine::getLibInfo, py::return_value_policy::reference)
.def_static("get_readers_info", &f3d::engine::getReadersInfo)
.def_static("get_rendering_backend_list", &f3d::engine::getRenderingBackendList)
.def_static("set_reader_option",
[](const std::string& name, const std::string& value)
{
try
{
f3d::engine::setReaderOption(name, value);
}
catch (const f3d::options::inexistent_exception&)
{
throw py::key_error(name);
}
})
.def_static("get_all_reader_option_names", &f3d::engine::getAllReaderOptionNames);
// f3d::log
py::class_<f3d::log> log(module, "Log");
py::enum_<f3d::log::VerboseLevel>(log, "VerboseLevel")
.value("DEBUG", f3d::log::VerboseLevel::DEBUG)
.value("INFO", f3d::log::VerboseLevel::INFO)
.value("WARN", f3d::log::VerboseLevel::WARN)
.value("ERROR", f3d::log::VerboseLevel::ERROR)
.value("QUIET", f3d::log::VerboseLevel::QUIET)
.export_values();
log //
.def_static("set_verbose_level", &f3d::log::setVerboseLevel, py::arg("level"),
py::arg("force_std_err") = false)
.def_static("set_use_coloring", &f3d::log::setUseColoring)
.def_static("print", [](f3d::log::VerboseLevel& level, const std::string& message)
{ f3d::log::print(level, message); });
}
|