Added an UpdateTransform callback from SceneGraph -> Physics.
[blender.git] / source / gameengine / SceneGraph / SG_ParentRelation.h
1 /**
2  * @mainpage SG_ParentRelation   
3
4  * @section 
5  * 
6  * This is an abstract interface class to the Scene Graph library. 
7  * It allows you to specify how child nodes react to parent nodes.
8  * Normally a child will use it's parent's transforms to compute
9  * it's own global transforms. How this is performed depends on
10  * the type of relation. For example if the parent is a vertex 
11  * parent to this child then the child should not inherit any 
12  * rotation information from the parent. Or if the parent is a
13  * 'slow parent' to this child then the child should react 
14  * slowly to changes in the parent's position. The exact relation
15  * is left for you to implement by filling out this interface 
16  * with concrete examples. 
17  * 
18  * There is exactly one SG_ParentRelation per SG_Node. Subclasses
19  * should not be value types and should be allocated on the heap.
20  *
21  * $Id$
22  *
23  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
24  *
25  * This program is free software; you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License
27  * as published by the Free Software Foundation; either version 2
28  * of the License, or (at your option) any later version. The Blender
29  * Foundation also sells licenses for use in proprietary software under
30  * the Blender License.  See http://www.blender.org/BL/ for information
31  * about this.
32  *
33  * This program is distributed in the hope that it will be useful,
34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36  * GNU General Public License for more details.
37  *
38  * You should have received a copy of the GNU General Public License
39  * along with this program; if not, write to the Free Software Foundation,
40  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
41  *
42  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
43  * All rights reserved.
44  *
45  * The Original Code is: all of this file.
46  *
47  * Contributor(s): none yet.
48  *
49  * ***** END GPL/BL DUAL LICENSE BLOCK *****
50  * 
51  */
52
53 #ifndef __SG_ParentRelation_h
54 #define __SG_ParentRelation_h
55
56 class SG_Spatial;
57
58 class SG_ParentRelation {
59
60 public :
61
62         /**
63          * Update the childs local and global coordinates
64          * based upon the parents global coordinates. 
65          * You must also handle the case when this node has no
66          * parent (parent == NULL). Usually you should just 
67          * copy the local coordinates of the child to the 
68          * world coordinates.
69          */ 
70         
71         virtual
72                 bool
73         UpdateChildCoordinates(
74                 SG_Spatial * child,
75                 const SG_Spatial * parent
76         ) = 0;
77
78         virtual 
79         ~SG_ParentRelation(
80         ){
81         };
82
83         /** 
84          * You must provide a way of duplicating an
85          * instance of an SG_ParentRelation. This should
86          * return a pointer to a new duplicate allocated
87          * on the heap. Responsibilty for deleting the 
88          * duplicate resides with the caller of this method.
89          */
90
91         virtual 
92                 SG_ParentRelation *
93         NewCopy(
94         ) = 0;
95
96 protected :
97
98         /** 
99          * Protected constructors 
100          * this class is not meant to be instantiated.
101          */
102
103         SG_ParentRelation(
104         ) {     
105         };
106
107         /**
108          * Copy construction should not be implemented
109          */
110
111         SG_ParentRelation(
112                 const SG_ParentRelation &
113         ); 
114 };      
115
116 #endif
117