370bbf51d723d2f3d33fe0da0b760c99b79f1e11
[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
38 class BL_Action
39 {
40 private:
41         struct bAction* m_action;
42         struct bPose* m_pose;
43         struct bPose* m_blendpose;
44         struct bPose* m_blendinpose;
45         struct PointerRNA *m_ptrrna;
46         std::vector<class SG_Controller*> m_sg_contr_list;
47         class KX_GameObject* m_obj;
48         std::vector<float>      m_blendshape;
49         std::vector<float>      m_blendinshape;
50
51         float m_startframe;
52         float m_endframe;
53         float m_starttime;
54         float m_endtime;
55         float m_localtime;
56
57         float m_blendin;
58         float m_blendframe;
59         float m_blendstart;
60
61         float m_layer_weight;
62
63         float m_speed;
64
65         short m_priority;
66
67         short m_playmode;
68
69         short m_ipo_flags;
70
71         bool m_done;
72         bool m_calc_localtime;
73
74         void ClearControllerList();
75         void InitIPO();
76         void SetLocalTime(float curtime);
77         void ResetStartTime(float curtime);
78         void IncrementBlending(float curtime);
79         void BlendShape(struct Key* key, float srcweight, std::vector<float>& blendshape);
80 public:
81         BL_Action(class KX_GameObject* gameobj);
82         ~BL_Action();
83
84         /**
85          * Play an action
86          */
87         bool Play(const char* name,
88                         float start,
89                         float end,
90                         short priority,
91                         float blendin,
92                         short play_mode,
93                         float layer_weight,
94                         short ipo_flags,
95                         float playback_speed);
96         /**
97          * Stop playing the action
98          */
99         void Stop();
100         /**
101          * Whether or not the action is still playing
102          */
103         bool IsDone();
104         /**
105          * Update the action's frame, etc.
106          */
107         void Update(float curtime);
108
109         // Accessors
110         float GetFrame();
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_IPOFLAG_FORCE = 1,
129                 ACT_IPOFLAG_LOCAL = 2,
130                 ACT_IPOFLAG_ADD = 4,
131                 ACT_IPOFLAG_CHILD = 8,
132         };
133
134 #ifdef WITH_CXX_GUARDEDALLOC
135         MEM_CXX_CLASS_ALLOC_FUNCS("GE:BL_Action")
136 #endif
137 };
138
139 #endif  /* BL_ACTION */