Developer Documentation

SplatCloudObject.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
50
57 #ifndef SPLATCLOUDOBJECT_HH
58 #define SPLATCLOUDOBJECT_HH
59
60
61 //== INCLUDES ====================================================
62
63
64 #include "SplatCloudTypes.hh"
65
66 #include "SplatCloud/SplatCloud.hh"
67
68 #include <OpenFlipper/common/BaseObjectData.hh>
69
70 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
71
72
73 //== CLASS DEFINITION ============================================
74
75
76 class OBJECTTYPEDLLEXPORT SplatCloudObject : public BaseObjectData
77 {
78
79 friend class TypeSplatCloudPlugin;
80
81 public:
83 SplatCloudObject();
84
89 SplatCloudObject( const SplatCloudObject &_object );
90
92 virtual ~SplatCloudObject();
93
95 virtual void cleanup();
96
100 BaseObject *copy();
101
106 void reloadShaders();
107
110 void enableBackfaceCulling( bool _enable );
111
114 void enableGeometryShaderQuads( bool _enable );
115
118 void setPointsizeScale( float _scale );
119
120 inline bool isBackfaceCullingEnabled() const { return backfaceCullingEnabled_; }
121 inline float pointsizeScale() const { return pointsizeScale_; }
122
123 private:
124 bool backfaceCullingEnabled_;
125 float pointsizeScale_;
126
127 protected:
129 virtual void init( const SplatCloud *_splatCloud = 0 );
130
131 //===========================================================================
138 //===========================================================================
139 protected:
140
142 void update( UpdateType _type = UPDATE_ALL );
143
146 //--------------------------------
149 //--------------------------------
150 public:
152 void setName( QString _name );
153
156 //--------------------------------
159 //--------------------------------
160 public:
162 inline SplatCloud *splatCloud() { return splatCloud_; }
163 inline const SplatCloud *splatCloud() const { return splatCloud_; }
164
165 private:
166 SplatCloud *splatCloud_;
167
170 //--------------------------------
173 //--------------------------------
174 public:
176 inline ShaderNode *shaderNode() { return shaderNode_; }
177 inline const ShaderNode *shaderNode() const { return shaderNode_; }
178
180 inline SplatCloudNode *splatCloudNode() { return splatCloudNode_; }
181 inline const SplatCloudNode *splatCloudNode() const { return splatCloudNode_; }
182
183 private:
184 ShaderNode *shaderNode_;
185 SplatCloudNode *splatCloudNode_;
186
189 //--------------------------------
192 //--------------------------------
193 public:
195 QString getObjectinfo();
196
199 //--------------------------------
202 //--------------------------------
203 public:
205 bool picked( uint _node_idx );
206
208 void enablePicking( bool _enable );
209
211 bool pickingEnabled();
212
215 };
216
217
218 //================================================================
219
220
221 #endif // SPLATCLOUDOBJECT_HH
UpdateType
Update type class.
Definition: UpdateType.hh:60
BaseObject::getObjectinfo
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:244
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
BaseObjectData::update
virtual void update(UpdateType _type=UPDATE_ALL)
This function is called to update the object.
Definition: BaseObjectData.cc:329
SplatCloudObject::shaderNode_
ShaderNode * shaderNode_
Get Shader&#39;s scenegraph Node.
Definition: SplatCloudObject.hh:184
SplatCloudObject::splatCloudNode
const SplatCloudNode * splatCloudNode() const
Get Shader&#39;s scenegraph Node.
Definition: SplatCloudObject.hh:181
ObjectTypeDLLDefines.hh
BaseObjectData::cleanup
virtual void cleanup()
Definition: BaseObjectData.cc:102
BaseObjectData.hh
BaseObjectData::pickingEnabled
virtual bool pickingEnabled()
Definition: BaseObjectData.cc:318
SplatCloudObject::shaderNode
ShaderNode * shaderNode()
Get Shader&#39;s scenegraph Node.
Definition: SplatCloudObject.hh:176
SplatCloudObject
Definition: SplatCloudObject.hh:76
BaseObjectData::setName
virtual void setName(QString _name)
path to the file from which the object is loaded ( defaults to "." )
Definition: BaseObjectData.cc:355
TypeSplatCloudPlugin
Definition: TypeSplatCloud.hh:78
SplatCloud
Definition: SplatCloud.hh:79
SplatCloudObject::splatCloud
SplatCloud * splatCloud()
Get SplatCloud.
Definition: SplatCloudObject.hh:162
ACG::SceneGraph::ShaderNode
Definition: ShaderNode.hh:81
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:315
SplatCloudObject::splatCloud_
SplatCloud * splatCloud_
Get SplatCloud.
Definition: SplatCloudObject.hh:166
ACG::SceneGraph::SplatCloudNode
Definition: SplatCloudNode.hh:89
BaseObject
Definition: BaseObject.hh:82
SplatCloudObject::shaderNode
const ShaderNode * shaderNode() const
Get Shader&#39;s scenegraph Node.
Definition: SplatCloudObject.hh:177
BaseObject::copy
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:769
BaseObjectData::picked
virtual bool picked(uint _node_idx)
detect if the node has been picked
Definition: BaseObjectData.cc:311
BaseObjectData
Definition: BaseObjectData.hh:102
SplatCloudTypes.hh
SplatCloudObject::splatCloud
const SplatCloud * splatCloud() const
Get SplatCloud.
Definition: SplatCloudObject.hh:163
SplatCloudObject::splatCloudNode
SplatCloudNode * splatCloudNode()
Get SplatCloud&#39;s scenegraph Node.
Definition: SplatCloudObject.hh:180
SplatCloudObject::splatCloudNode_
SplatCloudNode * splatCloudNode_
Get Shader&#39;s scenegraph Node.
Definition: SplatCloudObject.hh:185