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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxRepXSerializer 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>PxRepXSerializer Class Reference<br>
<small>
[<a class="el" href="group__Serializers.html">Serializers</a>]</small>
</h1><!-- doxytag: class="PxRepXSerializer" -->Serializer interface for RepX (Xml) serialization.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxRepXSerializer_8h-source.html">PxRepXSerializer.h</a>></code>
<p>
<p>
<a href="classPxRepXSerializer-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 const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html#91effb5024aa5a90fbbdbf7f17eba795">getTypeName</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type this Serializer is meant to operate on. <a href="#91effb5024aa5a90fbbdbf7f17eba795"></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="classPxRepXSerializer.html#c818078a2cd3b41cdaf26ee5bf0e1f35">objectToFile</a> (const <a class="el" href="structPxRepXObject.html">PxRepXObject</a> &inLiveObject, <a class="el" href="classPxCollection.html">PxCollection</a> *inCollection, XmlWriter &inWriter, MemoryBuffer &inTempBuffer, <a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> &inArgs)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert from a RepX object to a key-value pair hierarchy. <a href="#c818078a2cd3b41cdaf26ee5bf0e1f35"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxRepXObject.html">PxRepXObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html#7855c4cc5d86b72852018f2652ac60cb">fileToObject</a> (XmlReader &inReader, XmlMemoryAllocator &inAllocator, <a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> &inArgs, <a class="el" href="classPxCollection.html">PxCollection</a> *inCollection)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert from a descriptor to a live object. Must be an object of this Serializer type. <a href="#7855c4cc5d86b72852018f2652ac60cb"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected 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="classPxRepXSerializer.html#a7d45faa6e6fb1e464249762d88b599e">~PxRepXSerializer</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Serializer interface for RepX (Xml) serialization.
<p>
In order to serialize a class to RepX both a <a class="el" href="classPxSerializer.html" title="Serialization interface class.">PxSerializer</a> and a <a class="el" href="classPxRepXSerializer.html" title="Serializer interface for RepX (Xml) serialization.">PxRepXSerializer</a> implementation are needed.<p>
A repx Serializer provides the ability to capture a live object to a descriptor or static state and the ability to write that state out to a file. Objects allocated by the Serializer using the allocator are freed when the collection itself is freed. SnRepXCoreSerializers.cpp implements a set of Serializers for the core PhysX types.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Implementing a <a class="el" href="classPxRepXSerializer.html" title="Serializer interface for RepX (Xml) serialization.">PxRepXSerializer</a> is currently not practical without including the internal PhysXExtension header "SnRepXSerializerImpl.h".</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSerializer.html" title="Serialization interface class.">PxSerializer</a>, <a class="el" href="group__Serializers.html#g6018c37f238db16a878cfcba49091c4a" title="Preprocessor macro for RepX serializer creation.">PX_NEW_REPX_SERIALIZER</a>, <a class="el" href="classPxSerializationRegistry.html#8c22f511770403078c3a0616251014e4" title="Register a RepX serializer for a concrete type.">PxSerializationRegistry::registerRepXSerializer</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a7d45faa6e6fb1e464249762d88b599e"></a><!-- doxytag: member="PxRepXSerializer::~PxRepXSerializer" ref="a7d45faa6e6fb1e464249762d88b599e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxRepXSerializer::~PxRepXSerializer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7855c4cc5d86b72852018f2652ac60cb"></a><!-- doxytag: member="PxRepXSerializer::fileToObject" ref="7855c4cc5d86b72852018f2652ac60cb" args="(XmlReader &inReader, XmlMemoryAllocator &inAllocator, PxRepXInstantiationArgs &inArgs, PxCollection *inCollection)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structPxRepXObject.html">PxRepXObject</a> PxRepXSerializer::fileToObject </td>
<td>(</td>
<td class="paramtype">XmlReader & </td>
<td class="paramname"> <em>inReader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XmlMemoryAllocator & </td>
<td class="paramname"> <em>inAllocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> & </td>
<td class="paramname"> <em>inArgs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> * </td>
<td class="paramname"> <em>inCollection</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert from a descriptor to a live object. Must be an object of this Serializer type.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inReader</em> </td><td>The inverse of the writer, a key-value pair database. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inAllocator</em> </td><td>An allocator to use for temporary allocations. These will be freed after instantiation completes. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inArgs</em> </td><td>The arguments used in create resources and objects. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inCollection</em> </td><td>The collection used to find references.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The new live object. It can be an invalid object if the instantiation cannot take place. </dd></dl>
</div>
</div><p>
<a class="anchor" name="91effb5024aa5a90fbbdbf7f17eba795"></a><!-- doxytag: member="PxRepXSerializer::getTypeName" ref="91effb5024aa5a90fbbdbf7f17eba795" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxRepXSerializer::getTypeName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The type this Serializer is meant to operate on.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxRepXObject.html#0c78e70aff2c5ede506a1279562e494a" title="Identifies the extension meant to handle this object.">PxRepXObject::typeName</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="c818078a2cd3b41cdaf26ee5bf0e1f35"></a><!-- doxytag: member="PxRepXSerializer::objectToFile" ref="c818078a2cd3b41cdaf26ee5bf0e1f35" args="(const PxRepXObject &inLiveObject, PxCollection *inCollection, XmlWriter &inWriter, MemoryBuffer &inTempBuffer, PxRepXInstantiationArgs &inArgs)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxRepXSerializer::objectToFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPxRepXObject.html">PxRepXObject</a> & </td>
<td class="paramname"> <em>inLiveObject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> * </td>
<td class="paramname"> <em>inCollection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XmlWriter & </td>
<td class="paramname"> <em>inWriter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryBuffer & </td>
<td class="paramname"> <em>inTempBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> & </td>
<td class="paramname"> <em>inArgs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert from a RepX object to a key-value pair hierarchy.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inLiveObject</em> </td><td>The object to convert to the passed in descriptor. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inCollection</em> </td><td>The collection to use to find ids of references of this object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inWriter</em> </td><td>Interface to write data to. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inTempBuffer</em> </td><td>used to for temporary allocations. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inArgs</em> </td><td>The arguments used in create resources and objects. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxRepXSerializer_8h-source.html">PxRepXSerializer.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>
|