BGE: Fix T45945: Action bouncing.
[blender.git] / source / gameengine / Ketsji / BL_Action.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Mitchell Stokes.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file BL_Action.h
24  *  \ingroup ketsji
25  */
26
27 #ifndef __BL_ACTION_H__
28 #define __BL_ACTION_H__
29
30
31 #include <vector>
32
33 #ifdef WITH_CXX_GUARDEDALLOC
34 #include "MEM_guardedalloc.h"
35 #endif
36
37 class BL_Action
38 {
39 private:
40         struct bAction* m_action;
41         struct bAction* m_tmpaction;
42         struct bPose* m_blendpose;
43         struct bPose* m_blendinpose;
44         std::vector<class SG_Controller*> m_sg_contr_list;
45         class KX_GameObject* m_obj;
46         std::vector<float>      m_blendshape;
47         std::vector<float>      m_blendinshape;
48
49         float m_startframe;
50         float m_endframe;
51         /// The current action frame.
52         float m_localframe;
53         float m_starttime;
54
55         float m_blendin;
56         float m_blendframe;
57         float m_blendstart;
58
59         float m_layer_weight;
60
61         float m_speed;
62
63         short m_priority;
64
65         short m_playmode;
66         short m_blendmode;
67
68         short m_ipo_flags;
69
70         bool m_done;
71         bool m_calc_localtime;
72         /// Set to true when m_starttime is initialized in Update.
73         bool m_initializedTime;
74
75         void ClearControllerList();
76         void InitIPO();
77         void SetLocalTime(float curtime);
78         void ResetStartTime(float curtime);
79         void IncrementBlending(float curtime);
80         void BlendShape(struct Key* key, float srcweight, std::vector<float>& blendshape);
81 public:
82         BL_Action(class KX_GameObject* gameobj);
83         ~BL_Action();
84
85         /**
86          * Play an action
87          */
88         bool Play(const char* name,
89                         float start,
90                         float end,
91                         short priority,
92                         float blendin,
93                         short play_mode,
94                         float layer_weight,
95                         short ipo_flags,
96                         float playback_speed,
97                         short blend_mode);
98         /**
99          * Whether or not the action is still playing
100          */
101         bool IsDone();
102         /**
103          * Update the action's frame, etc.
104          */
105         void Update(float curtime);
106
107         // Accessors
108         float GetFrame();
109         const char *GetName();
110
111         struct bAction *GetAction();
112
113         // Mutators
114         void SetFrame(float frame);
115         void SetPlayMode(short play_mode);
116         void SetTimes(float start, float end);
117
118         enum
119         {
120                 ACT_MODE_PLAY = 0,
121                 ACT_MODE_LOOP,
122                 ACT_MODE_PING_PONG,
123                 ACT_MODE_MAX,
124         };
125
126         enum
127         {
128                 ACT_BLEND_BLEND=0,
129                 ACT_BLEND_ADD=1,
130                 ACT_BLEND_MAX,
131         };
132
133         enum
134         {
135                 ACT_IPOFLAG_FORCE = 1,
136                 ACT_IPOFLAG_LOCAL = 2,
137                 ACT_IPOFLAG_ADD = 4,
138                 ACT_IPOFLAG_CHILD = 8,
139         };
140
141         /// Initialize a lock for animation thread issues.
142         static void InitLock();
143         /// Finalize a lock for animation thread issues.
144         static void EndLock();
145
146 #ifdef WITH_CXX_GUARDEDALLOC
147         MEM_CXX_CLASS_ALLOC_FUNCS("GE:BL_Action")
148 #endif
149 };
150
151 #endif  /* BL_ACTION */