Developer Documentation
Python.cc
1 
2 /*===========================================================================*\
3 * *
4 * OpenFlipper *
5  * Copyright (c) 2001-2015, RWTH-Aachen University *
6  * Department of Computer Graphics and Multimedia *
7  * All rights reserved. *
8  * www.openflipper.org *
9  * *
10  *---------------------------------------------------------------------------*
11  * This file is part of OpenFlipper. *
12  *---------------------------------------------------------------------------*
13  * *
14  * Redistribution and use in source and binary forms, with or without *
15  * modification, are permitted provided that the following conditions *
16  * are met: *
17  * *
18  * 1. Redistributions of source code must retain the above copyright notice, *
19  * this list of conditions and the following disclaimer. *
20  * *
21  * 2. Redistributions in binary form must reproduce the above copyright *
22  * notice, this list of conditions and the following disclaimer in the *
23  * documentation and/or other materials provided with the distribution. *
24  * *
25  * 3. Neither the name of the copyright holder nor the names of its *
26  * contributors may be used to endorse or promote products derived from *
27  * this software without specific prior written permission. *
28  * *
29  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
30  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
32  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
33  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
34  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
35  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
36  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
37  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
38  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
40 * *
41 \*===========================================================================*/
42 
43 #include <pybind11/include/pybind11/pybind11.h>
44 #include <pybind11/include/pybind11/embed.h>
45 
46 
47 #include <PrimitivesGenerator.hh>
48 #include <QString>
49 #include <QChar>
50 
51 #include <OpenFlipper/BasePlugin/PythonFunctions.hh>
52 #include <OpenFlipper/PythonInterpreter/PythonTypeConversions.hh>
53 
54 namespace py = pybind11;
55 
56 
57 
58 PYBIND11_EMBEDDED_MODULE(PrimitivesGenerator, m) {
59 
60  QObject* pluginPointer = getPluginPointer("PrimitivesGenerator");
61 
62  if (!pluginPointer) {
63  std::cerr << "Error Getting plugin pointer for Plugin-PrimitivesGenerator" << std::endl;
64  return;
65  }
66 
67  PrimitivesGeneratorPlugin* plugin = qobject_cast<PrimitivesGeneratorPlugin*>(pluginPointer);
68 
69  if (!plugin) {
70  std::cerr << "Error converting plugin pointer for Plugin-PrimitivesGenerator" << std::endl;
71  return;
72  }
73 
74  // Export our core. Make sure that the c++ worlds core object is not deleted if
75  // the python side gets deleted!!
76  py::class_< PrimitivesGeneratorPlugin,std::unique_ptr<PrimitivesGeneratorPlugin, py::nodelete> > generator(m, "PrimitivesGenerator");
77 
78  // On the c++ side we will just return the existing core instance
79  // and prevent the system to recreate a new core as we need
80  // to work on the existing one.
81  generator.def(py::init([plugin]() { return plugin; }));
82 
83 
84  generator.def("addTriangulatedCylinder", &PrimitivesGeneratorPlugin::addTriangulatedCylinder,
85  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a triangulated cylinder (ObjectId is returned)").toLatin1().data(),
86  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Position (Bottom center vertex position)").toLatin1().data()) = Vector(0.0,0.0,0.0),
87  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center axis of cylinder").toLatin1().data()) = Vector(0.0,0.0,1.0),
88  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Radius").toLatin1().data()),
89  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Height").toLatin1().data()),
90  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Add Top vertex?").toLatin1().data()) = true,
91  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Add bottom vertex?").toLatin1().data()) = true );
92 
93  generator.def("addSphere", &PrimitivesGeneratorPlugin::addSphere,
94  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a triangulated sphere with all vertical lines connected to the poles (ObjectId is returned)").toLatin1().data(),
95  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Position (Sphere center)").toLatin1().data()) = Vector(0.0,0.0,0.0),
96  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Radius").toLatin1().data()) = 1.0);
97 
98  generator.def("addSubdivisionSphere", &PrimitivesGeneratorPlugin::addSubdivisionSphere,
99  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a triangulated sphere by subdivision without poles. (ObjectId is returned)").toLatin1().data(),
100  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Position (Sphere center)").toLatin1().data()) = Vector(0.0,0.0,0.0),
101  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Radius").toLatin1().data()) = 1.0);
102 
103  generator.def("addTetrahedron", &PrimitivesGeneratorPlugin::addTetrahedron,
104  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a tetrahedron (ObjectId is returned)").toLatin1().data(),
105  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
106  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 1.0);
107 
108  generator.def("addPyramid", &PrimitivesGeneratorPlugin::addPyramid,
109  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a pyramid (ObjectId is returned)").toLatin1().data(),
110  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
111  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
112 
113  generator.def("addCube", &PrimitivesGeneratorPlugin::addCube,
114  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a poly mesh of cube (ObjectId is returned)").toLatin1().data(),
115  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
116  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
117 
118  generator.def("addTriangulatedCube", &PrimitivesGeneratorPlugin::addTriangulatedCube,
119  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a triangular mesh of cube (ObjectId is returned)").toLatin1().data(),
120  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
121  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
122 
123  generator.def("addIcosahedron", &PrimitivesGeneratorPlugin::addIcosahedron,
124  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates an Icosahedron (ObjectId is returned)").toLatin1().data(),
125  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
126  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
127 
128  generator.def("addOctahedron", &PrimitivesGeneratorPlugin::addOctahedron,
129  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates an Octahedron (ObjectId is returned)").toLatin1().data(),
130  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
131  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
132 
133  generator.def("addDodecahedron", &PrimitivesGeneratorPlugin::addDodecahedron,
134  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a Dodecahedron (ObjectId is returned)").toLatin1().data(),
135  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center position").toLatin1().data()) = Vector(0.0,0.0,0.0),
136  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
137 
138 #ifdef ENABLE_BSPLINECURVE_SUPPORT
139  generator.def("addRandomBSplineCurve", &PrimitivesGeneratorPlugin::addRandomBSplineCurve,
140  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a random B-spline curve (ObjectId is returned)").toLatin1().data(),
141  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Position").toLatin1().data()) = Vector(0.0,0.0,0.0),
142  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Number of control points").toLatin1().data()) = 5);
143 #endif
144 
145 
146 #ifdef ENABLE_BSPLINESURFACE_SUPPORT
147  generator.def("addRandomBSplineSurface", &PrimitivesGeneratorPlugin::addRandomBSplineSurface,
148  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a random B-spline surface (ObjectId is returned)").toLatin1().data(),
149  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Position").toLatin1().data()) = Vector(0.0,0.0,0.0),
150  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Number of control points").toLatin1().data()) = 5);
151 #endif
152 
153 #ifdef ENABLE_POLYHEDRALMESH_SUPPORT
154  generator.def("addTetrahedralCube", &PrimitivesGeneratorPlugin::addTetrahedralCube,
155  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a tetrahedral mesh of a cube (ObjectId is returned)").toLatin1().data(),
156  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center Position").toLatin1().data()) = Vector(0.0,0.0,0.0),
157  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
158 
159  generator.def("addTetrahedralCuboid", &PrimitivesGeneratorPlugin::addTetrahedralCuboid,
160  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a tetrahedral mesh of a cuboid (ObjectId is returned)").toLatin1().data(),
161  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center Position").toLatin1().data()) = Vector(0.0,0.0,0.0),
162  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each side").toLatin1().data()) = Vector(4.0,6.0,12.0),
163  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Number of units in x-axis").toLatin1().data()) = 5,
164  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Number of units in y-axis").toLatin1().data()) = 5,
165  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Number of units in z-axis").toLatin1().data()) = 10);
166 
167 #endif
168 
169 #ifdef ENABLE_HEXAHEDRALMESH_SUPPORT
170  generator.def("addHexahedralCube", &PrimitivesGeneratorPlugin::addHexahedralCube,
171  QCoreApplication::translate("PythonDocPrimitivesGenerator","Generates a hexahedral mesh of a cube (ObjectId is returned)").toLatin1().data(),
172  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Center Position").toLatin1().data()) = Vector(0.0,0.0,0.0),
173  py::arg(QCoreApplication::translate("PythonDocPrimitivesGenerator","Length of each edge").toLatin1().data()) = 2.0);
174 
175 #endif
176 
177 }
ACG::Vec3d Vector
Standard Type for 3d Vector used for scripting.
Definition: DataTypes.hh:174