svn merge ^/trunk/blender -r41226:41227 .
[blender.git] / source / gameengine / Ketsji / KX_IPO_SGController.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
28 /** \file KX_IPO_SGController.h
29  *  \ingroup ketsji
30  */
31
32 #ifndef __IPO_SGCONTROLLER_H
33 #define __IPO_SGCONTROLLER_H
34
35 #include "SG_Controller.h"
36 #include "SG_Spatial.h"
37
38 #include "KX_IPOTransform.h"
39 #include "KX_IInterpolator.h"
40
41 #define KX_MAX_IPO_CHANNELS 19  //note- [0] is not used
42
43 class KX_IpoSGController : public SG_Controller
44 {
45         KX_IPOTransform     m_ipo_xform;
46         T_InterpolatorList  m_interpolators;
47
48         /** Flag for each IPO channel that can be applied to a game object */
49         bool                            m_ipo_channels_active[KX_MAX_IPO_CHANNELS];
50
51         /** Interpret the ipo as a force rather than a displacement? */
52         bool                m_ipo_as_force;
53
54         /** Add Ipo curve to current loc/rot/scale */
55         bool                m_ipo_add;
56
57         /** Ipo must be applied in local coordinate rather than in global coordinates (used for force and Add mode)*/
58         bool                m_ipo_local;
59         
60         /** Were settings altered since the last update? */
61         bool                            m_modified;
62
63         /** Local time of this ipo.*/
64         double                  m_ipotime;
65
66         /** Location of the object when the IPO is first fired (for local transformations) */
67         class MT_Point3         m_ipo_start_point;
68
69         /** Orientation of the object when the IPO is first fired (for local transformations) */
70         class MT_Matrix3x3      m_ipo_start_orient;
71
72         /** Scale of the object when the IPO is first fired (for local transformations) */
73         class MT_Vector3        m_ipo_start_scale;
74
75         /** if IPO initial position has been set for local normal IPO */
76         bool                            m_ipo_start_initialized;
77
78         /** Euler angles at the start of the game, needed for incomplete ROT Ipo curves */
79         class MT_Vector3        m_ipo_start_euler;
80
81         /** true is m_ipo_start_euler has been initialized */
82         bool                            m_ipo_euler_initialized;
83
84         /** A reference to the original game object. */
85         class KX_GameObject* m_game_object;
86
87 public:
88         KX_IpoSGController();
89
90         virtual ~KX_IpoSGController();
91
92         virtual SG_Controller*  GetReplica(class SG_Node* destnode);
93
94                 void
95         SetOption(
96                 int option,
97                 int value
98         );
99
100         /** Set sumo data. */
101         void UpdateSumoReference();
102         /** Set reference to the corresponding game object. */
103         void SetGameObject(class KX_GameObject*);
104
105         void SetIPOChannelActive(int index, bool value) {
106                 //indexes found in makesdna\DNA_ipo_types.h
107                 m_ipo_channels_active[index] = value;
108         }
109         
110         
111         KX_IPOTransform& GetIPOTransform()
112         {
113                 return m_ipo_xform;
114         }
115         void    AddInterpolator(KX_IInterpolator* interp);
116         virtual bool Update(double time);
117         virtual void    SetSimulatedTime(double time)
118         {
119                 m_ipotime = time;
120                 m_modified = true;
121         }
122         
123 #ifdef WITH_CXX_GUARDEDALLOC
124 public:
125         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_IpoSGController"); }
126         void operator delete( void *mem ) { MEM_freeN(mem); }
127 #endif
128 };
129
130 #endif //__IPO_SGCONTROLLER_H
131
132