Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / source / gameengine / Converter / BL_ArmatureObject.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BL_ARMATUREOBJECT
31 #define BL_ARMATUREOBJECT
32
33 #include "KX_GameObject.h"
34 #include "BL_ArmatureConstraint.h"
35 #include "BL_ArmatureChannel.h"
36
37 #include "SG_IObject.h"
38 #include <vector>
39 #include <algorithm>
40
41 struct bArmature;
42 struct Bone;
43 struct bConstraint;
44 class BL_ActionActuator;
45 class BL_ArmatureActuator;
46 class MT_Matrix4x4;
47 struct Object;
48 class KX_BlenderSceneConverter;
49
50 class BL_ArmatureObject : public KX_GameObject  
51 {
52         Py_Header;
53 public:
54
55         double GetLastFrame ();
56         short GetActivePriority();
57         virtual void ProcessReplica();
58         virtual void ReParentLogic();
59         virtual void Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
60         virtual bool UnlinkObject(SCA_IObject* clientobj);
61
62         class BL_ActionActuator * GetActiveAction();
63         
64         BL_ArmatureObject(
65                 void* sgReplicationInfo,
66                 SG_Callbacks callbacks,
67                 Object *armature,
68                 Scene *scene
69         );
70         virtual ~BL_ArmatureObject();
71
72         virtual CValue* GetReplica();
73         void GetMRDPose(struct bPose **pose);
74         void GetPose(struct bPose **pose);
75         void SetPose (struct bPose *pose);
76         struct bPose *GetOrigPose() {return m_pose;} // never edit this, only for accessing names
77
78         void ApplyPose();
79         void RestorePose();
80
81         bool SetActiveAction(class BL_ActionActuator *act, short priority, double curtime);
82         
83         struct bArmature * GetArmature() { return m_armature; }
84         const struct bArmature * GetArmature() const { return m_armature; }
85         const struct Scene * GetScene() const { return m_scene; }
86         
87         Object* GetArmatureObject() {return m_objArma;}
88
89         // for constraint python API
90         void LoadConstraints(KX_BlenderSceneConverter* converter);
91         size_t GetConstraintNumber() const { return m_constraintNumber; }
92         BL_ArmatureConstraint* GetConstraint(const char* posechannel, const char* constraint);
93         BL_ArmatureConstraint* GetConstraint(const char* posechannelconstraint);
94         BL_ArmatureConstraint* GetConstraint(int index);
95         // for pose channel python API
96         void LoadChannels();
97         size_t GetChannelNumber() const { return m_constraintNumber; }
98         BL_ArmatureChannel* GetChannel(bPoseChannel* channel);
99         BL_ArmatureChannel* GetChannel(const char* channel);
100         BL_ArmatureChannel* GetChannel(int index);
101
102         /// Retrieve the pose matrix for the specified bone.
103         /// Returns true on success.
104         bool GetBoneMatrix(Bone* bone, MT_Matrix4x4& matrix);
105         
106         /// Returns the bone length.  The end of the bone is in the local y direction.
107         float GetBoneLength(Bone* bone) const;
108
109         virtual int GetGameObjectType() { return OBJ_ARMATURE; }
110
111         // PYTHON
112         static PyObject* pyattr_get_constraints(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
113         static PyObject* pyattr_get_channels(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
114         KX_PYMETHOD_DOC_NOARGS(BL_ArmatureObject, update);
115
116 protected:
117         /* list element: BL_ArmatureConstraint. Use SG_DListHead to have automatic list replication */
118         SG_DListHead<BL_ArmatureConstraint>      m_controlledConstraints;
119         /* list element: BL_ArmatureChannel. Use SG_DList to avoid list replication */
120         SG_DList                        m_poseChannels;
121         Object                          *m_objArma;
122         struct bArmature        *m_armature;
123         struct bPose            *m_pose;
124         struct bPose            *m_armpose;
125         struct bPose            *m_framePose;
126         struct Scene            *m_scene; // need for where_is_pose 
127         double  m_lastframe;
128         double  m_timestep;             // delta since last pose evaluation.
129         class BL_ActionActuator *m_activeAct;
130         short   m_activePriority;
131         size_t  m_constraintNumber;
132         size_t  m_channelNumber;
133         // store the original armature object matrix
134         float m_obmat[4][4];
135
136         double                  m_lastapplyframe;
137
138
139 #ifdef WITH_CXX_GUARDEDALLOC
140 public:
141         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:BL_ArmatureObject"); }
142         void operator delete( void *mem ) { MEM_freeN(mem); }
143 #endif
144 };
145
146 /* Pose function specific to the game engine */
147 void game_blend_poses(struct bPose *dst, struct bPose *src, float srcweight/*, short mode*/); /* was blend_poses */
148 //void extract_pose_from_pose(struct bPose *pose, const struct bPose *src);
149 void game_copy_pose(struct bPose **dst, struct bPose *src, int copy_con);
150 void game_free_pose(struct bPose *pose);
151
152
153 #endif
154