[#17600] char* -> const char*
[blender.git] / source / gameengine / Ketsji / KX_ConstraintActuator.h
1 /**
2  * KX_ConstraintActuator.h
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef __KX_CONSTRAINTACTUATOR
33 #define __KX_CONSTRAINTACTUATOR
34
35 #include "SCA_IActuator.h"
36 #include "MT_Scalar.h"
37 #include "MT_Vector3.h"
38 #include "KX_ClientObjectInfo.h"
39
40 class KX_RayCast;
41
42 class KX_ConstraintActuator : public SCA_IActuator
43 {
44         Py_Header;
45 protected:      
46         // Damp time (int),
47         int m_posDampTime;
48         int m_rotDampTime;
49         // min (float) 
50         float m_minimumBound;
51         // max (float)
52         float m_maximumBound;
53         // sinus of minimum angle
54         float m_minimumSine;
55         // sinus of maximum angle
56         float m_maximumSine;
57         // reference direction
58         MT_Vector3 m_refDirection;
59         // locrotxyz choice (pick one): only one choice allowed at a time!
60         int m_locrot;
61         // active time of actuator
62         int m_activeTime;
63         int m_currentTime;
64         // option
65         int m_option;
66         // property to check
67         char m_property[32];
68
69         /**
70          * Clamp <var> to <min>, <max>. Borders are included (in as far as
71          * float comparisons are good for equality...).
72          */
73         void Clamp(MT_Scalar &var, float min, float max);
74
75         
76  public:
77          //  m_locrot
78         enum KX_CONSTRAINTTYPE {
79                 KX_ACT_CONSTRAINT_NODEF = 0,
80                 KX_ACT_CONSTRAINT_LOCX,
81                 KX_ACT_CONSTRAINT_LOCY,
82                 KX_ACT_CONSTRAINT_LOCZ,
83                 KX_ACT_CONSTRAINT_ROTX,
84                 KX_ACT_CONSTRAINT_ROTY,
85                 KX_ACT_CONSTRAINT_ROTZ,
86                 KX_ACT_CONSTRAINT_DIRPX,
87                 KX_ACT_CONSTRAINT_DIRPY,
88                 KX_ACT_CONSTRAINT_DIRPZ,
89                 KX_ACT_CONSTRAINT_DIRNX,
90                 KX_ACT_CONSTRAINT_DIRNY,
91                 KX_ACT_CONSTRAINT_DIRNZ,
92                 KX_ACT_CONSTRAINT_ORIX,
93                 KX_ACT_CONSTRAINT_ORIY,
94                 KX_ACT_CONSTRAINT_ORIZ,
95                 KX_ACT_CONSTRAINT_MAX
96         };
97         // match ACT_CONST_... values from BIF_interface.h
98         enum KX_CONSTRAINTOPT {
99                 KX_ACT_CONSTRAINT_NORMAL = 64,
100                 KX_ACT_CONSTRAINT_MATERIAL = 128,
101                 KX_ACT_CONSTRAINT_PERMANENT = 256,
102                 KX_ACT_CONSTRAINT_DISTANCE = 512
103         };
104         bool IsValidMode(KX_CONSTRAINTTYPE m); 
105         bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
106         bool NeedRayCast(KX_ClientObjectInfo*);
107
108         KX_ConstraintActuator(SCA_IObject* gameobj,
109                                                   int posDamptime,
110                                                   int rotDampTime,
111                                                   float min,
112                                                   float max,
113                                                   float refDir[3],
114                                                   int locrot,
115                                                   int time,
116                                                   int option,
117                                                   char *property,
118                                                   PyTypeObject* T=&Type);
119         virtual ~KX_ConstraintActuator();
120         virtual CValue* GetReplica() {
121                 KX_ConstraintActuator* replica = new KX_ConstraintActuator(*this);
122                 replica->ProcessReplica();
123                 // this will copy properties and so on...
124                 CValue::AddDataToReplica(replica);
125                 return replica;
126         };
127
128         virtual bool Update(double curtime, bool frame);
129
130         /* --------------------------------------------------------------------- */
131         /* Python interface ---------------------------------------------------- */
132         /* --------------------------------------------------------------------- */
133
134         virtual PyObject* _getattr(const STR_String& attr);
135
136         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDamp);
137         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetDamp);
138         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetRotDamp);
139         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetRotDamp);
140         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDirection);
141         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetDirection);
142         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetOption);
143         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetOption);
144         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetTime);
145         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetTime);
146         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetProperty);
147         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetProperty);
148         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMin);
149         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetMin);
150         static const char SetDistance_doc[];
151         static const char GetDistance_doc[];
152         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMax);
153         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetMax);
154         static const char SetRayLength_doc[];
155         static const char GetRayLength_doc[];
156         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetLimit);
157         KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetLimit);
158 };
159
160 #endif //__KX_CONSTRAINTACTUATOR
161