Initial revision
[blender.git] / source / gameengine / Ketsji / KX_ConstraintActuator.h
1 /**
2  * KX_ConstraintActuator.h
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef __KX_CONSTRAINTACTUATOR
36 #define __KX_CONSTRAINTACTUATOR
37
38 #include "SCA_IActuator.h"
39 #include "MT_Scalar.h"
40
41
42 class KX_ConstraintActuator : public SCA_IActuator
43 {
44         Py_Header;
45         
46         // Damp time (int),
47         int m_dampTime;
48         // min (float),
49         float m_minimumBound;
50         // max (float),
51         float m_maximumBound;
52         // locrotxyz choice (pick one): only one choice allowed at a time!
53         int m_locrot;
54
55         /**
56          * Clamp <var> to <min>, <max>. Borders are included (in as far as
57          * float comparisons are good for equality...).
58          */
59         void Clamp(MT_Scalar &var, float min, float max);
60
61         
62  public:
63         enum KX_CONSTRAINTTYPE {
64                 KX_ACT_CONSTRAINT_NODEF = 0,
65                 KX_ACT_CONSTRAINT_LOCX,
66                 KX_ACT_CONSTRAINT_LOCY,
67                 KX_ACT_CONSTRAINT_LOCZ,
68                 KX_ACT_CONSTRAINT_ROTX,
69                 KX_ACT_CONSTRAINT_ROTY,
70                 KX_ACT_CONSTRAINT_ROTZ,
71                 KX_ACT_CONSTRAINT_MAX
72         };
73
74         bool IsValidMode(KX_CONSTRAINTTYPE m); 
75
76         KX_ConstraintActuator(SCA_IObject* gameobj,
77                                                   int damptime,
78                                                   float min,
79                                                   float max,
80                                                   int locrot,
81                                                   PyTypeObject* T=&Type);
82         virtual ~KX_ConstraintActuator();
83         virtual CValue* GetReplica() {
84                 KX_ConstraintActuator* replica = new KX_ConstraintActuator(*this);
85                 replica->ProcessReplica();
86                 // this will copy properties and so on...
87                 CValue::AddDataToReplica(replica);
88                 return replica;
89         };
90
91         virtual bool Update(double curtime,double deltatime);
92
93         /* --------------------------------------------------------------------- */
94         /* Python interface ---------------------------------------------------- */
95         /* --------------------------------------------------------------------- */
96
97         virtual PyObject*  _getattr(char *attr);
98
99         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDamp);
100         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetDamp);
101         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMin);
102         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetMin);
103         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMax);
104         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetMax);
105         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetLimit);
106         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetLimit);
107
108 };
109 #endif //__KX_CONSTRAINTACTUATOR