Added an UpdateTransform callback from SceneGraph -> Physics.
[blender.git] / source / gameengine / Ketsji / KX_SG_NodeRelationships.h
1 /**
2  * @mainpage KX_SG_NodeRelationships   
3
4  * @section 
5  *
6  * This file provides common concrete implementations of 
7  * SG_ParentRelation used by the game engine. These are
8  * KX_SlowParentRelation a slow parent relationship.
9  * KX_NormalParentRelation a normal parent relationship where 
10  * orientation and position are inherited from the parent by
11  * the child.
12  * KX_VertexParentRelation only location information is 
13  * inherited by the child. 
14  *
15  * @see SG_ParentRelation for more information about this 
16  * interface      
17  *
18  * $Id$
19  *
20  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
21  *
22  * This program is free software; you can redistribute it and/or
23  * modify it under the terms of the GNU General Public License
24  * as published by the Free Software Foundation; either version 2
25  * of the License, or (at your option) any later version. The Blender
26  * Foundation also sells licenses for use in proprietary software under
27  * the Blender License.  See http://www.blender.org/BL/ for information
28  * about this.
29  *
30  * This program is distributed in the hope that it will be useful,
31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33  * GNU General Public License for more details.
34  *
35  * You should have received a copy of the GNU General Public License
36  * along with this program; if not, write to the Free Software Foundation,
37  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
38  *
39  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
40  * All rights reserved.
41  *
42  * The Original Code is: all of this file.
43  *
44  * Contributor(s): none yet.
45  *
46  * ***** END GPL/BL DUAL LICENSE BLOCK *****
47  * 
48  */
49
50 #include "SG_Spatial.h"
51 #include "SG_ParentRelation.h"
52
53 class KX_NormalParentRelation : public SG_ParentRelation
54 {
55
56 public :
57
58         /**
59          * Allocate and construct a new KX_NormalParentRelation
60          * on the heap.
61          */
62
63         static 
64                 KX_NormalParentRelation *
65         New(
66         );              
67
68         /** 
69          * Method inherited from KX_ParentRelation
70          */
71
72                 bool
73         UpdateChildCoordinates(
74                 SG_Spatial * child,
75                 const SG_Spatial * parent
76         );
77
78         /** 
79          * Method inherited from KX_ParentRelation
80          */
81         
82                 SG_ParentRelation *
83         NewCopy(
84         );
85
86         ~KX_NormalParentRelation(
87         );
88
89 private :
90
91         KX_NormalParentRelation(
92         );
93
94 };
95
96
97 class KX_VertexParentRelation : public SG_ParentRelation
98 {
99
100 public :
101
102         /**
103          * Allocate and construct a new KX_VertexParentRelation
104          * on the heap.
105          */
106
107         static 
108                 KX_VertexParentRelation *
109         New(
110         );              
111
112         /** 
113          * Method inherited from KX_ParentRelation
114          */
115
116                 bool
117         UpdateChildCoordinates(
118                 SG_Spatial * child,
119                 const SG_Spatial * parent
120         );
121
122         /** 
123          * Method inherited from KX_ParentRelation
124          */
125         
126                 SG_ParentRelation *
127         NewCopy(
128         );
129
130         ~KX_VertexParentRelation(
131         );
132
133 private :
134
135         KX_VertexParentRelation(
136         );
137
138 };
139
140
141 class KX_SlowParentRelation : public SG_ParentRelation
142 {
143
144 public :
145
146         /**
147          * Allocate and construct a new KX_VertexParentRelation
148          * on the heap.
149          */
150
151         static 
152                 KX_SlowParentRelation *
153         New(
154                 MT_Scalar relaxation
155         );              
156
157         /** 
158          * Method inherited from KX_ParentRelation
159          */
160
161                 bool
162         UpdateChildCoordinates(
163                 SG_Spatial * child,
164                 const SG_Spatial * parent
165         );
166
167         /** 
168          * Method inherited from KX_ParentRelation
169          */
170         
171                 SG_ParentRelation *
172         NewCopy(
173         );
174
175         ~KX_SlowParentRelation(
176         );
177
178 private :
179
180         KX_SlowParentRelation(
181                 MT_Scalar relaxation
182         );
183
184         // the relaxation coefficient.
185
186         MT_Scalar m_relax;
187
188         /**
189          * Looks like a hack flag to me.
190          * We need to compute valid world coordinates the first
191          * time we update spatial data of the child. This is done
192          * by just doing a normal parent relation the first time
193          * UpdateChildCoordinates is called and then doing the
194          * slow parent relation 
195          */
196
197         bool m_initialized;
198
199 };
200