Developer Documentation
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 //=============================================================================
45 //
46 // Types
47 //
48 //=============================================================================
49 
56 #ifndef COORDSYSOBJECT_HH
57 #define COORDSYSOBJECT_HH
58 
59 
60 
61 //== INCLUDES =================================================================
62 
64 
66 
67 #include "CoordsysTypes.hh"
68 
69 //== TYPEDEFS =================================================================
70 
71 // //== CLASS DEFINITION =========================================================
72 
73 class OBJECTTYPEDLLEXPORT CoordsysObject : public BaseObjectData {
74 
75  friend class TypeCoordsysPlugin;
76 
77  public:
80 
85  CoordsysObject(const CoordsysObject& _object);
86 
88  virtual ~CoordsysObject();
89 
91  virtual void cleanup();
92 
96  BaseObject* copy();
97 
98 
99  protected:
101  virtual void init(CoordsysNode* _coordsys = 0);
102 
103  //===========================================================================
106  //===========================================================================
107  public:
108 
110  void setName( QString _name );
111 
112  //===========================================================================
115  //===========================================================================
116 
117  public:
119  CoordsysNode* coordsysNode();
120 
121  private:
123 
126  //===========================================================================
129  //===========================================================================
130  public:
132  QString getObjectinfo();
133 
137  //===========================================================================
140  //===========================================================================
141  public:
143  bool picked( uint _node_idx );
144 
146  void enablePicking( bool _enable );
147 
149  bool pickingEnabled();
150 
153  //===========================================================================
160  //===========================================================================
161 
162  protected:
163 
165  virtual void update(UpdateType _type = UPDATE_ALL);
166 
169 };
170 
171 //=============================================================================
172 #endif // COORDSYSOBJECT_HH defined
173 //=============================================================================
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:244
virtual bool picked(uint _node_idx)
detect if the node has been picked
virtual void setName(QString _name) override
path to the file from which the object is loaded ( defaults to "." )
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
Node for displaying coordinate systems.
virtual void enablePicking(bool _enable)
virtual void cleanup() override
CoordsysNode * coordsysNode_
Get the scenegraph Node.
virtual void update(UpdateType _type=UPDATE_ALL) override
This function is called to update the object.
Update type class.
Definition: UpdateType.hh:60
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:769
virtual bool pickingEnabled()