Developer Documentation

PluginFunctionsSkeleton.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
45
46
47 //=============================================================================
48 //
49 // Plugin Functions for Skeleton
50 //
51 //=============================================================================
52
53 #include <OpenFlipper/common/Types.hh>
54 #include <OpenFlipper/BasePlugin/PluginFunctions.hh>
55 #include "Skeleton.hh"
56
57 namespace PluginFunctions {
58
59 // ===============================================================================
60 // Get objects
61 // ===============================================================================
62
63 bool getObject( int _identifier , SkeletonObject*& _object ) {
64 if (_identifier == BaseObject::NOOBJECT)
65 return false;
66
67 // Get object by using the map accelerated plugin function
68 BaseObjectData* object = 0;
69 PluginFunctions::getObject(_identifier,object);
70
71 _object = dynamic_cast< SkeletonObject* >(object);
72 return ( _object != 0 );
73 }
74
75
76 // ===============================================================================
77 // Getting data from objects and casting between them
78 // ===============================================================================
79
80 Skeleton* skeleton( BaseObjectData* _object ) {
81 if ( _object && _object->dataType(DATA_SKELETON) ) {
82 SkeletonObject* object = dynamic_cast< SkeletonObject* >(_object);
83 return object->skeleton();
84 } else
85 return NULL;
86 }
87
88 Skeleton* skeleton( int _identifier ) {
89
90 SkeletonObject* object = skeletonObject(_identifier);
91
92 if ( object ) {
93 return object->skeleton();
94 } else
95 return NULL;
96 }
97
98
99 SkeletonObject* skeletonObject( BaseObjectData* _object ) {
100 if ( !_object || ! _object->dataType(DATA_SKELETON) )
101 return NULL;
102 return dynamic_cast< SkeletonObject* >( _object );
103 }
104
105
106 SkeletonObject* skeletonObject( int _identifier ) {
107 SkeletonObject* object;
108 if ( ! getObject( _identifier, object ) )
109 return 0;
110
111 if ( !object || ! object->dataType(DATA_SKELETON) )
112 return NULL;
113 return dynamic_cast< SkeletonObject* >( object );
114 }
115
116
117 }
PluginFunctions::skeletonObject
SkeletonObject * skeletonObject(BaseObjectData *_object)
Cast an BaseObject to a SkeletonObject if possible.
Definition: PluginFunctionsSkeleton.cc:99
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
DATA_SKELETON
#define DATA_SKELETON
Definition: Skeleton.hh:64
PluginFunctions.hh
BaseObject::dataType
bool dataType(DataType _type) const
Definition: BaseObject.cc:221
SkeletonObject
Definition: SkeletonObject.hh:72
BaseObject::NOOBJECT
static int NOOBJECT
Definition: BaseObject.hh:106
PluginFunctions::skeleton
Skeleton * skeleton(BaseObjectData *_object)
Get a skeleton from an object.
Definition: PluginFunctionsSkeleton.cc:80
BaseObjectData
Definition: BaseObjectData.hh:102
Skeleton.hh
SkeletonT
Definition: JointT.hh:50
Types.hh
PluginFunctions
Definition: PluginFunctions.cc:57
SkeletonObject::skeleton
Skeleton * skeleton()
Returns a pointer to the skeleton.
Definition: SkeletonObject.cc:207