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
65
68namespace PluginFunctions {
69
70
71//=======================================
72// Get Source/Target objects
75//=======================================
76
82OBJECTTYPEDLLEXPORT
83bool getSourceMeshes( std::vector<PolyMesh*>& _meshes );
84
90OBJECTTYPEDLLEXPORT
91bool getTargetMeshes( std::vector<PolyMesh*>& _meshes );
92
95//=======================================
96// Get Objects by their identifier
99//=======================================
100
104OBJECTTYPEDLLEXPORT
105bool getObject( int _identifier , PolyMeshObject*& _object );
106
117OBJECTTYPEDLLEXPORT
118bool getMesh( int _identifier , PolyMesh*& _mesh );
119
122//=======================================
125//=======================================
126
127
133OBJECTTYPEDLLEXPORT
134PolyMesh* polyMesh( BaseObjectData* _object );
135
141OBJECTTYPEDLLEXPORT
142PolyMesh* polyMesh( int _identifier );
143
149OBJECTTYPEDLLEXPORT
151
157OBJECTTYPEDLLEXPORT
158PolyMeshObject* polyMeshObject( int _objectId );
159
162}
163
164#endif //PLUGINFUNCTIONSPOLYMESH_HH
Type for a Meshobject containing a poly mesh.
Definition: PolyMesh.hh:65
bool getMesh(int _identifier, PolyMesh *&_mesh)
Get the Poly Mesh which has the given identifier.
bool getTargetMeshes(std::vector< PolyMesh * > &_meshes)
Get a pointer to every Poly Mesh which is marked as a target mesh.
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
PolyMeshObject * polyMeshObject(BaseObjectData *_object)
Cast an BaseObject to a PolyMeshObject if possible.
PolyMesh * polyMesh(BaseObjectData *_object)
Get a poly mesh from an object.
bool getSourceMeshes(std::vector< PolyMesh * > &_meshes)
Get a pointer to every Poly Mesh which is marked as a source mesh.