Developer Documentation

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 //=============================================================================
45 //
46 // Types
47 //
48 //=============================================================================
49
56 #ifndef PLANEOBJECT_HH
57 #define PLANEOBJECT_HH
58
59
60
61 //== INCLUDES =================================================================
62
63 #include <OpenFlipper/common/BaseObjectData.hh>
64
65 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
66
67 #include <ACG/Geometry/Types/PlaneType.hh>
68 #include "PlaneNode.hh"
69
70
71 //== TYPEDEFS =================================================================
72
73 // //== CLASS DEFINITION =========================================================
74
75 class OBJECTTYPEDLLEXPORT PlaneObject : public BaseObjectData {
76 using Plane = ACG::Geometry::Plane;
77
78 friend class TypePlanePlugin;
79
80 public:
82 PlaneObject();
83
88 PlaneObject(const PlaneObject& _object);
89
91 virtual ~PlaneObject();
92
94 virtual void cleanup();
95
99 BaseObject* copy();
100
101
102 protected:
104 virtual void init(const Plane* _plane = 0);
105
106 //===========================================================================
109 //===========================================================================
110 public:
111
113 void setName( QString _name );
114
115 //===========================================================================
118 //===========================================================================
119 public:
120 Plane& plane();
121 void plane(Plane _plane);
122
123 private:
124 Plane plane_;
125
128 //===========================================================================
135 //===========================================================================
136
137 protected:
145 void update(UpdateType _type = UPDATE_ALL );
146
149 //===========================================================================
152 //===========================================================================
153
154 public:
156 PlaneNode* planeNode();
157
158 private:
159 PlaneNode* planeNode_;
160
164 //===========================================================================
167 //===========================================================================
168 public:
170 QString getObjectinfo();
171
174 //===========================================================================
177 //===========================================================================
178 public:
180 bool picked( uint _node_idx );
181
183 void enablePicking( bool _enable );
184
186 bool pickingEnabled();
187
190 };
191
192 //=============================================================================
193 #endif // PLANEOBJECT_HH defined
194 //=============================================================================
BaseObject::getObjectinfo
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:244
BaseObjectData::picked
virtual bool picked(uint _node_idx)
detect if the node has been picked
Definition: BaseObjectData.cc:311
BaseObjectData::setName
virtual void setName(QString _name) override
path to the file from which the object is loaded ( defaults to "." )
Definition: BaseObjectData.cc:355
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
BaseObject
Definition: BaseObject.hh:82
ObjectTypeDLLDefines.hh
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:315
BaseObjectData::cleanup
virtual void cleanup() override
Definition: BaseObjectData.cc:102
BaseObjectData.hh
BaseObjectData::update
virtual void update(UpdateType _type=UPDATE_ALL) override
This function is called to update the object.
Definition: BaseObjectData.cc:329
BaseObjectData
Definition: BaseObjectData.hh:102
UpdateType
Update type class.
Definition: UpdateType.hh:60
PlaneObject::planeNode_
PlaneNode * planeNode_
Get the scenegraph Node.
Definition: PlaneObject.hh:159
TypePlanePlugin
Definition: TypePlane.hh:59
PlaneObject
Definition: PlaneObject.hh:75
ACG::Geometry::Plane
Definition: PlaneType.hh:50
BaseObject::copy
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:769
PlaneNode
Definition: PlaneNode.hh:74
BaseObjectData::pickingEnabled
virtual bool pickingEnabled()
Definition: BaseObjectData.cc:318