1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SG_IObject.h
* \ingroup bgesg
*/
#ifndef __SG_IOBJECT_H__
#define __SG_IOBJECT_H__
#include "SG_QList.h"
#include <vector>
// used for debugging: stage of the game engine main loop at which a Scenegraph modification is done
enum SG_Stage
{
SG_STAGE_UNKNOWN = 0,
SG_STAGE_NETWORK,
SG_STAGE_NETWORK_UPDATE,
SG_STAGE_PHYSICS1,
SG_STAGE_PHYSICS1_UPDATE,
SG_STAGE_CONTROLLER,
SG_STAGE_CONTROLLER_UPDATE,
SG_STAGE_ACTUATOR,
SG_STAGE_ACTUATOR_UPDATE,
SG_STAGE_ANIMATION_UPDATE,
SG_STAGE_PHYSICS2,
SG_STAGE_PHYSICS2_UPDATE,
SG_STAGE_SCENE,
SG_STAGE_RENDER,
SG_STAGE_CONVERTER,
SG_STAGE_CULLING,
SG_STAGE_MAX
};
extern SG_Stage gSG_Stage;
inline void SG_SetActiveStage(SG_Stage stage)
{
gSG_Stage = stage;
}
class SG_Controller;
class SG_IObject;
typedef std::vector<SG_Controller*> SGControllerList;
typedef void* (*SG_ReplicationNewCallback)(
SG_IObject* sgobject,
void* clientobj,
void* clientinfo
);
typedef void* (*SG_DestructionNewCallback)(
SG_IObject* sgobject,
void* clientobj,
void* clientinfo
);
typedef void (*SG_UpdateTransformCallback)(
SG_IObject* sgobject,
void* clientobj,
void* clientinfo
);
typedef bool (*SG_ScheduleUpdateCallback)(
SG_IObject* sgobject,
void* clientobj,
void* clientinfo
);
typedef bool (*SG_RescheduleUpdateCallback)(
SG_IObject* sgobject,
void* clientobj,
void* clientinfo
);
/**
* SG_Callbacks hold 2 call backs to the outside world.
* The first is meant to be called when objects are replicated.
* And allows the outside world to syncronise external objects
* with replicated nodes and their children.
* The second is called when a node is detroyed and again
* is their for synconisation purposes
* These callbacks may both be NULL.
* The efficacy of this approach has not been proved some
* alternatives might be to perform all replication and destruction
* externally.
* To define a class interface rather than a simple function
* call back so that replication information can be transmitted from
* parent->child.
*/
struct SG_Callbacks
{
SG_Callbacks(
):
m_replicafunc(NULL),
m_destructionfunc(NULL),
m_updatefunc(NULL),
m_schedulefunc(NULL),
m_reschedulefunc(NULL)
{
};
SG_Callbacks(
SG_ReplicationNewCallback repfunc,
SG_DestructionNewCallback destructfunc,
SG_UpdateTransformCallback updatefunc,
SG_ScheduleUpdateCallback schedulefunc,
SG_RescheduleUpdateCallback reschedulefunc
):
m_replicafunc(repfunc),
m_destructionfunc(destructfunc),
m_updatefunc(updatefunc),
m_schedulefunc(schedulefunc),
m_reschedulefunc(reschedulefunc)
{
};
SG_ReplicationNewCallback m_replicafunc;
SG_DestructionNewCallback m_destructionfunc;
SG_UpdateTransformCallback m_updatefunc;
SG_ScheduleUpdateCallback m_schedulefunc;
SG_RescheduleUpdateCallback m_reschedulefunc;
};
/**
base object that can be part of the scenegraph.
*/
class SG_IObject : public SG_QList
{
private :
void* m_SGclientObject;
void* m_SGclientInfo;
SG_Callbacks m_callbacks;
SGControllerList m_SGcontrollers;
public:
virtual ~SG_IObject();
/**
* Add a pointer to a controller allocated on the heap, to
* this node. This memory for this controller becomes the
* responsibility of this class. It will be deleted when
* this object is deleted.
*/
void
AddSGController(
SG_Controller* cont
);
/**
* Remove a pointer to a controller from this node.
* This does not delete the controller itself! Be careful to
* avoid memory leaks.
*/
void
RemoveSGController(
SG_Controller* cont
);
/**
* Clear the array of pointers to controllers associated with
* this node. This does not delete the controllers themselves!
* This should be used very carefully to avoid memory
* leaks.
*/
void
RemoveAllControllers(
);
/// Needed for replication
/**
* Return a reference to this node's controller list.
* Whilst we don't wish to expose full control of the container
* to the user we do allow them to call non_const methods
* on pointers in the container. C++ topic: how to do this in
* using STL?
*/
SGControllerList& GetSGControllerList()
{
return m_SGcontrollers;
}
/**
*
*/
SG_Callbacks& GetCallBackFunctions()
{
return m_callbacks;
}
/**
* Get the client object associated with this
* node. This interface allows you to associate
* arbitray external objects with this node. They are
* passed to the callback functions when they are
* activated so you can syncronise these external objects
* upon replication and destruction
* This may be NULL.
*/
inline const void* GetSGClientObject() const
{
return m_SGclientObject;
}
inline void* GetSGClientObject()
{
return m_SGclientObject;
}
/**
* Set the client object for this node. This is just a
* pointer to an object allocated that should exist for
* the duration of the lifetime of this object, or untill
* this function is called again.
*/
void SetSGClientObject(void* clientObject)
{
m_SGclientObject = clientObject;
}
/* needed for scene switching */
inline const void* GetSGClientInfo() const
{
return m_SGclientInfo;
}
inline void* GetSGClientInfo()
{
return m_SGclientInfo;
}
void SetSGClientInfo(void* clientInfo)
{
m_SGclientInfo = clientInfo;
}
/**
* Set the current simulation time for this node.
* The implementation of this function runs through
* the nodes list of controllers and calls their SetSimulatedTime methods
*/
void SetControllerTime(double time);
virtual
void
Destruct(
) = 0;
protected :
bool
ActivateReplicationCallback(
SG_IObject *replica
)
{
if (m_callbacks.m_replicafunc)
{
// Call client provided replication func
if (m_callbacks.m_replicafunc(replica,m_SGclientObject,m_SGclientInfo) == NULL)
return false;
}
return true;
}
void
ActivateDestructionCallback(
)
{
if (m_callbacks.m_destructionfunc)
{
// Call client provided destruction function on this!
m_callbacks.m_destructionfunc(this,m_SGclientObject,m_SGclientInfo);
}
else
{
// no callback but must still destroy the node to avoid memory leak
delete this;
}
}
void
ActivateUpdateTransformCallback(
)
{
if (m_callbacks.m_updatefunc)
{
// Call client provided update func.
m_callbacks.m_updatefunc(this, m_SGclientObject, m_SGclientInfo);
}
}
bool
ActivateScheduleUpdateCallback(
)
{
// HACK, this check assumes that the scheduled nodes are put on a DList (see SG_Node.h)
// The early check on Empty() allows up to avoid calling the callback function
// when the node is already scheduled for update.
if (Empty() && m_callbacks.m_schedulefunc)
{
// Call client provided update func.
return m_callbacks.m_schedulefunc(this, m_SGclientObject, m_SGclientInfo);
}
return false;
}
void
ActivateRecheduleUpdateCallback(
)
{
if (m_callbacks.m_reschedulefunc)
{
// Call client provided update func.
m_callbacks.m_reschedulefunc(this, m_SGclientObject, m_SGclientInfo);
}
}
SG_IObject(
void* clientobj,
void* clientinfo,
SG_Callbacks& callbacks
);
SG_IObject(
const SG_IObject &other
);
#ifdef WITH_CXX_GUARDEDALLOC
public:
void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:SG_IObject"); }
void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};
#endif //__SG_IOBJECT_H__
|