Developer Documentation

PluginFunctionsCoordsys.cc
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 // Plugin Functions for Coordsys
48 //
49 //=============================================================================
50
51 #include <OpenFlipper/common/Types.hh>
52 #include "Coordsys.hh"
53
54 #include <OpenFlipper/BasePlugin/PluginFunctions.hh>
55
56 namespace PluginFunctions {
57
58 // ===============================================================================
59 // Get objects
60 // ===============================================================================
61
62 bool getObject( int _identifier , CoordsysObject*& _object ) {
63
64 if ( _identifier == BaseObject::NOOBJECT ) {
65 _object = 0;
66 return false;
67 }
68
69 // Get object by using the map accelerated plugin function
70 BaseObjectData* object = 0;
71 PluginFunctions::getObject(_identifier,object);
72
73 _object = dynamic_cast< CoordsysObject* >(object);
74 return ( _object != 0 );
75 }
76
77
78 // ===============================================================================
79 // Getting data from objects and casting between them
80 // ===============================================================================
81
82 CoordsysNode* coordsysNode( BaseObjectData* _object ) {
83
84 if ( _object->dataType(DATA_COORDSYS) ) {
85 CoordsysObject* object = dynamic_cast< CoordsysObject* >(_object);
86 return object->coordsysNode();
87 } else
88 return 0;
89 }
90
91
92 CoordsysObject* coordsysObject( BaseObjectData* _object ) {
93 if ( ! _object->dataType(DATA_COORDSYS) )
94 return 0;
95 return dynamic_cast< CoordsysObject* >( _object );
96 }
97
98 CoordsysObject* coordsysObject( int _objectId ) {
99 if ( _objectId == BaseObject::NOOBJECT ) {
100 return 0;
101 }
102
103 // Get object by using the map accelerated plugin function
104 BaseObjectData* object = 0;
105 PluginFunctions::getObject(_objectId,object);
106
107 return dynamic_cast< CoordsysObject* >(object);
108 }
109
110 }
DATA_COORDSYS
#define DATA_COORDSYS
Definition: Coordsys.hh:58
ACG::SceneGraph::CoordinateSystemNode
Node for displaying coordinate systems.
Definition: CoordinateSystemNode.hh:81
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
PluginFunctions.hh
PluginFunctions::coordsysNode
CoordsysNode * coordsysNode(BaseObjectData *_object)
Get a CoordsysNode from an object.
Definition: PluginFunctionsCoordsys.cc:82
BaseObject::dataType
bool dataType(DataType _type) const
Definition: BaseObject.cc:221
BaseObject::NOOBJECT
static int NOOBJECT
Definition: BaseObject.hh:106
CoordsysObject::coordsysNode
CoordsysNode * coordsysNode()
Get the scenegraph Node.
Definition: CoordsysObject.cc:169
CoordsysObject
Definition: CoordsysObject.hh:73
PluginFunctions::coordsysObject
CoordsysObject * coordsysObject(BaseObjectData *_object)
Cast an BaseObject to a CoordsysObject if possible.
Definition: PluginFunctionsCoordsys.cc:92
BaseObjectData
Definition: BaseObjectData.hh:102
Coordsys.hh
Types.hh
PluginFunctions
Definition: PluginFunctions.cc:57