use const for readonly strings and set some functions to static
[blender.git] / source / gameengine / Converter / BL_ArmatureActuator.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file BL_ArmatureActuator.h
29  *  \ingroup bgeconv
30  */
31
32 #ifndef BL_ARMATUREACTUATOR
33 #define BL_ARMATUREACTUATOR
34
35 #include "SCA_IActuator.h"
36 #include "BL_ArmatureConstraint.h"
37
38 /**
39  * This class is the conversion of the Pose channel constraint.
40  * It makes a link between the pose constraint and the KX scene.
41  * The main purpose is to give access to the constraint target 
42  * to link it to a game object. 
43  * It also allows to activate/deactivate constraints during the game.
44  * Later it will also be possible to create constraint on the fly
45  */
46
47 class   BL_ArmatureActuator : public SCA_IActuator
48 {
49         Py_Header;
50 public:
51         BL_ArmatureActuator(SCA_IObject* gameobj,
52                                                 int type,
53                                                 const char *posechannel,
54                                                 const char *constraintname,
55                                                 KX_GameObject* targetobj,
56                                                 KX_GameObject* subtargetobj,
57                                                 float weight);
58
59         virtual ~BL_ArmatureActuator();
60
61         virtual CValue* GetReplica() {
62                 BL_ArmatureActuator* replica = new BL_ArmatureActuator(*this);
63                 replica->ProcessReplica();
64                 return replica;
65         };
66         virtual void ProcessReplica();
67         virtual bool UnlinkObject(SCA_IObject* clientobj);
68         virtual void Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);
69         virtual bool Update(double curtime, bool frame);
70         virtual void ReParent(SCA_IObject* parent);
71         
72 #ifdef WITH_PYTHON
73
74         /* These are used to get and set m_target */
75         static PyObject* pyattr_get_constraint(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
76         static PyObject* pyattr_get_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
77         static int pyattr_set_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
78
79 #endif // WITH_PYTHON
80
81 private:
82         // identify the constraint that this actuator controls
83         void FindConstraint();
84
85         BL_ArmatureConstraint*  m_constraint;
86         KX_GameObject*  m_gametarget;
87         KX_GameObject*  m_gamesubtarget;
88         STR_String              m_posechannel;
89         STR_String              m_constraintname;
90         float                   m_weight;
91         int                             m_type;
92 };
93
94 #endif //BL_ARMATUREACTUATOR
95
96