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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSerializer Class Reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
</head>
<body bgcolor="#FFFFFF">
<div id="header">
<hr class="first">
<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
<center>
<a class="qindex" href="main.html">Main Page</a>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxSerializer Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxSerializer" -->Serialization interface class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxSerializer_8h-source.html">PxSerializer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxSerializer:</div>
<div class="dynsection">
<p><center><img src="classPxSerializer__inherit__graph.png" border="0" usemap="#PxSerializer__inherit__map" alt="Inheritance graph"></center>
<map name="PxSerializer__inherit__map">
<area shape="rect" href="classPxSerializerDefaultAdapter.html" title="Default PxSerializer implementation." alt="PxSerializerDefaultAdapter\< T \>" coords="7,85,204,107"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxSerializer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#96746551fdacb2df8da8f2887817ff5f">~PxSerializer</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Basics needed for Binary- and RepX-Serialization</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#b419390747f92b7f44c2bcb6d020096d">getConcreteTypeName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#b419390747f92b7f44c2bcb6d020096d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#f5db22cae0884acf0c53dc8f6daf719f">requiresObjects</a> (<a class="el" href="classPxBase.html">PxBase</a> &, <a class="el" href="classPxProcessPxBaseCallback.html">PxProcessPxBaseCallback</a> &) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds required objects to the collection. <a href="#f5db22cae0884acf0c53dc8f6daf719f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#19e217a30a3a820cdf27cb9c7650d75d">isSubordinate</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the object is subordinate. <a href="#19e217a30a3a820cdf27cb9c7650d75d"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functionality needed for Binary Serialization only</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#c3531178852e0c6e43519aa254ceb823">exportExtraData</a> (<a class="el" href="classPxBase.html">PxBase</a> &, <a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> &) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exports object's extra data to stream. <a href="#c3531178852e0c6e43519aa254ceb823"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#b764ac0639b0616549f934de0b31df9f">exportData</a> (<a class="el" href="classPxBase.html">PxBase</a> &, <a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> &) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exports object's data to stream. <a href="#b764ac0639b0616549f934de0b31df9f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#0352b843a22c461c9f9c3d3c6bea5b44">registerReferences</a> (<a class="el" href="classPxBase.html">PxBase</a> &obj, <a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> &s) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register references that the object maintains to other objects. <a href="#0352b843a22c461c9f9c3d3c6bea5b44"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#b293fa6c552244823bbb9ab79ab3dcae">getClassSize</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns size needed to create the class instance. <a href="#b293fa6c552244823bbb9ab79ab3dcae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxBase.html">PxBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializer.html#1fadfa942cb290428004ef688825dfb3">createObject</a> (PxU8 *&address, <a class="el" href="classPxDeserializationContext.html">PxDeserializationContext</a> &context) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object at a given address, resolve references and import extra data. <a href="#1fadfa942cb290428004ef688825dfb3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Serialization interface class.
<p>
<a class="el" href="classPxSerializer.html" title="Serialization interface class.">PxSerializer</a> is used to extend serializable <a class="el" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a> classes with serialization functionality. The interface is structured such that per-class adapter instances can be used as opposed to per-object adapter instances, avoiding per object allocations. Hence the methods take a reference to <a class="el" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a> as a parameter.<p>
The <a class="el" href="classPxSerializer.html" title="Serialization interface class.">PxSerializer</a> interface needs to be implemented for binary or RepX serialization to work on custom types. If only RepX serialization is needed, some methods can be left empty, as they are only needed for binary serialization.<p>
A default implementation is available as a template adapter (<a class="el" href="classPxSerializerDefaultAdapter.html" title="Default PxSerializer implementation.">PxSerializerDefaultAdapter</a>).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSerializerDefaultAdapter.html" title="Default PxSerializer implementation.">PxSerializerDefaultAdapter</a>, <a class="el" href="group__extensions.html#g8695b63c3fd0f8e29ecce92c64e8f79b" title="Preprocessor Macro to simplify adapter creation.">PX_NEW_SERIALIZER_ADAPTER</a>, <a class="el" href="classPxSerializationRegistry.html#bd271148a20f6ec9ed37f752ff6d7791" title="Register a serializer for a concrete type.">PxSerializationRegistry::registerSerializer</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="96746551fdacb2df8da8f2887817ff5f"></a><!-- doxytag: member="PxSerializer::~PxSerializer" ref="96746551fdacb2df8da8f2887817ff5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxSerializer::~PxSerializer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1fadfa942cb290428004ef688825dfb3"></a><!-- doxytag: member="PxSerializer::createObject" ref="1fadfa942cb290428004ef688825dfb3" args="(PxU8 *&address, PxDeserializationContext &context) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxBase.html">PxBase</a>* PxSerializer::createObject </td>
<td>(</td>
<td class="paramtype">PxU8 *& </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxDeserializationContext.html">PxDeserializationContext</a> & </td>
<td class="paramname"> <em>context</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create object at a given address, resolve references and import extra data.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>Location at which object is created. Address is increased by the size of the created object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>Context for reading external data and resolving references. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Created <a class="el" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a> pointer (needs to be identical to address before increment). </dd></dl>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#1dfae626a47297bddf597a204c0e4d24">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="b764ac0639b0616549f934de0b31df9f"></a><!-- doxytag: member="PxSerializer::exportData" ref="b764ac0639b0616549f934de0b31df9f" args="(PxBase &, PxSerializationContext &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxSerializer::exportData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxBase.html">PxBase</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Exports object's data to stream.
<p>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#38ddac12b78f625e8eadd2a8ea5e5dd2">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="c3531178852e0c6e43519aa254ceb823"></a><!-- doxytag: member="PxSerializer::exportExtraData" ref="c3531178852e0c6e43519aa254ceb823" args="(PxBase &, PxSerializationContext &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxSerializer::exportExtraData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxBase.html">PxBase</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Exports object's extra data to stream.
<p>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#268c6700a8309b22890a882c8b097717">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="b293fa6c552244823bbb9ab79ab3dcae"></a><!-- doxytag: member="PxSerializer::getClassSize" ref="b293fa6c552244823bbb9ab79ab3dcae" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t PxSerializer::getClassSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns size needed to create the class instance.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>sizeof class instance. </dd></dl>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#4b95fe59d75cd8482d74211c1844ce19">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="b419390747f92b7f44c2bcb6d020096d"></a><!-- doxytag: member="PxSerializer::getConcreteTypeName" ref="b419390747f92b7f44c2bcb6d020096d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxSerializer::getConcreteTypeName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns string name of dynamic type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#eb03db4d0c9703af533696978aa72a27">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="19e217a30a3a820cdf27cb9c7650d75d"></a><!-- doxytag: member="PxSerializer::isSubordinate" ref="19e217a30a3a820cdf27cb9c7650d75d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxSerializer::isSubordinate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Whether the object is subordinate.
<p>
A class is subordinate, if it can only be instantiated in the context of another class.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether the class is subordinate</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSerialization.html#d9f930bc95e3372c46bac3347742068f" title="Returns whether the collection is serializable with the externalReferences collection...">PxSerialization::isSerializable</a> </dd></dl>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#4d038c573df687220ead4a77727b010f">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="0352b843a22c461c9f9c3d3c6bea5b44"></a><!-- doxytag: member="PxSerializer::registerReferences" ref="0352b843a22c461c9f9c3d3c6bea5b44" args="(PxBase &obj, PxSerializationContext &s) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxSerializer::registerReferences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxBase.html">PxBase</a> & </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> & </td>
<td class="paramname"> <em>s</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register references that the object maintains to other objects.
<p>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#b6b01e18a34aa9ad330ec4602a40dedb">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<a class="anchor" name="f5db22cae0884acf0c53dc8f6daf719f"></a><!-- doxytag: member="PxSerializer::requiresObjects" ref="f5db22cae0884acf0c53dc8f6daf719f" args="(PxBase &, PxProcessPxBaseCallback &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxSerializer::requiresObjects </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxBase.html">PxBase</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxProcessPxBaseCallback.html">PxProcessPxBaseCallback</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds required objects to the collection.
<p>
This method does not add the required objects recursively, e.g. objects required by required objects.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization.">PxCollection</a>, <a class="el" href="classPxSerialization.html#0cf59eda36c56e9e66bac0c2b5168094" title="Adds to a collection all objects such that it can be successfully serialized.">PxSerialization::complete</a> </dd></dl>
<p>Implemented in <a class="el" href="classPxSerializerDefaultAdapter.html#4103e81d09d3aaab2bb9fd3e236331bc">PxSerializerDefaultAdapter< T ></a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxSerializer_8h-source.html">PxSerializer.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>
|