Developer Documentation
PluginFunctionsCamera.cc
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 
56 //=============================================================================
57 //
58 // Plugin Functions for Cameras
59 //
60 //=============================================================================
61 
63 #include "Camera.hh"
64 
66 
67 namespace PluginFunctions {
68 
69 // ===============================================================================
70 // Get source cameras
71 // ===============================================================================
72 
73 
74 bool getSourceCameras( std::vector<CameraNode*>& _cameras )
75 {
76  _cameras.clear();
77 
79  o_it != PluginFunctions::objectsEnd(); ++o_it) {
80  _cameras.push_back ( PluginFunctions::cameraNode( *o_it ) );
81  if( _cameras.back() == NULL)
82  std::cerr << "ERROR: Camera - get_source_cameras fatal error\n";
83  }
84 
85  return ( !_cameras.empty() );
86 }
87 
88 
89 // ===============================================================================
90 // Get target cameras
91 // ===============================================================================
92 
93 
94 bool getTargetCameras( std::vector<CameraNode*>& _cameras )
95 {
96  _cameras.clear();
97 
99  o_it != PluginFunctions::objectsEnd(); ++o_it) {
100  _cameras.push_back ( PluginFunctions::cameraNode( *o_it ) );
101  if( _cameras.back() == NULL)
102  std::cerr << "ERROR: Camera - getTargetPolylines fatal error\n";
103  }
104 
105  return ( !_cameras.empty() );
106 }
107 
108 
109 // ===============================================================================
110 // Get objects
111 // ===============================================================================
112 
113 bool getObject( int _identifier , CameraObject*& _object ) {
114 
115  if ( _identifier == BaseObject::NOOBJECT ) {
116  _object = 0;
117  return false;
118  }
119 
120  // Get object by using the map accelerated plugin function
121  BaseObjectData* object = 0;
122  PluginFunctions::getObject(_identifier,object);
123 
124  _object = dynamic_cast< CameraObject* >(object);
125  return ( _object != 0 );
126 }
127 
128 
129 CameraObject* cameraObject( int _objectId ) {
130  if ( _objectId == BaseObject::NOOBJECT ) {
131  return 0;
132  }
133 
134  // Get object by using the map accelerated plugin function
135  BaseObjectData* object = 0;
136  PluginFunctions::getObject(_objectId,object);
137 
138  CameraObject* cam = dynamic_cast< CameraObject* >(object);
139  return cam;
140 }
141 
142 
143 // ===============================================================================
144 // Getting data from objects and casting between them
145 // ===============================================================================
146 
148  if ( _object->dataType(DATA_CAMERA) ) {
149  CameraObject* object = dynamic_cast< CameraObject* >(_object);
150  return object->cameraNode();
151  } else
152  return 0;
153 }
154 
155 
157  if ( ! _object->dataType(DATA_CAMERA) )
158  return 0;
159  return dynamic_cast< CameraObject* >( _object );
160 }
161 
162 
163 }
CameraNode * cameraNode(BaseObjectData *_object)
Get a CameraNode from an object.
bool getSourceCameras(std::vector< CameraNode *> &_cameras)
Get a pointer to every Camera which is marked as a source.
const QStringList SOURCE_OBJECTS("source")
Iterable object range.
bool getTargetCameras(std::vector< CameraNode *> &_cameras)
Get a pointer to every Camera which is marked as a target.
bool dataType(DataType _type) const
Definition: BaseObject.cc:221
const QStringList TARGET_OBJECTS("target")
Iterable object range.
CameraObject * cameraObject(int _objectId)
Get a CameraObject from an object id if possible.
#define DATA_CAMERA
Definition: Camera.hh:67
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
static int NOOBJECT
Definition: BaseObject.hh:106
DLLEXPORT ObjectIterator objectsEnd()
Return Iterator to Object End.
CameraNode * cameraNode()
Get the scenegraph Node.