Python BGE API
[blender.git] / source / gameengine / Ketsji / KX_CameraActuator.h
1 /**
2  * KX_CameraActuator.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_CAMERAACTUATOR
33 #define __KX_CAMERAACTUATOR
34
35 #include "SCA_IActuator.h"
36 #include "MT_Scalar.h"
37 #include "SCA_LogicManager.h"
38
39 /**
40  * The camera actuator does a Robbie Muller prespective for you. This is a 
41  * weird set of rules that positions the camera sort of behind the object,
42  * tracking, while avoiding any objects between the 'ideal' position and the
43  * actor being tracked.
44  */
45
46
47 class KX_CameraActuator : public SCA_IActuator
48 {
49         Py_Header;
50 private :
51         /** Object that will be tracked. */
52         SCA_IObject *m_ob;
53
54         /** height (float), */
55         //const MT_Scalar m_height;
56         /** min (float), */
57         //const MT_Scalar m_minHeight;
58         /** max (float), */
59         //const MT_Scalar m_maxHeight;
60         
61         /** height (float), */
62         float m_height;
63         
64         /** min (float), */
65         float m_minHeight;
66         
67         /** max (float), */
68         float m_maxHeight;
69         
70         /** xy toggle (pick one): true == x, false == y */
71         bool m_x;
72
73         /* get the KX_IGameObject with this name */
74         CValue *findObject(char *obName);
75
76         /* parse x or y to a toggle pick */
77         bool string2axischoice(const char *axisString);
78         
79  public:
80         static STR_String X_AXIS_STRING;
81         static STR_String Y_AXIS_STRING;
82         
83         /**
84          * Set the bool toggle to true to use x lock, false for y lock
85          */
86         KX_CameraActuator(
87
88                 SCA_IObject *gameobj,
89                 //const CValue *ob,
90                 SCA_IObject *ob,
91                 float hght,
92                 float minhght,
93                 float maxhght,
94                 bool xytog,
95                 PyTypeObject* T=&Type
96
97         );
98
99
100         ~KX_CameraActuator();
101
102
103
104         /** Methods Inherited from  CValue */
105         CValue* GetReplica();
106         virtual void ProcessReplica();
107         
108
109         /** Methods inherited from SCA_IActuator */
110         virtual bool Update(
111                 double curtime,
112                 bool frame
113         );
114         virtual bool    UnlinkObject(SCA_IObject* clientobj);
115
116         /** Methods inherited from SCA_ILogicBrick */
117         virtual void    Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
118
119         /* --------------------------------------------------------------------- */
120         /* Python interface ---------------------------------------------------- */
121         /* --------------------------------------------------------------------- */
122
123         virtual PyObject* py_getattro(PyObject *attr);
124         virtual int py_setattro(PyObject *attr, PyObject* value);
125
126         /* set object to look at */
127         KX_PYMETHOD_DOC_O(KX_CameraActuator,SetObject);
128         /* get current object  */
129         KX_PYMETHOD_DOC_VARARGS(KX_CameraActuator,GetObject);
130         KX_PYMETHOD_DOC(KX_CameraActuator,SetMin);
131         KX_PYMETHOD_DOC(KX_CameraActuator,GetMin);
132         KX_PYMETHOD_DOC(KX_CameraActuator,SetMax);
133         KX_PYMETHOD_DOC(KX_CameraActuator,GetMax);
134         KX_PYMETHOD_DOC(KX_CameraActuator,SetHeight);
135         KX_PYMETHOD_DOC(KX_CameraActuator,GetHeight);
136         KX_PYMETHOD_DOC(KX_CameraActuator,SetXY);
137         KX_PYMETHOD_DOC(KX_CameraActuator,GetXY);
138
139 };
140
141 #endif //__KX_CAMERAACTUATOR
142