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 #pragma once
43 
44 #include "AnimationT.hh"
45 
46 template<class PointT>
47 class FrameAnimationT : public AnimationT<PointT>
48 {
49  template<typename>
50  friend class SkeletonT;
51 
52  public:
53  typedef PointT Point;
54  typedef typename Point::value_type Scalar;
56  typedef PoseT<PointT> Pose;
57 
58  public:
59  explicit FrameAnimationT(const PoseT<PointT> &_pose);
60 
61  explicit FrameAnimationT(Skeleton* _skeleton);
62 
63  FrameAnimationT(Skeleton* _skeleton, unsigned int _iNumFrames);
64 
65  explicit FrameAnimationT(const FrameAnimationT<PointT> &_other);
66 
67  virtual ~FrameAnimationT();
68 
69  virtual AnimationT<PointT>* copy();
70 
71  virtual void updateFromGlobal(unsigned int _index);
72 
73  public:
74 
75  // =======================================================================================
79  // =======================================================================================
80 
85  inline Pose *pose(unsigned int _iFrame);
86 
89  inline unsigned int frameCount();
90 
93  void setFrameCount(unsigned int _frames);
96  // =======================================================================================
101  // =======================================================================================
102 
109  void insertJointAt(unsigned int _index);
110 
117  void removeJointAt(unsigned int _index);
120  private:
122  Skeleton* skeleton_;
124  std::vector<Pose*> poses_;
125 
126 };
127 
128 //=============================================================================
129 #if defined(INCLUDE_TEMPLATES) && !defined(FRAMEANIMATIONT_C)
130 #define FRAMEANIMATIONT_TEMPLATES
131 #include "FrameAnimationT_impl.hh"
132 #endif
133 //=============================================================================
134 
virtual ~FrameAnimationT()
Destructor.
Pose * pose(unsigned int _iFrame)
Returns a pointer to the pose stored in the given frame.
Skeleton * skeleton_
Pointer to associated skeleton.
unsigned int frameCount()
Returns the number of frames stored in this pose.
FrameAnimationT(const PoseT< PointT > &_pose)
Constructor - Creates a new animation consisting of a single pose.
SkeletonT< ACG::Vec3d > Skeleton
Simple Name for the Skeleton, based on double vectors.
A general pose, used to store the frames of the animation.
Definition: PoseT.hh:58
virtual void updateFromGlobal(unsigned int _index)
Updates the local matrix using the global matrix.
void setFrameCount(unsigned int _frames)
Set number of frames stored in this pose.
virtual AnimationT< PointT > * copy()
Copy Function.
Stores a single animation.
Definition: AnimationT.hh:58
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.
void insertJointAt(unsigned int _index)
Called by the skeleton as a new joint is inserted.