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