resolved conflict state with HEAD r14096
[blender.git] / source / gameengine / SceneGraph / SG_IObject.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef __SG_IOBJECT
33 #define __SG_IOBJECT
34
35 #include <vector>
36
37 class SG_Controller;
38 class SG_IObject;
39
40 typedef std::vector<SG_Controller*> SGControllerList;
41
42 typedef void* (*SG_ReplicationNewCallback)(
43         SG_IObject* sgobject,
44         void*   clientobj,
45         void*   clientinfo
46 );
47
48 typedef void* (*SG_DestructionNewCallback)(
49         SG_IObject* sgobject,
50         void*   clientobj,
51         void*   clientinfo
52 );
53
54 typedef void  (*SG_UpdateTransformCallback)(
55         SG_IObject* sgobject,
56         void*   clientobj,
57         void*   clientinfo
58 );
59
60
61 /**
62  * SG_Callbacks hold 2 call backs to the outside world.
63  * The first is meant to be called when objects are replicated.
64  * And allows the outside world to syncronise external objects
65  * with replicated nodes and their children.
66  * The second is called when a node is detroyed and again
67  * is their for synconisation purposes
68  * These callbacks may both be NULL. 
69  * The efficacy of this approach has not been proved some 
70  * alternatives might be to perform all replication and destruction
71  * externally. 
72  * To define a class interface rather than a simple function
73  * call back so that replication information can be transmitted from 
74  * parent->child. 
75  */
76 struct  SG_Callbacks
77 {
78         SG_Callbacks(
79         ):
80                 m_replicafunc(NULL),
81                 m_destructionfunc(NULL),
82                 m_updatefunc(NULL)
83         {
84         };
85                 
86         SG_Callbacks(
87                 SG_ReplicationNewCallback repfunc,
88                 SG_DestructionNewCallback destructfunc,
89                 SG_UpdateTransformCallback updatefunc
90         ): 
91                 m_replicafunc(repfunc),
92                 m_destructionfunc(destructfunc),
93                 m_updatefunc(updatefunc)
94         {
95         };
96
97         SG_ReplicationNewCallback       m_replicafunc;
98         SG_DestructionNewCallback       m_destructionfunc;
99         SG_UpdateTransformCallback      m_updatefunc;
100 };
101
102 /**
103 base object that can be part of the scenegraph.
104 */
105 class SG_IObject
106 {
107 private :
108
109         void*   m_SGclientObject;
110         void*   m_SGclientInfo;
111         SG_Callbacks m_callbacks;
112         SGControllerList        m_SGcontrollers;
113
114 public:
115
116
117         virtual ~SG_IObject();
118
119
120         /**
121          * Add a pointer to a controller allocated on the heap, to 
122          * this node. This memory for this controller becomes the 
123          * responsibility of this class. It will be deleted when
124          * this object is deleted.
125          */
126         
127                 void                            
128         AddSGController(
129                 SG_Controller* cont
130         );
131
132         /** 
133          * Clear the array of pointers to controllers associated with 
134          * this node. This does not delete the controllers themselves!
135      * This should be used very carefully to avoid memory
136          * leaks.
137          */
138         
139                 void                            
140         RemoveAllControllers(
141         ); 
142
143         /// Needed for replication
144
145         /** 
146          * Return a reference to this node's controller list. 
147          * Whilst we don't wish to expose full control of the container
148          * to the user we do allow them to call non_const methods
149          * on pointers in the container. C++ topic: how to do this in
150          * using STL? 
151          */
152
153                 SGControllerList&       
154         GetSGControllerList(
155         );
156
157         
158         /**
159          * Get the client object associated with this
160          * node. This interface allows you to associate
161          * arbitray external objects with this node. They are
162          * passed to the callback functions when they are 
163          * activated so you can syncronise these external objects
164          * upon replication and destruction
165          * This may be NULL.
166          */
167
168                 void*                           
169         GetSGClientObject(
170         );
171
172         const 
173                 void*                   
174         GetSGClientObject(
175         ) const ;
176
177         
178         /**
179          * Set the client object for this node. This is just a 
180          * pointer to an object allocated that should exist for 
181          * the duration of the lifetime of this object, or untill
182          * this function is called again.
183          */
184         
185                 void    
186         SetSGClientObject(
187                 void* clientObject
188         );
189
190         /** 
191          * Set the current simulation time for this node.
192          * The implementation of this function runs through
193          * the nodes list of controllers and calls their SetSimulatedTime methods
194          */
195  
196                 void            
197         SetControllerTime(
198                 double time
199         );
200         
201         virtual 
202                 void            
203         Destruct(
204         ) = 0;
205
206 protected :
207
208                 void
209         ActivateReplicationCallback(
210                 SG_IObject *replica
211         );
212
213                 void
214         ActivateDestructionCallback(
215         );
216         
217                 void
218         ActivateUpdateTransformCallback(
219         );
220
221         SG_IObject(
222                 void* clientobj,
223                 void* clientinfo,
224                 SG_Callbacks callbacks
225         );
226
227         SG_IObject(
228                 const SG_IObject &other
229         );
230
231
232 };
233
234 #endif //__SG_IOBJECT
235