doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_SCA_DynamicActuator.h
1 // $Id$
2 //
3 // ***** BEGIN GPL LICENSE BLOCK *****
4 //
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License
7 // as published by the Free Software Foundation; either version 2
8 // of the License, or (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software Foundation,
17 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 //
19 // The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20 // All rights reserved.
21 //
22 // The Original Code is: all of this file.
23 //
24 // Contributor(s): Campbell Barton
25 //
26 // ***** END GPL LICENSE BLOCK *****
27 //
28
29 /** \file KX_SCA_DynamicActuator.h
30  *  \ingroup ketsji
31  *  \brief Add object to the game world on action of this actuator
32  */
33
34 #ifndef __KX_SCA_DYNAMICACTUATOR
35 #define __KX_SCA_DYNAMICACTUATOR
36
37 #include "SCA_IActuator.h"
38 #include "SCA_PropertyActuator.h"
39 #include "SCA_LogicManager.h"
40
41 #include "KX_GameObject.h"
42 #include "KX_IPhysicsController.h"
43
44 class KX_SCA_DynamicActuator : public SCA_IActuator
45 {
46         Py_Header;
47
48         // dynamics operation to apply to the game object
49         short m_dyn_operation;
50         float m_setmass;
51  public:
52         KX_SCA_DynamicActuator(
53                 SCA_IObject* gameobj, 
54                 short dyn_operation,
55                 float setmass
56         );
57
58         ~KX_SCA_DynamicActuator(
59         );
60
61                 CValue* 
62         GetReplica(
63         );
64
65         virtual bool 
66         Update();
67
68         //Python Interface
69         enum DynamicOperation {
70                 KX_DYN_RESTORE_DYNAMICS = 0,
71                 KX_DYN_DISABLE_DYNAMICS,
72                 KX_DYN_ENABLE_RIGID_BODY,
73                 KX_DYN_DISABLE_RIGID_BODY,
74                 KX_DYN_SET_MASS,
75         };
76 }; 
77
78 #endif