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