Developer Documentation

PluginFunctionsPolyMesh.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 PLUGINFUNCTIONSPOLYMESH_HH
60 #define PLUGINFUNCTIONSPOLYMESH_HH
61
62 #include <OpenFlipper/common/Types.hh>
63 #include <ObjectTypes/PolyMesh/PolyMesh.hh>
64 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
65
68 namespace PluginFunctions {
69
70
71 //=======================================
72 // Get Source/Target objects
75 //=======================================
76
82 OBJECTTYPEDLLEXPORT
83 bool getSourceMeshes( std::vector<PolyMesh*>& _meshes );
84
90 OBJECTTYPEDLLEXPORT
91 bool getTargetMeshes( std::vector<PolyMesh*>& _meshes );
92
95 //=======================================
96 // Get Objects by their identifier
99 //=======================================
100
104 OBJECTTYPEDLLEXPORT
105 bool getObject( int _identifier , PolyMeshObject*& _object );
106
117 OBJECTTYPEDLLEXPORT
118 bool getMesh( int _identifier , PolyMesh*& _mesh );
119
122 //=======================================
125 //=======================================
126
127
133 OBJECTTYPEDLLEXPORT
134 PolyMesh* polyMesh( BaseObjectData* _object );
135
141 OBJECTTYPEDLLEXPORT
142 PolyMesh* polyMesh( int _identifier );
143
149 OBJECTTYPEDLLEXPORT
150 PolyMeshObject* polyMeshObject( BaseObjectData* _object );
151
157 OBJECTTYPEDLLEXPORT
158 PolyMeshObject* polyMeshObject( int _objectId );
159
162 }
163
164 #endif //PLUGINFUNCTIONSPOLYMESH_HH
PluginFunctions::polyMesh
PolyMesh * polyMesh(BaseObjectData *_object)
Get a poly mesh from an object.
Definition: PluginFunctionsPolyMesh.cc:128
PolyMeshObject
Type for a Meshobject containing a poly mesh.
Definition: PolyMesh.hh:65
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
ObjectTypeDLLDefines.hh
PluginFunctions::polyMeshObject
PolyMeshObject * polyMeshObject(BaseObjectData *_object)
Cast an BaseObject to a PolyMeshObject if possible.
Definition: PluginFunctionsPolyMesh.cc:149
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
BaseObjectData
Definition: BaseObjectData.hh:102
PolyMesh.hh
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