Patch to change license to GPL only, from GSR.
[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_MAX
47         };
48         
49         /**check whether this value is valid */
50         bool isValid(KX_ACT_PROP_MODE mode);
51         
52         int                     m_type;
53         STR_String      m_propname;
54         STR_String      m_exprtxt;
55         CValue*         m_sourceObj; // for copy property actuator
56
57 public:
58
59
60
61         SCA_PropertyActuator(
62                 SCA_IObject* gameobj,
63                 CValue* sourceObj,
64                 const STR_String& propname,
65                 const STR_String& expr,
66                 int acttype,
67                 PyTypeObject* T=&Type
68         );
69
70
71         ~SCA_PropertyActuator();
72
73                 CValue* 
74         GetReplica(
75         );
76
77         virtual bool 
78         Update();
79
80         /* --------------------------------------------------------------------- */
81         /* Python interface ---------------------------------------------------- */
82         /* --------------------------------------------------------------------- */
83
84         virtual PyObject*  _getattr(const STR_String& attr);
85
86         // python wrapped methods
87         KX_PYMETHOD_DOC(SCA_PropertyActuator,SetProperty);
88         KX_PYMETHOD_DOC(SCA_PropertyActuator,GetProperty);
89         KX_PYMETHOD_DOC(SCA_PropertyActuator,SetValue);
90         KX_PYMETHOD_DOC(SCA_PropertyActuator,GetValue);
91         
92         /* 5. - ... setObject, getObject, setProp2, getProp2, setMode, getMode*/
93         
94 };
95
96 #endif //__KX_PROPERTYACTUATOR_DOC
97