Developer Documentation

PluginFunctionsTriangleMesh.hh
Go to the documentation of this file.
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43
44
45
46
47 //=============================================================================
48 //
49 // Standard Functions
50 //
51 //=============================================================================
52
58 //
59 #ifndef PLUGINFUNCTIONSTRIANGLEMESH_HH
60 #define PLUGINFUNCTIONSTRIANGLEMESH_HH
61
62 #include <OpenFlipper/common/Types.hh>
63 #include <ObjectTypes/TriangleMesh/TriangleMesh.hh>
64
67 namespace PluginFunctions {
68
69 //=======================================
70 // Get Source/Target objects
73 //=======================================
74
80 OBJECTTYPEDLLEXPORT
81 bool getSourceMeshes( std::vector<TriMesh*>& _meshes );
82
88 OBJECTTYPEDLLEXPORT
89 bool getTargetMeshes( std::vector<TriMesh*>& _meshes );
90
93 //=======================================
94 // Get Objects by their identifier
97 //=======================================
98
102 OBJECTTYPEDLLEXPORT
103 bool getObject( int _identifier , TriMeshObject*& _object );
104
105
116 OBJECTTYPEDLLEXPORT
117 bool getMesh( int _identifier , TriMesh*& _mesh );
118
121 //=======================================
124 //=======================================
125
131 OBJECTTYPEDLLEXPORT
132 TriMesh* triMesh( BaseObjectData* _object );
133
139 OBJECTTYPEDLLEXPORT
140 TriMesh* triMesh( int _identifier );
141
147 OBJECTTYPEDLLEXPORT
148 TriMeshObject* triMeshObject( BaseObjectData* _object );
149
155 OBJECTTYPEDLLEXPORT
156 TriMeshObject* triMeshObject( int _objectId );
157
159 }
160
161 #endif //PLUGINFUNCTIONSTRIANGLEMESH_HH
PluginFunctions::getSourceMeshes
bool getSourceMeshes(std::vector< PolyMesh *> &_meshes)
Get a pointer to every Poly Mesh which is marked as a source mesh.
Definition: PluginFunctionsPolyMesh.cc:61
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
PluginFunctions::triMesh
TriMesh * triMesh(BaseObjectData *_object)
Get a triangle mesh from an object.
Definition: PluginFunctionsTriangleMesh.cc:134
TriangleMesh.hh
PluginFunctions::getTargetMeshes
bool getTargetMeshes(std::vector< PolyMesh *> &_meshes)
Get a pointer to every Poly Mesh which is marked as a target mesh.
Definition: PluginFunctionsPolyMesh.cc:73
PluginFunctions::triMeshObject
TriMeshObject * triMeshObject(BaseObjectData *_object)
Cast an BaseObject to a TriMeshObject if possible.
Definition: PluginFunctionsTriangleMesh.cc:156
TriMeshObject
Type for a MeshObject containing a triangle mesh.
Definition: TriangleMesh.hh:67
BaseObjectData
Definition: BaseObjectData.hh:102
PluginFunctions::getMesh
bool getMesh(int _identifier, PolyMesh *&_mesh)
Get the Poly Mesh which has the given identifier.
Definition: PluginFunctionsPolyMesh.cc:101
Types.hh
PluginFunctions
Definition: PluginFunctions.cc:57