doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_IpoActuator.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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file KX_IpoActuator.h
31  *  \ingroup ketsji
32  *  \brief Do an object ipo
33  */
34
35 #ifndef __KX_IPOACTUATOR
36 #define __KX_IPOACTUATOR
37
38 #include "SCA_IActuator.h"
39
40 class KX_IpoActuator : public SCA_IActuator
41 {
42         Py_Header;
43 private:
44         /** Computes the IPO start time from the current time
45             and the current frame. */
46         void SetStartTime(float curtime);
47         /** Computes the current frame from the current time
48             and the IPO start time. */
49         void SetLocalTime(float curtime);
50         /** Ensures the current frame is between the start and
51             end frames. */
52         bool ClampLocalTime();
53
54 protected:
55         bool    m_bNegativeEvent;
56
57         /** Begin frame of the ipo. */
58         float   m_startframe;
59         
60         /** End frame of the ipo. */
61         float   m_endframe;
62
63         /** Include children in the transforms? */
64         bool    m_recurse;
65
66         /** Current active frame of the ipo. */
67         float   m_localtime;
68         
69         /** The time this ipo started at. */
70         float   m_starttime;
71
72         /** play backwards or forwards? (positive means forward). */
73         float   m_direction;
74
75         /** Name of the property (only used in from_prop mode). */
76         STR_String      m_propname;
77
78         /** Name of the property where we write the current frame number */
79         STR_String      m_framepropname;
80
81         /** Interpret the ipo as a force? */
82         bool    m_ipo_as_force;
83         
84         /** Add Ipo curve to current loc/rot/scale */
85         bool    m_ipo_add;
86         
87         /** The Ipo curve is applied in local coordinates */
88         bool    m_ipo_local;
89
90         bool    m_bIpoPlaying;
91
92         /** Reset/Update the start time*/
93         void    ResetStartTime();
94
95 public:
96         enum IpoActType
97         {
98                 KX_ACT_IPO_NODEF = 0,
99                 KX_ACT_IPO_PLAY,
100                 KX_ACT_IPO_PINGPONG,
101                 KX_ACT_IPO_FLIPPER,
102                 KX_ACT_IPO_LOOPSTOP,
103                 KX_ACT_IPO_LOOPEND,
104                 KX_ACT_IPO_KEY2KEY,
105                 KX_ACT_IPO_FROM_PROP,
106                 KX_ACT_IPO_MAX
107         };
108
109 #ifdef WITH_PYTHON
110         static PyObject*        pyattr_get_frame_start(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
111         static int                      pyattr_set_frame_start(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
112         static PyObject*        pyattr_get_frame_end(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
113         static int                      pyattr_set_frame_end(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
114 #endif
115         static const char *S_KX_ACT_IPO_PLAY_STRING;
116         static const char *S_KX_ACT_IPO_PINGPONG_STRING;
117         static const char *S_KX_ACT_IPO_FLIPPER_STRING;
118         static const char *S_KX_ACT_IPO_LOOPSTOP_STRING;
119         static const char *S_KX_ACT_IPO_LOOPEND_STRING;
120         static const char *S_KX_ACT_IPO_KEY2KEY_STRING;
121         static const char *S_KX_ACT_IPO_FROM_PROP_STRING;
122
123         int string2mode(char* modename);
124         
125         int m_type;
126
127         KX_IpoActuator(SCA_IObject* gameobj,
128                                    const STR_String& propname,
129                                    const STR_String& framePropname,
130                                    float starttime,
131                                    float endtime,
132                                    bool recurse,
133                                    int acttype,
134                                    bool ipo_as_force, 
135                                    bool ipo_add,
136                                    bool ipo_local);
137         virtual ~KX_IpoActuator() {};
138
139         virtual CValue* GetReplica() {
140                 KX_IpoActuator* replica = new KX_IpoActuator(*this);//m_float,GetName());
141                 replica->ProcessReplica();
142                 return replica;
143         };
144
145         void            SetStart(float starttime);
146         void            SetEnd(float endtime);
147         virtual         bool Update(double curtime, bool frame);
148
149         /* --------------------------------------------------------------------- */
150         /* Python interface ---------------------------------------------------- */
151         /* --------------------------------------------------------------------- */
152         
153 };
154
155 #endif //__KX_IPOACTUATOR
156