Developer Documentation

BSplineCurveObject.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 //
47 // BSplineCurve object type
48 // Author: Ellen Dekkers <dekkers@cs.rwth-aachen.de>
49 //
50 //=============================================================================
51
52
59 #ifndef BSPLINECURVEOBJECT_HH
60 #define BSPLINECURVEOBJECT_HH
61
62
63 //== INCLUDES =================================================================
64
65 #include <OpenFlipper/common/BaseObjectData.hh>
66 #include <ObjectTypes/BSplineCurve/BSplineCurveNodeT.hh>
67
68 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
69 #include "BSplineCurveTypes.hh"
70
71
72 //== TYPEDEFS =================================================================
73
74 //== CLASS DEFINITION =========================================================
75
78 class OBJECTTYPEDLLEXPORT BSplineCurveObject : public BaseObjectData {
79
80 friend class TypeBSplineCurvePlugin;
81
82 public:
84 BSplineCurveObject();
85
87 BSplineCurveObject(const BSplineCurveObject& _object);
88
90 virtual ~BSplineCurveObject();
91
93 virtual void cleanup();
94
98 BaseObject* copy();
99
100
101 protected:
102
104 virtual void init(BSplineCurve* _curve = 0);
105
106
107 //===========================================================================
110 //===========================================================================
111 public:
112
114 void setName( QString _name );
115
116
117 //===========================================================================
120 //===========================================================================
121
122 public:
124 BSplineCurve* splineCurve();
125
126 private:
127 BSplineCurve* splineCurve_;
128
131 //===========================================================================
138 //===========================================================================
139
140 protected:
141
143 virtual void update(UpdateType _type = UPDATE_ALL);
144
147 //===========================================================================
150 //===========================================================================
151
152 public :
153
155 ACG::SceneGraph::BSplineCurveNodeT< BSplineCurve >* splineCurveNode();
156
157 private :
158
160 ACG::SceneGraph::BSplineCurveNodeT< BSplineCurve >* splineCurveNode_;
161
164 //===========================================================================
167 //===========================================================================
168 public:
170 QString getObjectinfo();
171
175 //===========================================================================
178 //===========================================================================
179 public:
181 bool picked( uint _node_idx );
182
184 void enablePicking( bool _enable );
185
187 bool pickingEnabled();
188
191 };
192
193 //=============================================================================
194 #endif // BSPLINECURVEOBJECT_HH defined
195 //=============================================================================
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
TypeBSplineCurvePlugin
Definition: TypeBSplineCurve.hh:71
BSplineCurveTypes.hh
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:315
BaseObjectData::cleanup
virtual void cleanup() override
Definition: BaseObjectData.cc:102
BaseObjectData.hh
BSplineCurveObject::splineCurveNode_
ACG::SceneGraph::BSplineCurveNodeT< BSplineCurve > * splineCurveNode_
Scenegraph Mesh Node.
Definition: BSplineCurveObject.hh:160
BSplineCurveObject::splineCurve_
BSplineCurve * splineCurve_
return a pointer to the spline curve
Definition: BSplineCurveObject.hh:127
ACG::BSplineCurveT
Definition: BSplineCurveT.hh:82
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
BSplineCurveObject
Definition: BSplineCurveObject.hh:78
ACG::SceneGraph::BSplineCurveNodeT
Definition: BSplineCurveNodeT.hh:88
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