Developer Documentation
AnimationT.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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef ANIMATIONT_HH
51 #define ANIMATIONT_HH
52 
53 #include <vector>
54 #include <map>
55 
56 #include "../PoseT.hh"
57 #include "AnimationHandle.hh"
58 
66 template<class PointT>
68 {
69  template<typename>
70  friend class SkeletonT;
71 
72 public:
73  typedef PointT Point;
74  typedef typename Point::value_type Scalar;
75  typedef PoseT<PointT> Pose;
76 
77 public:
78  AnimationT(std::string _name = "") : name_(_name), fps_(60) {}
79  virtual AnimationT* copy() = 0;
80  virtual ~AnimationT() {}
81 
82 public:
88  virtual Pose *pose(unsigned int _iFrame) = 0;
89  virtual unsigned int frameCount() = 0;
91 
97  virtual void insertJointAt(unsigned int _index) = 0;
98  virtual void removeJointAt(unsigned int _index) = 0;
100 
101  virtual void updateFromGlobal(unsigned int _index) = 0;
102  virtual void clearPoseCache() {}
103 
104  inline std::string name() {
105  return name_;
106  }
107 
108  inline void setName(std::string _name) {
109  name_ = _name;
110  }
111 
112  inline int fps() {
113  return fps_;
114  }
115 
116  inline void setFps(int _fps) {
117  fps_ = _fps;
118  }
119 
120 protected:
121  std::string name_;
122  int fps_;
123 };
124 
125 
126 #endif
A general pose, used to store the frames of the animation.
Definition: PoseT.hh:68
Stores a single animation.
Definition: AnimationT.hh:67
Pose * pose(const AnimationHandle &_hAni)
Returns a pointer to the pose with the given animation handle.
Definition: SkeletonT.cc:741
void updateFromGlobal(unsigned int _idJoint)
update the structure when parent changes for a joint
Definition: SkeletonT.cc:1006