Did all of the .h's in source
[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 #ifdef HAVE_CONFIG_H
42 #include <config.h>
43 #endif
44
45
46 class KX_ConstraintActuator : public SCA_IActuator
47 {
48         Py_Header;
49         
50         // Damp time (int),
51         int m_dampTime;
52         // min (float),
53         float m_minimumBound;
54         // max (float),
55         float m_maximumBound;
56         // locrotxyz choice (pick one): only one choice allowed at a time!
57         int m_locrot;
58
59         /**
60          * Clamp <var> to <min>, <max>. Borders are included (in as far as
61          * float comparisons are good for equality...).
62          */
63         void Clamp(MT_Scalar &var, float min, float max);
64
65         
66  public:
67         enum KX_CONSTRAINTTYPE {
68                 KX_ACT_CONSTRAINT_NODEF = 0,
69                 KX_ACT_CONSTRAINT_LOCX,
70                 KX_ACT_CONSTRAINT_LOCY,
71                 KX_ACT_CONSTRAINT_LOCZ,
72                 KX_ACT_CONSTRAINT_ROTX,
73                 KX_ACT_CONSTRAINT_ROTY,
74                 KX_ACT_CONSTRAINT_ROTZ,
75                 KX_ACT_CONSTRAINT_MAX
76         };
77
78         bool IsValidMode(KX_CONSTRAINTTYPE m); 
79
80         KX_ConstraintActuator(SCA_IObject* gameobj,
81                                                   int damptime,
82                                                   float min,
83                                                   float max,
84                                                   int locrot,
85                                                   PyTypeObject* T=&Type);
86         virtual ~KX_ConstraintActuator();
87         virtual CValue* GetReplica() {
88                 KX_ConstraintActuator* replica = new KX_ConstraintActuator(*this);
89                 replica->ProcessReplica();
90                 // this will copy properties and so on...
91                 CValue::AddDataToReplica(replica);
92                 return replica;
93         };
94
95         virtual bool Update(double curtime,double deltatime);
96
97         /* --------------------------------------------------------------------- */
98         /* Python interface ---------------------------------------------------- */
99         /* --------------------------------------------------------------------- */
100
101         virtual PyObject*  _getattr(char *attr);
102
103         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDamp);
104         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetDamp);
105         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMin);
106         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetMin);
107         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMax);
108         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetMax);
109         KX_PYMETHOD_DOC(KX_ConstraintActuator,SetLimit);
110         KX_PYMETHOD_DOC(KX_ConstraintActuator,GetLimit);
111
112 };
113
114 #endif //__KX_CONSTRAINTACTUATOR
115