Reverted incorrect merge (missing files)
[blender.git] / source / gameengine / Ketsji / KX_StateActuator.cpp
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * Actuator to toggle visibility/invisibility of objects
29  */
30
31 #include "KX_StateActuator.h"
32 #include "KX_GameObject.h"
33
34 #ifdef HAVE_CONFIG_H
35 #include <config.h>
36 #endif
37
38 KX_StateActuator::KX_StateActuator(
39         SCA_IObject* gameobj,
40         int operation,
41         unsigned int mask,
42         PyTypeObject* T
43         ) 
44         : SCA_IActuator(gameobj,T),
45           m_operation(operation),
46           m_mask(mask)
47 {
48         // intentionally empty
49 }
50
51 KX_StateActuator::~KX_StateActuator(
52         void
53         )
54 {
55         // intentionally empty
56 }
57
58 // used to put state actuator to be executed before any other actuators
59 SG_QList KX_StateActuator::m_stateActuatorHead;
60
61 CValue*
62 KX_StateActuator::GetReplica(
63         void
64         )
65 {
66         KX_StateActuator* replica = new KX_StateActuator(*this);
67         replica->ProcessReplica();
68         return replica;
69 }
70
71 bool
72 KX_StateActuator::Update()
73 {
74         bool bNegativeEvent = IsNegativeEvent();
75         unsigned int objMask;
76
77         // execution of state actuator means that we are in the execution phase, reset this pointer
78         // because all the active actuator of this object will be removed for sure.
79         m_gameobj->m_firstState = NULL;
80         RemoveAllEvents();
81         if (bNegativeEvent) return false;
82
83         KX_GameObject *obj = (KX_GameObject*) GetParent();
84         
85         objMask = obj->GetState();
86         switch (m_operation) 
87         {
88         case OP_CPY:
89                 objMask = m_mask;
90                 break;
91         case OP_SET:
92                 objMask |= m_mask;
93                 break;
94         case OP_CLR:
95                 objMask &= ~m_mask;
96                 break;
97         case OP_NEG:
98                 objMask ^= m_mask;
99                 break;
100         default:
101                 // unsupported operation, no  nothing
102                 return false;
103         }
104         obj->SetState(objMask);
105         return false;
106 }
107
108 // this function is only used to deactivate actuators outside the logic loop
109 // e.g. when an object is deleted.
110 void KX_StateActuator::Deactivate()
111 {
112         if (QDelink())
113         {
114                 // the actuator was in the active list
115                 if (m_stateActuatorHead.QEmpty())
116                         // no more state object active
117                         m_stateActuatorHead.Delink();
118         }
119 }
120
121 void KX_StateActuator::Activate(SG_DList& head)
122 {
123         // sort the state actuators per object on the global list
124         if (QEmpty())
125         {
126                 InsertSelfActiveQList(m_stateActuatorHead, &m_gameobj->m_firstState);
127                 // add front to make sure it runs before other actuators
128                 head.AddFront(&m_stateActuatorHead);
129         }
130 }
131
132
133 /* ------------------------------------------------------------------------- */
134 /* Python functions                                                          */
135 /* ------------------------------------------------------------------------- */
136
137
138
139 /* Integration hooks ------------------------------------------------------- */
140 PyTypeObject KX_StateActuator::Type = {
141 #if (PY_VERSION_HEX >= 0x02060000)
142         PyVarObject_HEAD_INIT(NULL, 0)
143 #else
144         /* python 2.5 and below */
145         PyObject_HEAD_INIT( NULL )  /* required py macro */
146         0,                          /* ob_size */
147 #endif
148         "KX_StateActuator",
149         sizeof(PyObjectPlus_Proxy),
150         0,
151         py_base_dealloc,
152         0,
153         0,
154         0,
155         0,
156         py_base_repr,
157         0,0,0,0,0,0,
158         py_base_getattro,
159         py_base_setattro,
160         0,0,0,0,0,0,0,0,0,
161         Methods
162 };
163
164 PyParentObject 
165 KX_StateActuator::Parents[] = {
166         &KX_StateActuator::Type,
167         &SCA_IActuator::Type,
168         &SCA_ILogicBrick::Type,
169         &CValue::Type,
170         NULL
171 };
172
173 PyMethodDef 
174 KX_StateActuator::Methods[] = {
175         // deprecated -->
176         {"setOperation", (PyCFunction) KX_StateActuator::sPySetOperation, 
177          METH_VARARGS, (PY_METHODCHAR)SetOperation_doc},
178         {"setMask", (PyCFunction) KX_StateActuator::sPySetMask, 
179          METH_VARARGS, (PY_METHODCHAR)SetMask_doc},
180          // <--
181         {NULL,NULL} //Sentinel
182 };
183
184 PyAttributeDef KX_StateActuator::Attributes[] = {
185         KX_PYATTRIBUTE_INT_RW("operation",KX_StateActuator::OP_NOP+1,KX_StateActuator::OP_COUNT-1,false,KX_StateActuator,m_operation),
186         KX_PYATTRIBUTE_INT_RW("mask",0,0x3FFFFFFF,false,KX_StateActuator,m_mask),
187         { NULL }        //Sentinel
188 };
189
190 PyObject* KX_StateActuator::py_getattro(PyObject *attr)
191 {
192         py_getattro_up(SCA_IActuator);
193 }
194
195 PyObject* KX_StateActuator::py_getattro_dict() {
196         py_getattro_dict_up(SCA_IActuator);
197 }
198
199 int KX_StateActuator::py_setattro(PyObject *attr, PyObject* value)
200 {
201         py_setattro_up(SCA_IActuator);
202 }
203
204
205 /* set operation ---------------------------------------------------------- */
206 const char 
207 KX_StateActuator::SetOperation_doc[] = 
208 "setOperation(op)\n"
209 "\t - op : bit operation (0=Copy, 1=Set, 2=Clear, 3=Negate)"
210 "\tSet the type of bit operation to be applied on object state mask.\n"
211 "\tUse setMask() to specify the bits that will be modified.\n";
212 PyObject* 
213
214 KX_StateActuator::PySetOperation(PyObject* args) {
215         ShowDeprecationWarning("setOperation()", "the operation property");
216         int oper;
217
218         if(!PyArg_ParseTuple(args, "i:setOperation", &oper)) {
219                 return NULL;
220         }
221
222         m_operation = oper;
223
224         Py_RETURN_NONE;
225 }
226
227 /* set mask ---------------------------------------------------------- */
228 const char 
229 KX_StateActuator::SetMask_doc[] = 
230 "setMask(mask)\n"
231 "\t - mask : bits that will be modified"
232 "\tSet the value that defines the bits that will be modified by the operation.\n"
233 "\tThe bits that are 1 in the value will be updated in the object state,\n"
234 "\tthe bits that are 0 are will be left unmodified expect for the Copy operation\n"
235 "\twhich copies the value to the object state.\n";
236 PyObject* 
237
238 KX_StateActuator::PySetMask(PyObject* args) {
239         ShowDeprecationWarning("setMask()", "the mask property");
240         int mask;
241
242         if(!PyArg_ParseTuple(args, "i:setMask", &mask)) {
243                 return NULL;
244         }
245
246         m_mask = mask;
247
248         Py_RETURN_NONE;
249 }
250
251