svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file BL_ArmatureObject.h
31  *  \ingroup bgeconv
32  */
33
34 #ifndef BL_ARMATUREOBJECT
35 #define BL_ARMATUREOBJECT
36
37 #include "KX_GameObject.h"
38 #include "BL_ArmatureConstraint.h"
39 #include "BL_ArmatureChannel.h"
40
41 #include "SG_IObject.h"
42 #include <vector>
43 #include <algorithm>
44
45 struct bArmature;
46 struct Bone;
47 struct bConstraint;
48 class BL_ActionActuator;
49 class BL_ArmatureActuator;
50 class MT_Matrix4x4;
51 struct Object;
52 class KX_BlenderSceneConverter;
53
54 class BL_ArmatureObject : public KX_GameObject  
55 {
56         Py_Header;
57 public:
58
59         double GetLastFrame ();
60         short GetActivePriority();
61         virtual void ProcessReplica();
62         virtual void ReParentLogic();
63         virtual void Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);
64         virtual bool UnlinkObject(SCA_IObject* clientobj);
65
66         class BL_ActionActuator * GetActiveAction();
67         
68         BL_ArmatureObject(
69                 void* sgReplicationInfo,
70                 SG_Callbacks callbacks,
71                 Object *armature,
72                 Scene *scene,
73                 int vert_deform_type
74         );
75         virtual ~BL_ArmatureObject();
76
77         virtual CValue* GetReplica();
78         void GetMRDPose(struct bPose **pose);
79         void GetPose(struct bPose **pose);
80         void SetPose (struct bPose *pose);
81         struct bPose *GetOrigPose() {return m_pose;} // never edit this, only for accessing names
82
83         void ApplyPose();
84         void RestorePose();
85
86         bool SetActiveAction(class BL_ActionActuator *act, short priority, double curtime);
87         
88         struct bArmature * GetArmature() { return m_armature; }
89         const struct bArmature * GetArmature() const { return m_armature; }
90         const struct Scene * GetScene() const { return m_scene; }
91         
92         Object* GetArmatureObject() {return m_objArma;}
93
94         int GetVertDeformType() {return m_vert_deform_type;}
95
96         // for constraint python API
97         void LoadConstraints(KX_BlenderSceneConverter* converter);
98         size_t GetConstraintNumber() const { return m_constraintNumber; }
99         BL_ArmatureConstraint* GetConstraint(const char* posechannel, const char* constraint);
100         BL_ArmatureConstraint* GetConstraint(const char* posechannelconstraint);
101         BL_ArmatureConstraint* GetConstraint(int index);
102         // for pose channel python API
103         void LoadChannels();
104         size_t GetChannelNumber() const { return m_channelNumber; }
105         BL_ArmatureChannel* GetChannel(bPoseChannel* channel);
106         BL_ArmatureChannel* GetChannel(const char* channel);
107         BL_ArmatureChannel* GetChannel(int index);
108
109         /// Retrieve the pose matrix for the specified bone.
110         /// Returns true on success.
111         bool GetBoneMatrix(Bone* bone, MT_Matrix4x4& matrix);
112         
113         /// Returns the bone length.  The end of the bone is in the local y direction.
114         float GetBoneLength(Bone* bone) const;
115
116         virtual int GetGameObjectType() { return OBJ_ARMATURE; }
117
118 #ifdef WITH_PYTHON
119
120         // PYTHON
121         static PyObject* pyattr_get_constraints(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
122         static PyObject* pyattr_get_channels(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
123         KX_PYMETHOD_DOC_NOARGS(BL_ArmatureObject, update);
124
125 #endif // WITH_PYTHON
126
127 protected:
128         /* list element: BL_ArmatureConstraint. Use SG_DListHead to have automatic list replication */
129         SG_DListHead<BL_ArmatureConstraint>      m_controlledConstraints;
130         /* list element: BL_ArmatureChannel. Use SG_DList to avoid list replication */
131         SG_DList                        m_poseChannels;
132         Object                          *m_objArma;
133         struct bArmature        *m_armature;
134         struct bPose            *m_pose;
135         struct bPose            *m_armpose;
136         struct bPose            *m_framePose;
137         struct Scene            *m_scene; // need for where_is_pose 
138         double  m_lastframe;
139         double  m_timestep;             // delta since last pose evaluation.
140         class BL_ActionActuator *m_activeAct;
141         short   m_activePriority;
142         int             m_vert_deform_type;
143         size_t  m_constraintNumber;
144         size_t  m_channelNumber;
145         // store the original armature object matrix
146         float m_obmat[4][4];
147
148         double                  m_lastapplyframe;
149 };
150
151 /* Pose function specific to the game engine */
152 void game_blend_poses(struct bPose *dst, struct bPose *src, float srcweight/*, short mode*/); /* was blend_poses */
153 //void extract_pose_from_pose(struct bPose *pose, const struct bPose *src);
154 void game_copy_pose(struct bPose **dst, struct bPose *src, int copy_con);
155 void game_free_pose(struct bPose *pose);
156
157
158 #endif
159