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
PlaneObject.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 PLANEOBJECT_HH
63 #define PLANEOBJECT_HH
64
65
66
67 //== INCLUDES =================================================================
68
69 #include <OpenFlipper/common/BaseObjectData.hh>
70
71 #include <OpenFlipper/common/GlobalDefines.hh>
72
73 #include "PlaneTypes.hh"
74
75 //== TYPEDEFS =================================================================
76
77 // //== CLASS DEFINITION =========================================================
78
79 class DLLEXPORT PlaneObject : public BaseObjectData {
80
81 friend class TypePlanePlugin;
82
83 public:
85 PlaneObject();
86
91 PlaneObject(const PlaneObject& _object);
92
94 virtual ~PlaneObject();
95
97 virtual void cleanup();
98
102 BaseObject* copy();
103
104
105 protected:
107 virtual void init(const Plane* _plane = 0);
108
109 //===========================================================================
112 //===========================================================================
113 public:
114
116 void setName( QString _name );
117
118 //===========================================================================
121 //===========================================================================
122 public:
123 Plane& plane();
124 void plane(Plane _plane);
125
126 private:
127 Plane plane_;
128
131 //===========================================================================
138 //===========================================================================
139
140 protected:
148 void update(UpdateType _type = UPDATE_ALL );
149
152 //===========================================================================
155 //===========================================================================
156
157 public:
159 PlaneNode* planeNode();
160
161 private:
162 PlaneNode* planeNode_;
163
167 //===========================================================================
170 //===========================================================================
171 public:
173 QString getObjectinfo();
174
177 //===========================================================================
180 //===========================================================================
181 public:
183 bool picked( uint _node_idx );
184
186 void enablePicking( bool _enable );
187
189 bool pickingEnabled();
190
193 };
194
195 //=============================================================================
196 #endif // PLANEOBJECT_HH defined
197 //=============================================================================
PlaneObject::planeNode_
PlaneNode * planeNode_
Get the scenegraph Node.
Definition: PlaneObject.hh:162
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
PlaneNode
Definition: PlaneNode.hh:74
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
TypePlanePlugin
Definition: TypePlane.hh:65
Plane
Definition: PlaneType.hh:77
PlaneTypes.hh
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:317
BaseObject
Definition: BaseObject.hh:94
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
PlaneObject
Definition: PlaneObject.hh:79
BaseObjectData.hh
BaseObjectData::picked
virtual bool picked(uint _node_idx)
detect if the node has been picked
Definition: BaseObjectData.cc:313