484b137c2f5c7a7ba58bddf3585cff045f9e69ee
[blender.git] / source / gameengine / Ketsji / KX_ParentActuator.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. The Blender
8  * Foundation also sells licenses for use in proprietary software under
9  * the Blender License.  See http://www.blender.org/BL/ for information
10  * about this.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 /** \file KX_ParentActuator.h
32  *  \ingroup ketsji
33  *  \brief Set or remove an objects parent
34  */
35
36 #ifndef __KX_PARENTACTUATOR
37 #define __KX_PARENTACTUATOR
38
39 #include "SCA_IActuator.h"
40 #include "SCA_LogicManager.h"
41
42 class KX_ParentActuator : public SCA_IActuator
43 {
44         Py_Header
45         
46         /** Mode */
47         int m_mode;
48         
49         /** option */
50         bool    m_addToCompound;
51         bool    m_ghost;
52         /** Object to set as parent */
53         SCA_IObject *m_ob;
54         
55         
56
57 public:
58         enum KX_PARENTACT_MODE
59         {
60                 KX_PARENT_NODEF = 0,
61                 KX_PARENT_SET,
62                 KX_PARENT_REMOVE,
63                 KX_PARENT_MAX
64
65         };
66
67         KX_ParentActuator(class SCA_IObject* gameobj,
68                                                 int mode,
69                                                 bool addToCompound,
70                                                 bool ghost,
71                                                 SCA_IObject *ob);
72         virtual ~KX_ParentActuator();
73         virtual bool Update();
74         
75         virtual CValue* GetReplica();
76         virtual void ProcessReplica();
77         virtual void Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);
78         virtual bool UnlinkObject(SCA_IObject* clientobj);
79         
80 #ifdef WITH_PYTHON
81
82         /* --------------------------------------------------------------------- */
83         /* Python interface ---------------------------------------------------- */
84         /* --------------------------------------------------------------------- */
85
86         /* These are used to get and set m_ob */
87         static PyObject* pyattr_get_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
88         static int pyattr_set_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
89         
90 #endif // WITH_PYTHON
91
92 }; /* end of class KX_ParentActuator : public SCA_PropertyActuator */
93
94 #endif
95