Developer Documentation
FrameAnimationT.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 FRAMEANIMATIONT_HH
51 #define FRAMEANIMATIONT_HH
52 
53 #include "AnimationT.hh"
54 
55 template<class PointT>
56 class FrameAnimationT : public AnimationT<PointT>
57 {
58  template<typename>
59  friend class SkeletonT;
60 
61  public:
62  typedef PointT Point;
63  typedef typename Point::value_type Scalar;
65  typedef PoseT<PointT> Pose;
66 
67  public:
68  FrameAnimationT(const PoseT<PointT> &_pose);
69 
70  FrameAnimationT(Skeleton* _skeleton);
71 
72  FrameAnimationT(Skeleton* _skeleton, unsigned int _iNumFrames);
73 
75 
76  virtual ~FrameAnimationT();
77 
78  virtual AnimationT<PointT>* copy();
79 
80  virtual void updateFromGlobal(unsigned int _index);
81 
82  public:
83 
84  // =======================================================================================
88  // =======================================================================================
89 
94  inline Pose *pose(unsigned int _iFrame);
95 
98  inline unsigned int frameCount();
99 
102  void setFrameCount(unsigned int _frames);
105  // =======================================================================================
110  // =======================================================================================
111 
118  void insertJointAt(unsigned int _index);
119 
126  void removeJointAt(unsigned int _index);
129  private:
131  Skeleton* skeleton_;
133  std::vector<Pose*> poses_;
134 
135 };
136 
137 //=============================================================================
138 #if defined(INCLUDE_TEMPLATES) && !defined(FRAMEANIMATIONT_C)
139 #define FRAMEANIMATIONT_TEMPLATES
140 #include "FrameAnimationT.cc"
141 #endif
142 //=============================================================================
143 
144 #endif //FRAMEANIMATIONT_HH
virtual ~FrameAnimationT()
Destructor.
SkeletonT< ACG::Vec3d > Skeleton
Simple Name for the Skeleton, based on double vectors.
Pose * pose(unsigned int _iFrame)
Returns a pointer to the pose stored in the given frame.
unsigned int frameCount()
Returns the number of frames stored in this pose.
void removeJointAt(unsigned int _index)
Called by the skeleton as a joint is deleted.
std::vector< Pose * > poses_
Every entry in this vector is a frame of the animation.
A general pose, used to store the frames of the animation.
Definition: PoseT.hh:68
FrameAnimationT(const PoseT< PointT > &_pose)
Constructor - Creates a new animation consisting of a single pose.
Stores a single animation.
Definition: AnimationT.hh:67
void setFrameCount(unsigned int _frames)
Set number of frames stored in this pose.
void insertJointAt(unsigned int _index)
Called by the skeleton as a new joint is inserted.
virtual void updateFromGlobal(unsigned int _index)
Updates the local matrix using the global matrix.
Skeleton * skeleton_
Pointer to associated skeleton.
virtual AnimationT< PointT > * copy()
Copy Function.