Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
CoordsysObject.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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49
50 //=============================================================================
51 //
52 // Types
53 //
54 //=============================================================================
55
62 #ifndef COORDSYSOBJECT_HH
63 #define COORDSYSOBJECT_HH
64
65
66
67 //== INCLUDES =================================================================
68
69 #include <OpenFlipper/common/BaseObjectData.hh>
70
71 #include <OpenFlipper/common/GlobalDefines.hh>
72
73 #include "CoordsysTypes.hh"
74
75 //== TYPEDEFS =================================================================
76
77 // //== CLASS DEFINITION =========================================================
78
79 class DLLEXPORT CoordsysObject : public BaseObjectData {
80
81 friend class TypeCoordsysPlugin;
82
83 public:
85 CoordsysObject();
86
91 CoordsysObject(const CoordsysObject& _object);
92
94 virtual ~CoordsysObject();
95
97 virtual void cleanup();
98
102 BaseObject* copy();
103
104
105 protected:
107 virtual void init(CoordsysNode* _coordsys = 0);
108
109 //===========================================================================
112 //===========================================================================
113 public:
114
116 void setName( QString _name );
117
118 //===========================================================================
121 //===========================================================================
122
123 public:
125 CoordsysNode* coordsysNode();
126
127 private:
128 CoordsysNode* coordsysNode_;
129
132 //===========================================================================
135 //===========================================================================
136 public:
138 QString getObjectinfo();
139
143 //===========================================================================
146 //===========================================================================
147 public:
149 bool picked( uint _node_idx );
150
152 void enablePicking( bool _enable );
153
155 bool pickingEnabled();
156
159 //===========================================================================
166 //===========================================================================
167
168 protected:
169
171 virtual void update(UpdateType _type = UPDATE_ALL);
172
175 };
176
177 //=============================================================================
178 #endif // COORDSYSOBJECT_HH defined
179 //=============================================================================
TypeCoordsysPlugin
Definition: TypeCoordsys.hh:64
CoordsysObject::coordsysNode_
CoordsysNode * coordsysNode_
Get the scenegraph Node.
Definition: CoordsysObject.hh:128
BaseObject::getObjectinfo
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:255
BaseObjectData
Definition: BaseObjectData.hh:105
UpdateType
Update type class.
Definition: UpdateType.hh:70
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
GlobalDefines.hh
BaseObjectData::setName
virtual void setName(QString _name)
path to the file from which the object is loaded ( defaults to "." )
Definition: BaseObjectData.cc:357
BaseObjectData::pickingEnabled
virtual bool pickingEnabled()
Definition: BaseObjectData.cc:320
BaseObjectData::cleanup
virtual void cleanup()
Definition: BaseObjectData.cc:108
ACG::SceneGraph::CoordinateSystemNode
Node for displaying coordinate systems.
Definition: CoordinateSystemNode.hh:87
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:317
BaseObject
Definition: BaseObject.hh:94
CoordsysTypes.hh
BaseObjectData::update
virtual void update(UpdateType _type=UPDATE_ALL)
This function is called to update the object.
Definition: BaseObjectData.cc:331
DLLEXPORT
#define DLLEXPORT
Definition: GlobalDefines.hh:107
BaseObject::copy
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:780
CoordsysObject
Definition: CoordsysObject.hh:79
BaseObjectData.hh
BaseObjectData::picked
virtual bool picked(uint _node_idx)
detect if the node has been picked
Definition: BaseObjectData.cc:313