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
|
/**
* $Id$
*
* ***** BEGIN GPL/BL DUAL 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. The Blender
* Foundation also sells licenses for use in proprietary software under
* the Blender License. See http://www.blender.org/BL/ for information
* about this.
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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/BL DUAL LICENSE BLOCK *****
*/
#ifndef __SG_IOBJECT
#define __SG_IOBJECT
/**
base object that can be part of the scenegraph.
*/
#include <vector>
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
);
/**
* 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)
{
};
SG_Callbacks(
SG_ReplicationNewCallback repfunc,
SG_DestructionNewCallback destructfunc
):
m_replicafunc(repfunc),
m_destructionfunc(destructfunc)
{
};
SG_ReplicationNewCallback m_replicafunc;
SG_DestructionNewCallback m_destructionfunc;
};
class SG_IObject
{
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
);
/**
* 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(
);
/**
* 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.
*/
void*
GetSGClientObject(
);
const
void*
GetSGClientObject(
) const ;
/**
* 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
);
/**
* 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 :
void
ActivateReplicationCallback(
SG_IObject *replica
);
void
ActivateDestructionCallback(
);
SG_IObject(
void* clientobj,
void* clientinfo,
SG_Callbacks callbacks
);
SG_IObject(
const SG_IObject &other
);
};
#endif //__SG_IOBJECT
|
