svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22625:22668
[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         ) 
43         : SCA_IActuator(gameobj),
44           m_operation(operation),
45           m_mask(mask)
46 {
47         // intentionally empty
48 }
49
50 KX_StateActuator::~KX_StateActuator(
51         void
52         )
53 {
54         // intentionally empty
55 }
56
57 // used to put state actuator to be executed before any other actuators
58 SG_QList KX_StateActuator::m_stateActuatorHead;
59
60 CValue*
61 KX_StateActuator::GetReplica(
62         void
63         )
64 {
65         KX_StateActuator* replica = new KX_StateActuator(*this);
66         replica->ProcessReplica();
67         return replica;
68 }
69
70 bool
71 KX_StateActuator::Update()
72 {
73         bool bNegativeEvent = IsNegativeEvent();
74         unsigned int objMask;
75
76         // execution of state actuator means that we are in the execution phase, reset this pointer
77         // because all the active actuator of this object will be removed for sure.
78         m_gameobj->m_firstState = NULL;
79         RemoveAllEvents();
80         if (bNegativeEvent) return false;
81
82         KX_GameObject *obj = (KX_GameObject*) GetParent();
83         
84         objMask = obj->GetState();
85         switch (m_operation) 
86         {
87         case OP_CPY:
88                 objMask = m_mask;
89                 break;
90         case OP_SET:
91                 objMask |= m_mask;
92                 break;
93         case OP_CLR:
94                 objMask &= ~m_mask;
95                 break;
96         case OP_NEG:
97                 objMask ^= m_mask;
98                 break;
99         default:
100                 // unsupported operation, no  nothing
101                 return false;
102         }
103         obj->SetState(objMask);
104         return false;
105 }
106
107 // this function is only used to deactivate actuators outside the logic loop
108 // e.g. when an object is deleted.
109 void KX_StateActuator::Deactivate()
110 {
111         if (QDelink())
112         {
113                 // the actuator was in the active list
114                 if (m_stateActuatorHead.QEmpty())
115                         // no more state object active
116                         m_stateActuatorHead.Delink();
117         }
118 }
119
120 void KX_StateActuator::Activate(SG_DList& head)
121 {
122         // sort the state actuators per object on the global list
123         if (QEmpty())
124         {
125                 InsertSelfActiveQList(m_stateActuatorHead, &m_gameobj->m_firstState);
126                 // add front to make sure it runs before other actuators
127                 head.AddFront(&m_stateActuatorHead);
128         }
129 }
130
131
132 /* ------------------------------------------------------------------------- */
133 /* Python functions                                                          */
134 /* ------------------------------------------------------------------------- */
135
136
137
138 /* Integration hooks ------------------------------------------------------- */
139 PyTypeObject KX_StateActuator::Type = {
140         PyVarObject_HEAD_INIT(NULL, 0)
141         "KX_StateActuator",
142         sizeof(PyObjectPlus_Proxy),
143         0,
144         py_base_dealloc,
145         0,
146         0,
147         0,
148         0,
149         py_base_repr,
150         0,0,0,0,0,0,0,0,0,
151         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
152         0,0,0,0,0,0,0,
153         Methods,
154         0,
155         0,
156         &SCA_IActuator::Type,
157         0,0,0,0,0,0,
158         py_base_new
159 };
160
161 PyMethodDef KX_StateActuator::Methods[] = {
162         // deprecated -->
163         {"setOperation", (PyCFunction) KX_StateActuator::sPySetOperation, 
164          METH_VARARGS, (const char *)SetOperation_doc},
165         {"setMask", (PyCFunction) KX_StateActuator::sPySetMask, 
166          METH_VARARGS, (const char *)SetMask_doc},
167          // <--
168         {NULL,NULL} //Sentinel
169 };
170
171 PyAttributeDef KX_StateActuator::Attributes[] = {
172         KX_PYATTRIBUTE_INT_RW("operation",KX_StateActuator::OP_NOP+1,KX_StateActuator::OP_COUNT-1,false,KX_StateActuator,m_operation),
173         KX_PYATTRIBUTE_INT_RW("mask",0,0x3FFFFFFF,false,KX_StateActuator,m_mask),
174         { NULL }        //Sentinel
175 };
176
177
178 /* set operation ---------------------------------------------------------- */
179 const char 
180 KX_StateActuator::SetOperation_doc[] = 
181 "setOperation(op)\n"
182 "\t - op : bit operation (0=Copy, 1=Set, 2=Clear, 3=Negate)"
183 "\tSet the type of bit operation to be applied on object state mask.\n"
184 "\tUse setMask() to specify the bits that will be modified.\n";
185 PyObject* 
186
187 KX_StateActuator::PySetOperation(PyObject* args) {
188         ShowDeprecationWarning("setOperation()", "the operation property");
189         int oper;
190
191         if(!PyArg_ParseTuple(args, "i:setOperation", &oper)) {
192                 return NULL;
193         }
194
195         m_operation = oper;
196
197         Py_RETURN_NONE;
198 }
199
200 /* set mask ---------------------------------------------------------- */
201 const char 
202 KX_StateActuator::SetMask_doc[] = 
203 "setMask(mask)\n"
204 "\t - mask : bits that will be modified"
205 "\tSet the value that defines the bits that will be modified by the operation.\n"
206 "\tThe bits that are 1 in the value will be updated in the object state,\n"
207 "\tthe bits that are 0 are will be left unmodified expect for the Copy operation\n"
208 "\twhich copies the value to the object state.\n";
209 PyObject* 
210
211 KX_StateActuator::PySetMask(PyObject* args) {
212         ShowDeprecationWarning("setMask()", "the mask property");
213         int mask;
214
215         if(!PyArg_ParseTuple(args, "i:setMask", &mask)) {
216                 return NULL;
217         }
218
219         m_mask = mask;
220
221         Py_RETURN_NONE;
222 }
223
224