svn merge -r 13452:14721 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / gameengine / Ketsji / KX_ParentActuator.h
1 /**
2  * Set or remove an objects parent
3  *
4  *
5  * $Id: KX_ParentActuator.h 3271 2004-10-16 11:41:50Z kester $
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         /** Object to set as parent */
50         CValue *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
61         };
62  
63         KX_ParentActuator(class SCA_IObject* gameobj,
64                                                 int mode,
65                                                 CValue *ob,
66                                                 PyTypeObject* T=&Type);
67         virtual ~KX_ParentActuator();
68         virtual bool Update();
69         
70         virtual CValue* GetReplica();
71         
72         /* --------------------------------------------------------------------- */
73         /* Python interface ---------------------------------------------------- */
74         /* --------------------------------------------------------------------- */
75
76         virtual PyObject* _getattr(const STR_String& attr);
77
78         /* 1. setObject                                                            */
79         KX_PYMETHOD_DOC(KX_ParentActuator,SetObject);
80         /* 2. getObject                                                            */
81         KX_PYMETHOD_DOC(KX_ParentActuator,GetObject);
82         
83 }; /* end of class KX_ParentActuator : public SCA_PropertyActuator */
84
85 #endif
86