cca50be7eb074a35c9fff2fc18ab5548d4453d79
[blender.git] / source / gameengine / Ketsji / KX_ParentActuator.cpp
1 /*
2  * Set or remove an objects parent
3  *
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version. The Blender
11  * Foundation also sells licenses for use in proprietary software under
12  * the Blender License.  See http://www.blender.org/BL/ for information
13  * about this.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33
34 /** \file gameengine/Ketsji/KX_ParentActuator.cpp
35  *  \ingroup ketsji
36  */
37
38
39 #include "KX_ParentActuator.h"
40 #include "KX_GameObject.h"
41 #include "KX_PythonInit.h"
42
43 #include "PyObjectPlus.h" 
44
45 /* ------------------------------------------------------------------------- */
46 /* Native functions                                                          */
47 /* ------------------------------------------------------------------------- */
48
49 KX_ParentActuator::KX_ParentActuator(SCA_IObject *gameobj, 
50                                                                          int mode,
51                                                                          bool addToCompound,
52                                                                          bool ghost,
53                                                                          SCA_IObject *ob)
54         : SCA_IActuator(gameobj, KX_ACT_PARENT),
55           m_mode(mode),
56           m_addToCompound(addToCompound),
57           m_ghost(ghost),
58           m_ob(ob)
59 {
60         if (m_ob)
61                 m_ob->RegisterActuator(this);
62
63
64
65
66 KX_ParentActuator::~KX_ParentActuator()
67 {
68         if (m_ob)
69                 m_ob->UnregisterActuator(this);
70
71
72
73
74 CValue* KX_ParentActuator::GetReplica()
75 {
76         KX_ParentActuator* replica = new KX_ParentActuator(*this);
77         // replication just copy the m_base pointer => common random generator
78         replica->ProcessReplica();
79         return replica;
80 }
81
82 void KX_ParentActuator::ProcessReplica()
83 {
84         if (m_ob)
85                 m_ob->RegisterActuator(this);
86         SCA_IActuator::ProcessReplica();
87 }
88
89
90 bool KX_ParentActuator::UnlinkObject(SCA_IObject* clientobj)
91 {
92         if (clientobj == m_ob)
93         {
94                 // this object is being deleted, we cannot continue to track it.
95                 m_ob = NULL;
96                 return true;
97         }
98         return false;
99 }
100
101 void KX_ParentActuator::Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map)
102 {
103         void **h_obj = (*obj_map)[m_ob];
104         if (h_obj) {
105                 if (m_ob)
106                         m_ob->UnregisterActuator(this);
107                 m_ob = (SCA_IObject*)(*h_obj);
108                 m_ob->RegisterActuator(this);
109         }
110 }
111
112
113
114 bool KX_ParentActuator::Update()
115 {
116         bool bNegativeEvent = IsNegativeEvent();
117         RemoveAllEvents();
118
119         if (bNegativeEvent)
120                 return false; // do nothing on negative events
121
122         KX_GameObject *obj = (KX_GameObject*) GetParent();
123         KX_Scene *scene = KX_GetActiveScene();
124         switch (m_mode) {
125                 case KX_PARENT_SET:
126                         if (m_ob)
127                                 obj->SetParent(scene, (KX_GameObject*)m_ob, m_addToCompound, m_ghost);
128                         break;
129                 case KX_PARENT_REMOVE:
130                         obj->RemoveParent(scene);
131                         break;
132         };
133         
134         return false;
135 }
136
137 #ifdef WITH_PYTHON
138
139 /* ------------------------------------------------------------------------- */
140 /* Python functions                                                          */
141 /* ------------------------------------------------------------------------- */
142
143 /* Integration hooks ------------------------------------------------------- */
144 PyTypeObject KX_ParentActuator::Type = {
145         PyVarObject_HEAD_INIT(NULL, 0)
146         "KX_ParentActuator",
147         sizeof(PyObjectPlus_Proxy),
148         0,
149         py_base_dealloc,
150         0,
151         0,
152         0,
153         0,
154         py_base_repr,
155         0,0,0,0,0,0,0,0,0,
156         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
157         0,0,0,0,0,0,0,
158         Methods,
159         0,
160         0,
161         &SCA_IActuator::Type,
162         0,0,0,0,0,0,
163         py_base_new
164 };
165
166 PyMethodDef KX_ParentActuator::Methods[] = {
167         {NULL,NULL} //Sentinel
168 };
169
170 PyAttributeDef KX_ParentActuator::Attributes[] = {
171         KX_PYATTRIBUTE_RW_FUNCTION("object", KX_ParentActuator, pyattr_get_object, pyattr_set_object),
172         KX_PYATTRIBUTE_INT_RW("mode", KX_PARENT_NODEF+1, KX_PARENT_MAX-1, true, KX_ParentActuator, m_mode),
173         KX_PYATTRIBUTE_BOOL_RW("compound", KX_ParentActuator, m_addToCompound),
174         KX_PYATTRIBUTE_BOOL_RW("ghost", KX_ParentActuator, m_ghost),
175         { NULL }        //Sentinel
176 };
177
178 PyObject* KX_ParentActuator::pyattr_get_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
179 {
180         KX_ParentActuator* actuator = static_cast<KX_ParentActuator*>(self);
181         if (!actuator->m_ob)    
182                 Py_RETURN_NONE;
183         else
184                 return actuator->m_ob->GetProxy();
185 }
186
187 int KX_ParentActuator::pyattr_set_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
188 {
189         KX_ParentActuator* actuator = static_cast<KX_ParentActuator*>(self);
190         KX_GameObject *gameobj;
191                 
192         if (!ConvertPythonToGameObject(value, &gameobj, true, "actuator.object = value: KX_ParentActuator"))
193                 return PY_SET_ATTR_FAIL; // ConvertPythonToGameObject sets the error
194                 
195         if (actuator->m_ob != NULL)
196                 actuator->m_ob->UnregisterActuator(actuator);   
197
198         actuator->m_ob = (SCA_IObject*) gameobj;
199                 
200         if (actuator->m_ob)
201                 actuator->m_ob->RegisterActuator(actuator);
202                 
203         return PY_SET_ATTR_SUCCESS;
204 }
205
206 #endif // WITH_PYTHON
207
208 /* eof */