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/classPxSerializerDefaultAdapter.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/classPxSerializerDefaultAdapter.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxSerializerDefaultAdapter.html | 402 |
1 files changed, 402 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxSerializerDefaultAdapter.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSerializerDefaultAdapter.html new file mode 100644 index 00000000..89f2a82c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSerializerDefaultAdapter.html @@ -0,0 +1,402 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSerializerDefaultAdapter< T > Class Template 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>PxSerializerDefaultAdapter< T > Class Template Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxSerializerDefaultAdapter" --><!-- doxytag: inherits="PxSerializer" -->Default <a class="el" href="classPxSerializer.html" title="Serialization interface class.">PxSerializer</a> implementation. +<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 PxSerializerDefaultAdapter< T >:</div> +<div class="dynsection"> +<p><center><img src="classPxSerializerDefaultAdapter__inherit__graph.png" border="0" usemap="#PxSerializerDefaultAdapter_3_01T_01_4__inherit__map" alt="Inheritance graph"></center> +<map name="PxSerializerDefaultAdapter_3_01T_01_4__inherit__map"> +<area shape="rect" href="classPxSerializer.html" title="Serialization interface class." alt="PxSerializer" coords="64,16,147,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxSerializerDefaultAdapter< T >:</div> +<div class="dynsection"> +<p><center><img src="classPxSerializerDefaultAdapter__coll__graph.png" border="0" usemap="#PxSerializerDefaultAdapter_3_01T_01_4__coll__map" alt="Collaboration graph"></center> +<map name="PxSerializerDefaultAdapter_3_01T_01_4__coll__map"> +<area shape="rect" href="classPxSerializer.html" title="Serialization interface class." alt="PxSerializer" coords="64,16,147,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxSerializerDefaultAdapter-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 colspan="2"><div class="groupHeader">Basics needed for Binary- and RepX-Serialization</div></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializerDefaultAdapter.html#3a59a446ea4fc277d0c224881c2f8658">PxSerializerDefaultAdapter</a> (const char *name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializerDefaultAdapter.html#eb03db4d0c9703af533696978aa72a27">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#eb03db4d0c9703af533696978aa72a27"></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="classPxSerializerDefaultAdapter.html#b5e14929bfabcb268f3e6f3e710f5657">requires</a> (<a class="el" href="classPxBase.html">PxBase</a> &obj, <a class="el" href="classPxProcessPxBaseCallback.html">PxProcessPxBaseCallback</a> &c) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds required objects to the collection. <a href="#b5e14929bfabcb268f3e6f3e710f5657"></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="classPxSerializerDefaultAdapter.html#4d038c573df687220ead4a77727b010f">isSubordinate</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the object is subordinate. <a href="#4d038c573df687220ead4a77727b010f"></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="classPxSerializerDefaultAdapter.html#268c6700a8309b22890a882c8b097717">exportExtraData</a> (<a class="el" href="classPxBase.html">PxBase</a> &obj, <a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> &s) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exports object's extra data to stream. <a href="#268c6700a8309b22890a882c8b097717"></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="classPxSerializerDefaultAdapter.html#38ddac12b78f625e8eadd2a8ea5e5dd2">exportData</a> (<a class="el" href="classPxBase.html">PxBase</a> &obj, <a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> &s) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exports object's data to stream. <a href="#38ddac12b78f625e8eadd2a8ea5e5dd2"></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="classPxSerializerDefaultAdapter.html#b6b01e18a34aa9ad330ec4602a40dedb">registerReferences</a> (<a class="el" href="classPxBase.html">PxBase</a> &obj, <a class="el" href="classPxSerializationContext.html">PxSerializationContext</a> &s) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Register references that the object maintains to other objects. <a href="#b6b01e18a34aa9ad330ec4602a40dedb"></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="classPxSerializerDefaultAdapter.html#4b95fe59d75cd8482d74211c1844ce19">getClassSize</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns size needed to create the class instance. <a href="#4b95fe59d75cd8482d74211c1844ce19"></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="classPxSerializerDefaultAdapter.html#1dfae626a47297bddf597a204c0e4d24">createObject</a> (PxU8 *&address, <a class="el" href="classPxDeserializationContext.html">PxDeserializationContext</a> &context) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object at a given address, resolve references and import extra data. <a href="#1dfae626a47297bddf597a204c0e4d24"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerializerDefaultAdapter.html#12385fd1d59f49f27aed66c91b5d647c">mTypeName</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<h3>template<class T><br> + class PxSerializerDefaultAdapter< T ></h3> + +Default <a class="el" href="classPxSerializer.html" title="Serialization interface class.">PxSerializer</a> implementation. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="3a59a446ea4fc277d0c224881c2f8658"></a><!-- doxytag: member="PxSerializerDefaultAdapter::PxSerializerDefaultAdapter" ref="3a59a446ea4fc277d0c224881c2f8658" args="(const char *name)" --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::<a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a> </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="1dfae626a47297bddf597a204c0e4d24"></a><!-- doxytag: member="PxSerializerDefaultAdapter::createObject" ref="1dfae626a47297bddf597a204c0e4d24" args="(PxU8 *&address, PxDeserializationContext &context) const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxBase.html">PxBase</a>* <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::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> [inline, 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>Implements <a class="el" href="classPxSerializer.html#1fadfa942cb290428004ef688825dfb3">PxSerializer</a>.</p> + +</div> +</div><p> +<a class="anchor" name="38ddac12b78f625e8eadd2a8ea5e5dd2"></a><!-- doxytag: member="PxSerializerDefaultAdapter::exportData" ref="38ddac12b78f625e8eadd2a8ea5e5dd2" args="(PxBase &obj, PxSerializationContext &s) const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual void <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::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> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exports object's data to stream. +<p> + +<p>Implements <a class="el" href="classPxSerializer.html#b764ac0639b0616549f934de0b31df9f">PxSerializer</a>.</p> + +<p>References <a class="el" href="classPxSerializationContext.html#2cb3cc1613a70406c2bf89ec53035a22">PxSerializationContext::writeData()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="268c6700a8309b22890a882c8b097717"></a><!-- doxytag: member="PxSerializerDefaultAdapter::exportExtraData" ref="268c6700a8309b22890a882c8b097717" args="(PxBase &obj, PxSerializationContext &s) const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual void <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::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> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exports object's extra data to stream. +<p> + +<p>Implements <a class="el" href="classPxSerializer.html#c3531178852e0c6e43519aa254ceb823">PxSerializer</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4b95fe59d75cd8482d74211c1844ce19"></a><!-- doxytag: member="PxSerializerDefaultAdapter::getClassSize" ref="4b95fe59d75cd8482d74211c1844ce19" args="() const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual size_t <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::getClassSize </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, 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>Implements <a class="el" href="classPxSerializer.html#b293fa6c552244823bbb9ab79ab3dcae">PxSerializer</a>.</p> + +</div> +</div><p> +<a class="anchor" name="eb03db4d0c9703af533696978aa72a27"></a><!-- doxytag: member="PxSerializerDefaultAdapter::getConcreteTypeName" ref="eb03db4d0c9703af533696978aa72a27" args="() const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual const char* <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::getConcreteTypeName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, 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>Implements <a class="el" href="classPxSerializer.html#b419390747f92b7f44c2bcb6d020096d">PxSerializer</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4d038c573df687220ead4a77727b010f"></a><!-- doxytag: member="PxSerializerDefaultAdapter::isSubordinate" ref="4d038c573df687220ead4a77727b010f" args="() const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual bool <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::isSubordinate </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, 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>Implements <a class="el" href="classPxSerializer.html#19e217a30a3a820cdf27cb9c7650d75d">PxSerializer</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b6b01e18a34aa9ad330ec4602a40dedb"></a><!-- doxytag: member="PxSerializerDefaultAdapter::registerReferences" ref="b6b01e18a34aa9ad330ec4602a40dedb" args="(PxBase &obj, PxSerializationContext &s) const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual void <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::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> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Register references that the object maintains to other objects. +<p> + +<p>Implements <a class="el" href="classPxSerializer.html#0352b843a22c461c9f9c3d3c6bea5b44">PxSerializer</a>.</p> + +<p>References <a class="el" href="PxAssert_8h-source.html#l00061">PX_ASSERT</a>, <a class="el" href="PxSerialFramework_8h-source.html#l00068">PX_SERIAL_REF_KIND_PXBASE</a>, and <a class="el" href="classPxSerializationContext.html#de8ef3b58a16bab4f4cbd3c04a891817">PxSerializationContext::registerReference()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b5e14929bfabcb268f3e6f3e710f5657"></a><!-- doxytag: member="PxSerializerDefaultAdapter::requires" ref="b5e14929bfabcb268f3e6f3e710f5657" args="(PxBase &obj, PxProcessPxBaseCallback &c) const " --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">virtual void <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::requires </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> [inline, 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>Implements <a class="el" href="classPxSerializer.html#c33a0599e0e780e0d0e37248bb74bcac">PxSerializer</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="12385fd1d59f49f27aed66c91b5d647c"></a><!-- doxytag: member="PxSerializerDefaultAdapter::mTypeName" ref="12385fd1d59f49f27aed66c91b5d647c" args="" --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="classPxSerializerDefaultAdapter.html">PxSerializerDefaultAdapter</a>< T >::<a class="el" href="classPxSerializerDefaultAdapter.html#12385fd1d59f49f27aed66c91b5d647c">mTypeName</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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-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> |