Developer Documentation

CameraObject.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 * $Date$
46 *
47 \*===========================================================================*/
48
49
50
51
52
53 //=============================================================================
54 //
55 // Types
56 //
57 //=============================================================================
58
65 #ifndef CAMERAOBJECT_HH
66 #define CAMERAOBJECT_HH
67
68
69
70 //== INCLUDES =================================================================
71
72 #include <OpenFlipper/common/BaseObjectData.hh>
73
74 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
75
76 #include "CameraTypes.hh"
77
78 //== TYPEDEFS =================================================================
79
80 // //== CLASS DEFINITION =========================================================
81
82 class OBJECTTYPEDLLEXPORT CameraObject : public BaseObjectData {
83
84 friend class TypeCameraPlugin;
85
86 public:
88 CameraObject( );
89
94 CameraObject(const CameraObject& _object);
95
97 virtual ~CameraObject();
98
100 virtual void cleanup();
101
105 BaseObject* copy();
106
107
108 protected:
110 virtual void init(CameraNode* _plane = 0);
111
112 //===========================================================================
115 //===========================================================================
116 public:
117
119 void setName( QString _name );
120
121 //===========================================================================
124 //===========================================================================
125
126 public:
128 CameraNode* cameraNode();
129
130 private:
131 CameraNode* cameraNode_;
132
135 //===========================================================================
138 //===========================================================================
139 public:
141 QString getObjectinfo();
142
146 //===========================================================================
149 //===========================================================================
150 public:
152 bool picked( uint _node_idx );
153
155 void enablePicking( bool _enable );
156
158 bool pickingEnabled();
159
162 public:
163 void viewerId(int _viewerId) { viewerId_ = _viewerId; }
164
165 int viewerId() { return viewerId_; }
166
167 void examinerId(int _examinerId) { examinerId_ = _examinerId; }
168
169 int examinerId() { return examinerId_; }
170
171
172 private:
173
175 int viewerId_;
176
178 int examinerId_;
179
180 //===========================================================================
187 //===========================================================================
188 protected:
189
191 virtual void update(UpdateType _type = UPDATE_ALL);
192
194 };
195
196 //=============================================================================
197 #endif // CAMERAOBJECT_HH defined
198 //=============================================================================
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.
CameraTypes.hh
CameraObject::examinerId_
int examinerId_
Attached examiner id.
Definition: CameraObject.hh:178
BaseObject
Definition: BaseObject.hh:82
CameraObject::viewerId_
int viewerId_
Attached viewer id.
Definition: CameraObject.hh:175
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
ACG::SceneGraph::CameraNode
Definition: CameraNode.hh:90
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
TypeCameraPlugin
Definition: TypeCamera.hh:57
CameraObject::cameraNode_
CameraNode * cameraNode_
Get the scenegraph Node.
Definition: CameraObject.hh:131
CameraObject
Definition: CameraObject.hh:82
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