diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxRepXSerializer.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxRepXSerializer.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxRepXSerializer.html | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxRepXSerializer.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxRepXSerializer.html new file mode 100644 index 00000000..49050d63 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxRepXSerializer.html @@ -0,0 +1,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-2016 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> |