Developer Documentation
SkeletonObjectData.hh
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 #ifndef SKELETONOBJECTDATA_HH
45 #define SKELETONOBJECTDATA_HH
46 
48 
49 #define OBJECTDATA_SKELETON "Skeleton Object Data"
50 
58 {
59 public:
61  }
62 
64  PerObjectData(),
65  skins_(_copy.skins_)
66  {
67  }
68 
70  }
71 
72  // Copy function
74  SkeletonObjectData* copy = new SkeletonObjectData(*this);
75  return copy;
76  }
77 
78 public:
82  int skin( unsigned int _index ){
83  if ( _index >= skins_.size() )
84  return -1;
85  return skins_[_index];
86  }
87 
91  unsigned int skinCount(){
92  return skins_.size();
93  }
94 
98  void addSkin(int _objectId){
99  //check if already available
100  for(unsigned int i=0; i < skins_.size(); i++)
101  if ( skins_[i] == _objectId )
102  return;
103  //add the skin
104  skins_.push_back(_objectId);
105  }
106 
110  void removeSkin(int _objectId){
111  //check if already available
112  for(unsigned int i=0; i < skins_.size(); i++)
113  if ( skins_[i] == _objectId ){
114  skins_.erase( skins_.begin() + i );
115  return;
116  }
117  //not found
118  std::cerr << "Cannot remove skin with object id:" << _objectId << ". Not found!" << std::endl;
119  }
120 
124  void clearSkins(){
125  skins_.clear();
126  }
127 
128 private:
129  //vector of object ids from all skins attached to this skeleton
130  std::vector< int > skins_;
131 };
132 
133 #endif //SKELETONOBJECTDATA_HH
PerObjectData()
You have to provide your own constructor for your object.
int skin(unsigned int _index)
Get the skin with given index (0 <= _index < skinCount())
void addSkin(int _objectId)
Add a skin to the skeleton.
unsigned int skinCount()
Get the number of associated skins.
PerObjectData * copyPerObjectData()
Copy Function.
Object Payload.
void removeSkin(int _objectId)
Remove a skin from the skeleton.
Data object attached to the skeleton.
void clearSkins()
Remove all skins from the skeleton.