BGE: Added getActionName() function to KX_GameObject()
[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         float m_starttime;
52         float m_endtime;
53         float m_localtime;
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
73         void ClearControllerList();
74         void InitIPO();
75         void SetLocalTime(float curtime);
76         void ResetStartTime(float curtime);
77         void IncrementBlending(float curtime);
78         void BlendShape(struct Key* key, float srcweight, std::vector<float>& blendshape);
79 public:
80         BL_Action(class KX_GameObject* gameobj);
81         ~BL_Action();
82
83         /**
84          * Play an action
85          */
86         bool Play(const char* name,
87                         float start,
88                         float end,
89                         short priority,
90                         float blendin,
91                         short play_mode,
92                         float layer_weight,
93                         short ipo_flags,
94                         float playback_speed,
95                         short blend_mode);
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          * Update object IPOs (note: not thread-safe!)
110          */
111         void UpdateIPOs();
112
113         // Accessors
114         float GetFrame();
115         const char *GetName();
116
117         struct bAction *GetAction();
118
119         // Mutators
120         void SetFrame(float frame);
121         void SetPlayMode(short play_mode);
122         void SetTimes(float start, float end);
123
124         enum
125         {
126                 ACT_MODE_PLAY = 0,
127                 ACT_MODE_LOOP,
128                 ACT_MODE_PING_PONG,
129                 ACT_MODE_MAX,
130         };
131
132         enum
133         {
134                 ACT_BLEND_BLEND=0,
135                 ACT_BLEND_ADD=1,
136                 ACT_BLEND_MAX,
137         };
138
139         enum
140         {
141                 ACT_IPOFLAG_FORCE = 1,
142                 ACT_IPOFLAG_LOCAL = 2,
143                 ACT_IPOFLAG_ADD = 4,
144                 ACT_IPOFLAG_CHILD = 8,
145         };
146
147 #ifdef WITH_CXX_GUARDEDALLOC
148         MEM_CXX_CLASS_ALLOC_FUNCS("GE:BL_Action")
149 #endif
150 };
151
152 #endif  /* BL_ACTION */