/* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include #include #include #include #include #include #include #include #include "Magnum/SceneGraph/Python.h" #include "magnum/bootstrap.h" namespace magnum { namespace { template struct PyDrawable: SceneGraph::PyFeature> { explicit PyDrawable(SceneGraph::AbstractObject& object, SceneGraph::DrawableGroup* drawables): SceneGraph::PyFeature>{object, drawables} {} void draw(const MatrixTypeFor& transformationMatrix, SceneGraph::Camera& camera) override { PYBIND11_OVERLOAD_PURE_NAME( void, PyDrawable, "draw", draw, transformationMatrix, camera ); } }; template void scene(py::class_>& c) { c.def(py::init(), "Constructor"); } template void abstractObject(py::class_, SceneGraph::PyObjectHolder>>& c) { c /* Matrix transformation APIs */ .def("transformation_matrix", &SceneGraph::AbstractObject::transformationMatrix, "Transformation matrix") .def("absolute_transformation_matrix", &SceneGraph::AbstractObject::absoluteTransformationMatrix, "Transformation matrix relative to the root object"); } template void object(py::class_, SceneGraph::PyObject>, SceneGraph::AbstractObject, SceneGraph::PyObjectHolder>>& c) { c .def(py::init_alias>*>(), "Constructor", py::arg("parent") = nullptr) .def(py::init_alias*>(), "Constructor", py::arg("parent") = nullptr) /* Properties */ .def_property_readonly("scene", [](SceneGraph::PyObject>& self) { return static_cast*>(self.scene()); }, "Scene or None if the object is not a part of any scene") .def_property("parent", [](SceneGraph::PyObject>& self) { return static_cast>*>(self.parent()); }, [](SceneGraph::PyObject>& self, py::object parentobj) { SceneGraph::Object* parent; if(py::isinstance>>(parentobj)) parent = py::cast>*>(parentobj); else if(py::isinstance>(parentobj)) parent = py::cast*>(parentobj); else if(py::isinstance(parentobj)) parent = nullptr; else throw py::type_error{Utility::formatString("expected Scene, Object or None, got {}", std::string(py::str{parentobj.get_type()}))}; /* Decrease refcount if a parent is removed, increase it if a parent gets added */ if(self.parent() && !parent) py::cast(&self).dec_ref(); else if(!self.parent() && parent) py::cast(&self).inc_ref(); self.setParent(parent); }, "Parent object or None if this is the root object") /* Transformation APIs common to all implementations */ .def_property("transformation", &SceneGraph::PyObject>::transformation, &SceneGraph::PyObject>::setTransformation, "Object transformation") .def("absolute_transformation", &SceneGraph::PyObject>::absoluteTransformation, "Transformation relative to the root object") .def("reset_transformation", [](SceneGraph::PyObject>& self) { self.resetTransformation(); }, "Reset the transformation") .def("transform", [](SceneGraph::PyObject>& self, const typename Transformation::DataType& transformation) { self.transform(transformation); }, "Transform the object") .def("transform_local", [](SceneGraph::PyObject>& self, const typename Transformation::DataType& transformation) { self.transformLocal(transformation); }, "Transform the object as a local transformation") .def("translate", [](SceneGraph::PyObject>& self, const VectorTypeFor& vector) { self.translate(vector); }, "Translate the object") .def("translate_local", [](SceneGraph::PyObject>& self, const VectorTypeFor& vector) { self.translateLocal(vector); }, "Translate the object as a local transformation"); } template void object2D(py::class_, SceneGraph::PyObject>, SceneGraph::AbstractObject, SceneGraph::PyObjectHolder>>& c) { c .def("rotate", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotate(static_cast>(angle)); }, "Rotate the object") .def("rotate_local", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateLocal(static_cast>(angle)); }, "Rotate the object as a local transformation"); } template void object3D(py::class_, SceneGraph::PyObject>, SceneGraph::AbstractObject, SceneGraph::PyObjectHolder>>& c) { c .def("rotate", [](SceneGraph::PyObject>& self, const Radd angle, const Math::Vector3& normalizedAxis) { self.rotate(static_cast>(angle), normalizedAxis); }, "Rotate the object as a local transformation", py::arg("angle"), py::arg("normalized_axis")) .def("rotate_local", [](SceneGraph::PyObject>& self, const Radd angle, const Math::Vector3& normalizedAxis) { self.rotateLocal(static_cast>(angle), normalizedAxis); }, "Rotate the object as a local transformation", py::arg("angle"), py::arg("normalized_axis")) .def("rotate_x", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateX(static_cast>(angle)); }, "Rotate the object around X axis") .def("rotate_x_local", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateXLocal(static_cast>(angle)); }, "Rotate the object around X axis as a local transformation") .def("rotate_y", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateY(static_cast>(angle)); }, "Rotate the object around Y axis") .def("rotate_y_local", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateYLocal(static_cast>(angle)); }, "Rotate the object around Y axis as a local transformation") .def("rotate_z", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateZ(static_cast>(angle)); }, "Rotate the object around Z axis") .def("rotate_z_local", [](SceneGraph::PyObject>& self, const Radd angle) { self.rotateZLocal(static_cast>(angle)); }, "Rotate the object around Z axis as a local transformation"); } template void objectScale(py::class_, SceneGraph::PyObject>, SceneGraph::AbstractObject, SceneGraph::PyObjectHolder>>& c) { c .def("scale", [](SceneGraph::PyObject>& self, const VectorTypeFor& vector) { self.scale(vector); }, "Scale the object") .def("scale_local", [](SceneGraph::PyObject>& self, const VectorTypeFor& vector) { self.scaleLocal(vector); }, "Scale the object as a local transformation") .def("reflect", [](SceneGraph::PyObject>& self, const VectorTypeFor& vector) { self.reflect(vector); }, "Reflect the object") .def("reflect_local", [](SceneGraph::PyObject>& self, const VectorTypeFor& vector) { self.reflectLocal(vector); }, "Reflect the object as a local transformation"); } template void featureGroup(py::class_>& c) { c .def(py::init(), "Constructor") .def("__len__", &SceneGraph::FeatureGroup::size, "Count of features in the group") /* Get item. Fetching the already registered instance and returning that instead of wrapping the pointer again. Need to throw IndexError in order to allow iteration: https://docs.python.org/3/reference/datamodel.html#object.__getitem__ */ .def("__getitem__", [](SceneGraph::FeatureGroup& self, std::size_t index) -> PyFeature& { if(index >= self.size()) throw pybind11::index_error{}; return static_cast(self[index]); }, "Feature at given index") .def("add", [](SceneGraph::FeatureGroup& self, PyFeature& feature) { self.add(feature); }, "Add a feature to the group") .def("remove", [](SceneGraph::FeatureGroup& self, PyFeature& feature) { self.add(feature); }, "Remove a feature from the group"); } template void feature(py::class_, SceneGraph::PyFeatureHolder>>& c) { c .def_property_readonly("object", [](SceneGraph::AbstractFeature& self) -> SceneGraph::AbstractObject& { return self.object(); }, "Object holding this feature"); } template void drawable(py::class_, SceneGraph::AbstractFeature, PyDrawable, SceneGraph::PyFeatureHolder>>& c) { c .def(py::init_alias&, SceneGraph::DrawableGroup*>(), "Constructor", py::arg("object"), py::arg("drawables") = nullptr) .def_property_readonly("drawables", [](PyDrawable& self) { return self.drawables(); }, "Group containing this drawable") .def("draw", [](PyDrawable& self, const MatrixTypeFor& transformationMatrix, SceneGraph::Camera& camera) { self.draw(transformationMatrix, camera); }, "Draw the object using given camera", py::arg("transformation_matrix"), py::arg("camera")); } template void camera(py::class_, SceneGraph::AbstractFeature, SceneGraph::PyFeature>, SceneGraph::PyFeatureHolder>>& c) { c .def(py::init_alias&>(), "Constructor", py::arg("object")) .def_property("aspect_ratio_policy", &SceneGraph::Camera::aspectRatioPolicy, /* Using a lambda because the setter has method chaining */ [](SceneGraph::Camera& self, SceneGraph::AspectRatioPolicy policy) { self.setAspectRatioPolicy(policy); }, "Aspect ratio policy") .def_property_readonly("camera_matrix", &SceneGraph::Camera::cameraMatrix, "Camera matrix") .def_property("projection_matrix", &SceneGraph::Camera::projectionMatrix, /* Using a lambda because the setter has method chaining */ [](SceneGraph::Camera& self, const MatrixTypeFor& matrix) { self.setProjectionMatrix(matrix); }, "Projection matrix") .def("projection_size", &SceneGraph::Camera::projectionSize, "Size of (near) XY plane in current projection") .def_property("viewport", &SceneGraph::Camera::viewport, &SceneGraph::Camera::setViewport, "Viewport size") .def("draw", static_cast::*)(SceneGraph::DrawableGroup&)>(&SceneGraph::Camera::draw), "Draw"); } void scenegraph(py::module& m) { /* Abstract objects. Returned from feature.object, so need to be registered as well. */ { py::class_> abstractObject2D{m, "AbstractObject2D", "Base object for two-dimensional scenes"}; py::class_> abstractObject3D{m, "AbstractObject3D", "Base object for three-dimensional scenes"}; abstractObject(abstractObject2D); abstractObject(abstractObject3D); } /* 2D/3D matrix-based implementation */ { py::module matrix = m.def_submodule("matrix"); matrix.doc() = "General matrix-based scene graph implementation"; py::class_> scene2D_{matrix, "Scene2D", "Two-dimensional scene with matrix-based transformation implementation"}; scene(scene2D_); py::class_> scene3D_{matrix, "Scene3D", "Three-dimensional scene with matrix-based transformation implementation"}; scene(scene3D_); py::class_, SceneGraph::PyObject>, SceneGraph::AbstractObject2D, SceneGraph::PyObjectHolder>> object2D_{matrix, "Object2D", "Two-dimensional object with matrix-based transformation implementation"}; object(object2D_); object2D(object2D_); objectScale(object2D_); py::class_, SceneGraph::PyObject>, SceneGraph::AbstractObject3D, SceneGraph::PyObjectHolder>> object3D_{matrix, "Object3D", "Three-dimensional object with matrix-based transformation implementation"}; object(object3D_); object3D(object3D_); objectScale(object3D_); } /* Drawables, camera */ { py::enum_{m, "AspectRatioPolicy", "Camera aspect ratio policy"} .value("NOT_PRESERVED", SceneGraph::AspectRatioPolicy::NotPreserved) .value("EXTEND", SceneGraph::AspectRatioPolicy::Extend) .value("CLIP", SceneGraph::AspectRatioPolicy::Clip); py::class_ drawableGroup2D{m, "DrawableGroup2D", "Group of drawables for two-dimensional float scenes"}; py::class_ drawableGroup3D{m, "DrawableGroup3D", "Group of drawables for three-dimensional float scenes"}; py::class_> feature2D{m, "AbstractFeature2D", "Base for two-dimensional float features"}; py::class_> feature3D{m, "AbstractFeature3D", "Base for three-dimensional float features"}; feature(feature2D); feature(feature3D); py::class_, SceneGraph::PyFeatureHolder> drawable2D{m, "Drawable2D", "Drawable for two-dimensional float scenes"}; py::class_, SceneGraph::PyFeatureHolder> drawable3D{m, "Drawable3D", "Drawable for three-dimensional float scenes"}; py::class_, SceneGraph::PyFeatureHolder> camera2D{m, "Camera2D", "Camera for two-dimensional float scenes"}; py::class_, SceneGraph::PyFeatureHolder> camera3D{m, "Camera3D", "Camera for three-dimensional float scenes"}; featureGroup>(drawableGroup2D); featureGroup>(drawableGroup3D); drawable(drawable2D); drawable(drawable3D); camera(camera2D); camera(camera3D); } } }} PYBIND11_MODULE(scenegraph, m) { m.doc() = "Scene graph library"; magnum::scenegraph(m); }