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 #pragma once
43
44 #include <vector>
45 #include <map>
46
47 #include "../PoseT.hh"
48 #include "AnimationHandle.hh"
49
57 template<class PointT>
58 class AnimationT
59 {
60 template<typename>
61 friend class SkeletonT;
62
63 public:
64 typedef PointT Point;
65 typedef typename Point::value_type Scalar;
66 typedef PoseT<PointT> Pose;
67
68 public:
69 explicit AnimationT(std::string _name = "") : name_(_name), fps_(60) {}
70 virtual AnimationT* copy() = 0;
71 virtual ~AnimationT() {}
72
73 public:
79 virtual Pose *pose(unsigned int _iFrame) = 0;
80 virtual unsigned int frameCount() = 0;
82
88 virtual void insertJointAt(unsigned int _index) = 0;
89 virtual void removeJointAt(unsigned int _index) = 0;
91
92 virtual void updateFromGlobal(unsigned int _index) = 0;
93 virtual void clearPoseCache() {}
94
95 inline std::string name() {
96 return name_;
97 }
98
99 inline void setName(std::string _name) {
100 name_ = _name;
101 }
102
103 inline int fps() {
104 return fps_;
105 }
106
107 inline void setFps(int _fps) {
108 fps_ = _fps;
109 }
110
111 protected:
112 std::string name_;
113 int fps_;
114 };
115
SkeletonT
Definition: JointT.hh:50
PoseT
A general pose, used to store the frames of the animation.
Definition: PoseT.hh:58
SkeletonT::pose
Pose * pose(const AnimationHandle &_hAni)
Returns a pointer to the pose with the given animation handle.
Definition: SkeletonT_impl.hh:735
AnimationT
Stores a single animation.
Definition: AnimationT.hh:58
SkeletonT::updateFromGlobal
void updateFromGlobal(size_t _idJoint)
update the structure when parent changes for a joint
Definition: SkeletonT_impl.hh:998