Developer Documentation

MultiInterpolationAnimationT.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 #pragma once
44
45 #include "InterpolationAnimationT.hh"
46
47 template<class PointT>
48 class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
49 {
50 template<typename>
51 friend class SkeletonT;
52
53 public:
54 typedef PointT Point;
55 typedef typename Point::value_type Scalar;
56 typedef PoseT<PointT> Pose;
57 typedef InterpolationMatrixManipulatorT<Scalar> MatrixManipulator;
58 typedef InterpolationT<Scalar> Interpolator;
59 typedef std::vector<Scalar> TargetType;
60 typedef std::vector< InterpolationAnimationT<ACG::Vec3d>* > InterpolationAnimations;
61
62 public:
63 MultiInterpolationAnimationT(const MultiInterpolationAnimationT<PointT> &_other);
64 MultiInterpolationAnimationT() : InterpolationAnimationT<PointT>(NULL, NULL), interpolationAnimations_() {}
65 MultiInterpolationAnimationT(const InterpolationAnimations& _interpolationAnimations) : interpolationAnimations_(_interpolationAnimations) {}
66
67 virtual AnimationT<PointT>* copy();
68
69 virtual void updateFromGlobal(unsigned int _index) {/*NOOP*/};
70
71 virtual bool getMinInput(Scalar& _result);
72 virtual bool getMaxInput(Scalar& _result);
73
74 private:
75 InterpolationAnimations interpolationAnimations_;
76
77 public:
78 using InterpolationAnimationT<PointT>::FPS;
79
80 public:
81
82 //===========================================================================
88 //===========================================================================
89
95 virtual Pose *pose(unsigned int _iFrame);
96
103 virtual Pose *pose(unsigned int _iFrame, Pose* _reference);
104 virtual unsigned int frameCount();
107 //===========================================================================
112 //===========================================================================
119 void insertJointAt(unsigned int _index) {};
120
127 void removeJointAt(unsigned int _index) {};
130 //===========================================================================
134 //===========================================================================
135 void addInterpolationAnimation(InterpolationAnimationT<PointT> *_animation) {
136 interpolationAnimations_.push_back(_animation);
137 }
138 unsigned int animationCount() {
139 return interpolationAnimations_.size();
140 }
141
142 InterpolationAnimationT<PointT>* animation(unsigned int _index );
145 virtual void clearPoseCache() {
146 for (uint i=0; i < interpolationAnimations_.size(); ++i) {
147 interpolationAnimations_[i]->clearPoseCache();
148 }
149 }
150 };
151
152 //=============================================================================
153 #if defined(INCLUDE_TEMPLATES) && !defined(MULTIINTERPOLATIONANIMATIONT_C)
154 #define MULTIINTERPOLATIONANIMATIONT_TEMPLATES
155 #include "MultiInterpolationAnimationT_impl.hh"
156 #endif
157 //=============================================================================
158
InterpolationMatrixManipulatorT
Knows how to apply the values generated by an interpolator to a matrix. When playing back an Interpol...
Definition: InterpolationMatrixManipulatorT.hh:58
MultiInterpolationAnimationT::frameCount
virtual unsigned int frameCount()
Returns the number of frames that this animation can playback.
Definition: MultiInterpolationAnimationT_impl.hh:116
MultiInterpolationAnimationT::pose
virtual Pose * pose(unsigned int _iFrame)
get a pose
Definition: MultiInterpolationAnimationT_impl.hh:129
MultiInterpolationAnimationT::updateFromGlobal
virtual void updateFromGlobal(unsigned int _index)
Updates the local matrix using the global matrix.
Definition: MultiInterpolationAnimationT.hh:69
AnimationT
Stores a single animation.
Definition: AnimationT.hh:58
PoseT
A general pose, used to store the frames of the animation.
Definition: PoseT.hh:58
MultiInterpolationAnimationT::insertJointAt
void insertJointAt(unsigned int _index)
Called by the skeleton as a new joint is inserted.
Definition: MultiInterpolationAnimationT.hh:119
InterpolationAnimationT
Definition: InterpolationAnimationT.hh:52
MultiInterpolationAnimationT::removeJointAt
void removeJointAt(unsigned int _index)
Called by the skeleton as a joint is deleted.
Definition: MultiInterpolationAnimationT.hh:127
MultiInterpolationAnimationT
Definition: MultiInterpolationAnimationT.hh:48
SkeletonT::animation
Animation * animation(std::string _name)
Returns a pointer to the animation to the given name.
Definition: SkeletonT_impl.hh:852
SkeletonT::animationCount
size_t animationCount()
Returns the number of animations stored in this skeleton.
Definition: SkeletonT_impl.hh:965
SkeletonT
Definition: JointT.hh:50
MultiInterpolationAnimationT::Pose
PoseT< PointT > Pose
Typedef for the pose template.
Definition: MultiInterpolationAnimationT.hh:56
InterpolationT
Definition: InterpolationT.hh:49