40136f429a2e707f38b444bd7e005728826a8474
[blender.git] / source / gameengine / Ketsji / KX_SCA_AddObjectActuator.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 /** \file KX_SCA_AddObjectActuator.h
28  *  \ingroup ketsji
29  *  \attention Previously existed as: \source\gameengine\GameLogic\SCA_AddObjectActuator.h
30  * Please look here for revision history.
31  */
32
33 #ifndef __KX_SCA_ADDOBJECTACTUATOR_H__
34 #define __KX_SCA_ADDOBJECTACTUATOR_H__
35
36 /* Actuator tree */
37 #include "SCA_IActuator.h"
38 #include "SCA_LogicManager.h"
39
40 #include "MT_Vector3.h"
41
42
43
44 class SCA_IScene;
45
46 class KX_SCA_AddObjectActuator : public SCA_IActuator
47 {
48         Py_Header
49
50         /// Time field: lifetime of the new object
51         int     m_timeProp;
52
53         /// Original object reference (object to replicate)     
54         SCA_IObject*    m_OriginalObject;
55
56         /// Object will be added to the following scene
57         SCA_IScene*     m_scene;
58
59         /// Linear velocity upon creation of the object. 
60         float  m_linear_velocity[3];
61         /// Apply the velocity locally 
62         bool m_localLinvFlag;
63         
64         /// Angular velocity upon creation of the object. 
65         float  m_angular_velocity[3];
66         /// Apply the velocity locally 
67         bool m_localAngvFlag; 
68         
69         
70         
71         
72         SCA_IObject*    m_lastCreatedObject;
73         
74 public:
75
76         /** 
77          * This class also has the default constructors
78          * available. Use with care!
79          */
80
81         KX_SCA_AddObjectActuator(
82                 SCA_IObject *gameobj,
83                 SCA_IObject *original,
84                 int time,
85                 SCA_IScene* scene,
86                 const float *linvel,
87                 bool linv_local,
88                 const float *angvel,
89                 bool angv_local
90         );
91
92         ~KX_SCA_AddObjectActuator(void);
93
94                 CValue* 
95         GetReplica(
96         );
97
98         virtual void 
99         ProcessReplica();
100
101         virtual void Replace_IScene(SCA_IScene *val)
102         {
103                 m_scene= val;
104         };
105
106         virtual bool 
107         UnlinkObject(SCA_IObject* clientobj);
108
109         virtual void 
110         Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);
111
112         virtual bool 
113         Update();
114
115                 SCA_IObject*    
116         GetLastCreatedObject(
117         ) const;
118
119         void    InstantAddObject();
120
121 #ifdef WITH_PYTHON
122
123         KX_PYMETHOD_DOC_NOARGS(KX_SCA_AddObjectActuator,InstantAddObject);
124
125         static PyObject* pyattr_get_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
126         static int pyattr_set_object(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
127         static PyObject* pyattr_get_objectLastCreated(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
128         
129 #endif // WITH_PYTHON
130
131 }; /* end of class KX_SCA_AddObjectActuator : public KX_EditObjectActuator */
132
133 #endif
134