2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / GameLogic / SCA_PropertyActuator.h
1 /**
2  * SCA_PropertyActuator.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_PROPERTYACTUATOR
33 #define __KX_PROPERTYACTUATOR
34
35 #include "SCA_IActuator.h"
36
37 class SCA_PropertyActuator : public SCA_IActuator
38 {
39         Py_Header;
40         
41         enum KX_ACT_PROP_MODE {
42                 KX_ACT_PROP_NODEF = 0,
43                 KX_ACT_PROP_ASSIGN,
44                 KX_ACT_PROP_ADD,
45                 KX_ACT_PROP_COPY,
46                 KX_ACT_PROP_TOGGLE,
47                 KX_ACT_PROP_MAX
48         };
49         
50         /**check whether this value is valid */
51         bool isValid(KX_ACT_PROP_MODE mode);
52         
53         int                     m_type;
54         STR_String      m_propname;
55         STR_String      m_exprtxt;
56         SCA_IObject* m_sourceObj; // for copy property actuator
57
58 public:
59
60
61
62         SCA_PropertyActuator(
63                 SCA_IObject* gameobj,
64                 SCA_IObject* sourceObj,
65                 const STR_String& propname,
66                 const STR_String& expr,
67                 int acttype,
68                 PyTypeObject* T=&Type
69         );
70
71
72         ~SCA_PropertyActuator();
73
74                 CValue* 
75         GetReplica(
76         );
77
78         virtual void ProcessReplica();
79         virtual bool UnlinkObject(SCA_IObject* clientobj);
80         virtual void Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
81
82         virtual bool 
83         Update();
84
85         /* --------------------------------------------------------------------- */
86         /* Python interface ---------------------------------------------------- */
87         /* --------------------------------------------------------------------- */
88
89         virtual PyObject*  py_getattro(PyObject *attr);
90         virtual int py_setattro(PyObject *attr, PyObject *value);
91
92         // python wrapped methods
93         KX_PYMETHOD_DOC(SCA_PropertyActuator,SetProperty);
94         KX_PYMETHOD_DOC(SCA_PropertyActuator,GetProperty);
95         KX_PYMETHOD_DOC(SCA_PropertyActuator,SetValue);
96         KX_PYMETHOD_DOC(SCA_PropertyActuator,GetValue);
97         
98         /* 5. - ... setObject, getObject, setProp2, getProp2, setMode, getMode*/
99         
100 };
101
102 #endif //__KX_PROPERTYACTUATOR_DOC
103