svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22668:22701
[blender.git] / source / gameengine / Ketsji / KX_ParentActuator.h
1 /**
2  * Set or remove an objects parent
3  *
4  *
5  * $Id$
6  *
7  * ***** BEGIN GPL LICENSE BLOCK *****
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version. The Blender
13  * Foundation also sells licenses for use in proprietary software under
14  * the Blender License.  See http://www.blender.org/BL/ for information
15  * about this.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  *
26  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
27  * All rights reserved.
28  *
29  * The Original Code is: all of this file.
30  *
31  * Contributor(s): none yet.
32  *
33  * ***** END GPL LICENSE BLOCK *****
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(GEN_Map<GEN_HashedPtr, void*> *obj_map);
78         virtual bool UnlinkObject(SCA_IObject* clientobj);
79         
80         /* --------------------------------------------------------------------- */
81         /* Python interface ---------------------------------------------------- */
82         /* --------------------------------------------------------------------- */
83
84         /* These are used to get and set m_ob */
85         static PyObject* pyattr_get_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
86         static int pyattr_set_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
87
88         // Deprecated ----->
89         KX_PYMETHOD_DOC_O(KX_ParentActuator,SetObject);
90         KX_PYMETHOD_DOC_VARARGS(KX_ParentActuator,GetObject);
91         // <-----
92         
93 }; /* end of class KX_ParentActuator : public SCA_PropertyActuator */
94
95 #endif
96