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