soc-2008-mxcurioni: merged changes to revision 23516
[blender.git] / source / gameengine / Converter / BL_ArmatureActuator.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 #ifndef BL_ARMATUREACTUATOR
30 #define BL_ARMATUREACTUATOR
31
32 #include "SCA_IActuator.h"
33 #include "BL_ArmatureConstraint.h"
34
35 /**
36  * This class is the conversion of the Pose channel constraint.
37  * It makes a link between the pose constraint and the KX scene.
38  * The main purpose is to give access to the constraint target 
39  * to link it to a game object. 
40  * It also allows to activate/deactivate constraints during the game.
41  * Later it will also be possible to create constraint on the fly
42  */
43
44 class   BL_ArmatureActuator : public SCA_IActuator
45 {
46         Py_Header;
47 public:
48         BL_ArmatureActuator(SCA_IObject* gameobj,
49                                                 int type,
50                                                 const char *posechannel,
51                                                 const char *constraintname,
52                                                 KX_GameObject* targetobj,
53                                                 KX_GameObject* subtargetobj,
54                                                 float weight);
55
56         virtual ~BL_ArmatureActuator();
57
58         virtual CValue* GetReplica() {
59                 BL_ArmatureActuator* replica = new BL_ArmatureActuator(*this);
60                 replica->ProcessReplica();
61                 return replica;
62         };
63         virtual void ProcessReplica();
64         virtual bool UnlinkObject(SCA_IObject* clientobj);
65         virtual void Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
66         virtual bool Update(double curtime, bool frame);
67         virtual void ReParent(SCA_IObject* parent);
68         
69         /* These are used to get and set m_target */
70         static PyObject* pyattr_get_constraint(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
71         static PyObject* pyattr_get_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
72         static int pyattr_set_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
73
74 private:
75         // identify the constraint that this actuator controls
76         void FindConstraint();
77
78         BL_ArmatureConstraint*  m_constraint;
79         KX_GameObject*  m_gametarget;
80         KX_GameObject*  m_gamesubtarget;
81         STR_String              m_posechannel;
82         STR_String              m_constraintname;
83         float                   m_weight;
84         int                             m_type;
85 };
86
87 #endif //BL_ARMATUREACTUATOR
88
89