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 
73 
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:
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 
176 
179 
180  //===========================================================================
187  //===========================================================================
188  protected:
189 
191  virtual void update(UpdateType _type = UPDATE_ALL);
192 
194 };
195 
196 //=============================================================================
197 #endif // CAMERAOBJECT_HH defined
198 //=============================================================================
Update type class.
Definition: UpdateType.hh:60
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:244
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
virtual void update(UpdateType _type=UPDATE_ALL)
This function is called to update the object.
CameraNode * cameraNode_
Get the scenegraph Node.
virtual void cleanup()
virtual bool pickingEnabled()
virtual void setName(QString _name)
path to the file from which the object is loaded ( defaults to "." )
int viewerId_
Attached viewer id.
int examinerId_
Attached examiner id.
virtual void enablePicking(bool _enable)
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:769
virtual bool picked(uint _node_idx)
detect if the node has been picked