Developer Documentation

PolyLineObject.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 POLYLINEOBJECT_HH
57 #define POLYLINEOBJECT_HH
58
59
60
61 //== INCLUDES =================================================================
62
63 #include "PolyLineTypes.hh"
64 #include <OpenFlipper/common/BaseObjectData.hh>
65
66 #include <ObjectTypes/PolyLine/PolyLineNodeT.hh>
67
68 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
69
70 //== TYPEDEFS =================================================================
71
72 //== CLASS DEFINITION =========================================================
73
76 class OBJECTTYPEDLLEXPORT PolyLineObject : public BaseObjectData {
77
78 friend class TypePolyLinePlugin;
79
80 public:
81
82 typedef PolyLine PolyLineType;
83
85 PolyLineObject();
86
91 PolyLineObject(const PolyLineObject& _object);
92
94 virtual ~PolyLineObject();
95
97 virtual void cleanup();
98
102 BaseObject* copy();
103
104 protected:
105
107 virtual void init(PolyLine* _line = 0);
108
109 //===========================================================================
112 //===========================================================================
113 public:
114
116 void setName( QString _name );
117
118
119 //===========================================================================
122 //===========================================================================
123
124 public:
125
127 PolyLine* line();
128
129 private:
131 PolyLine* line_;
132
135 //===========================================================================
142 //===========================================================================
143
144 protected:
153 virtual void update(UpdateType _type = UPDATE_ALL );
154
157 //===========================================================================
160 //===========================================================================
161
162 public :
163
165 ACG::SceneGraph::PolyLineNodeT< PolyLine >* lineNode();
166
167 private :
168
170 ACG::SceneGraph::PolyLineNodeT< PolyLine >* lineNode_;
171
174 //===========================================================================
177 //===========================================================================
178 public:
180 QString getObjectinfo();
181
185 //===========================================================================
188 //===========================================================================
189 public:
191 bool picked( uint _node_idx );
192
194 void enablePicking( bool _enable );
195
197 bool pickingEnabled();
198
199
201 ACG::Vec3d refinePick(ACG::SceneGraph::PickTarget _pickTarget,
202 const ACG::Vec3d _hitPoint,
203 const ACG::Vec3d _start ,
204 const ACG::Vec3d _dir,
205 const unsigned int _targetIdx );
206
209 };
210
211 //=============================================================================
212 #endif // POLYLINEOBJECT_HH defined
213 //=============================================================================
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.
PolyLineObject::line_
PolyLine * line_
Pointer to the polyline.
Definition: PolyLineObject.hh:131
BaseObject
Definition: BaseObject.hh:82
PolyLineObject::lineNode_
ACG::SceneGraph::PolyLineNodeT< PolyLine > * lineNode_
Scenegraph Mesh Node.
Definition: PolyLineObject.hh:170
ObjectTypeDLLDefines.hh
OpenMesh::VectorT
Definition: Vector11T.hh:83
PolyLineTypes.hh
BaseObjectData::refinePick
virtual ACG::Vec3d refinePick(ACG::SceneGraph::PickTarget _pickTarget, const ACG::Vec3d _hitPoint, const ACG::Vec3d _start, const ACG::Vec3d _dir, const unsigned int _targetIdx)
Refine picking.
Definition: BaseObjectData.cc:322
PolyLineObject
Definition: PolyLineObject.hh:76
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:315
ACG::SceneGraph::PickTarget
PickTarget
What target to use for picking.
Definition: PickTarget.hh:73
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
ACG::SceneGraph::PolyLineNodeT
Definition: PolyLineNodeT.hh:89
ACG::PolyLineT
Definition: PolyLineT.hh:84
TypePolyLinePlugin
Definition: TypePolyLine.hh:62
BaseObject::copy
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:769
BaseObjectData::pickingEnabled
virtual bool pickingEnabled()
Definition: BaseObjectData.cc:318