dev0/PhysX4.1
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Init

Browse Source
This commit is contained in:
dev0
2025-11-28 23:13:44 +05:30
commit a3a8e79709
7360 changed files with 1156074 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

798
physx/documentation/PhysXAPI/files/classPxSerialization.html Normal file
View File

@ -0,0 +1,798 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxSerialization Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxSerialization.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classPxSerialization-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxSerialization Class Reference<div class="ingroups"><a class="el" href="group__extensions.html">Extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Utility functions for serialization.
<a href="classPxSerialization.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxSerialization_8h_source.html">PxSerialization.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html">PxXmlMiscParameter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional <a class="el" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. ">PxScene</a> and <a class="el" href="classPxPhysics.html" title="Abstract singleton factory class used for instancing objects in the Physics SDK. ">PxPhysics</a> options stored in XML serialized data. <a href="structPxSerialization_1_1PxXmlMiscParameter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad9f930bc95e3372c46bac3347742068f"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#ad9f930bc95e3372c46bac3347742068f">isSerializable</a> (<a class="el" href="classPxCollection.html">PxCollection</a> &amp;collection, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, const <a class="el" href="classPxCollection.html">PxCollection</a> *externalReferences=NULL)</td></tr>
<tr class="memdesc:ad9f930bc95e3372c46bac3347742068f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the collection is serializable with the externalReferences collection. <a href="#ad9f930bc95e3372c46bac3347742068f">More...</a><br /></td></tr>
<tr class="separator:ad9f930bc95e3372c46bac3347742068f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cf59eda36c56e9e66bac0c2b5168094"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a0cf59eda36c56e9e66bac0c2b5168094">complete</a> (<a class="el" href="classPxCollection.html">PxCollection</a> &amp;collection, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, const <a class="el" href="classPxCollection.html">PxCollection</a> *exceptFor=NULL, bool followJoints=false)</td></tr>
<tr class="memdesc:a0cf59eda36c56e9e66bac0c2b5168094"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds to a collection all objects such that it can be successfully serialized. <a href="#a0cf59eda36c56e9e66bac0c2b5168094">More...</a><br /></td></tr>
<tr class="separator:a0cf59eda36c56e9e66bac0c2b5168094"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84d55e6e21727087653a70cc20557765"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a84d55e6e21727087653a70cc20557765">createSerialObjectIds</a> (<a class="el" href="classPxCollection.html">PxCollection</a> &amp;collection, const <a class="el" href="group__common.html#gab2ccfb663643cd2d66b59908189d88cd">PxSerialObjectId</a> base)</td></tr>
<tr class="memdesc:a84d55e6e21727087653a70cc20557765"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates PxSerialObjectId values for unnamed objects in a collection. <a href="#a84d55e6e21727087653a70cc20557765">More...</a><br /></td></tr>
<tr class="separator:a84d55e6e21727087653a70cc20557765"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2eafca38332e6d7dff642641317e90a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#ae2eafca38332e6d7dff642641317e90a">createCollectionFromXml</a> (<a class="el" href="classPxInputData.html">PxInputData</a> &amp;inputData, <a class="el" href="classPxCooking.html">PxCooking</a> &amp;cooking, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, const <a class="el" href="classPxCollection.html">PxCollection</a> *externalRefs=NULL, <a class="el" href="classPxStringTable.html">PxStringTable</a> *stringTable=NULL, <a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html">PxXmlMiscParameter</a> *outArgs=NULL)</td></tr>
<tr class="memdesc:ae2eafca38332e6d7dff642641317e90a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> from XML data. <a href="#ae2eafca38332e6d7dff642641317e90a">More...</a><br /></td></tr>
<tr class="separator:ae2eafca38332e6d7dff642641317e90a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c64dc9a55f7ae9ffc8c1802855134ed"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a6c64dc9a55f7ae9ffc8c1802855134ed">createCollectionFromBinary</a> (void *memBlock, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, const <a class="el" href="classPxCollection.html">PxCollection</a> *externalRefs=NULL)</td></tr>
<tr class="memdesc:a6c64dc9a55f7ae9ffc8c1802855134ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes a <a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> from memory. <a href="#a6c64dc9a55f7ae9ffc8c1802855134ed">More...</a><br /></td></tr>
<tr class="separator:a6c64dc9a55f7ae9ffc8c1802855134ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbb99dac3e71e78338ab3eec4ab0ab75"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#acbb99dac3e71e78338ab3eec4ab0ab75">serializeCollectionToXml</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;outputStream, <a class="el" href="classPxCollection.html">PxCollection</a> &amp;collection, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, <a class="el" href="classPxCooking.html">PxCooking</a> *cooking=NULL, const <a class="el" href="classPxCollection.html">PxCollection</a> *externalRefs=NULL, <a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html">PxXmlMiscParameter</a> *inArgs=NULL)</td></tr>
<tr class="memdesc:acbb99dac3e71e78338ab3eec4ab0ab75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes a physics collection to an XML output stream. <a href="#acbb99dac3e71e78338ab3eec4ab0ab75">More...</a><br /></td></tr>
<tr class="separator:acbb99dac3e71e78338ab3eec4ab0ab75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d6242bea0c7513bfbfb24670e5cfb03"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03">serializeCollectionToBinary</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;outputStream, <a class="el" href="classPxCollection.html">PxCollection</a> &amp;collection, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, const <a class="el" href="classPxCollection.html">PxCollection</a> *externalRefs=NULL, bool exportNames=false)</td></tr>
<tr class="memdesc:a1d6242bea0c7513bfbfb24670e5cfb03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes a collection to a binary stream. <a href="#a1d6242bea0c7513bfbfb24670e5cfb03">More...</a><br /></td></tr>
<tr class="separator:a1d6242bea0c7513bfbfb24670e5cfb03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a159728a265b7ed81cd5cf329f8cad30e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a159728a265b7ed81cd5cf329f8cad30e">serializeCollectionToBinaryDeterministic</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;outputStream, <a class="el" href="classPxCollection.html">PxCollection</a> &amp;collection, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr, const <a class="el" href="classPxCollection.html">PxCollection</a> *externalRefs=NULL, bool exportNames=false)</td></tr>
<tr class="memdesc:a159728a265b7ed81cd5cf329f8cad30e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes a collection to a binary stream. <a href="#a159728a265b7ed81cd5cf329f8cad30e">More...</a><br /></td></tr>
<tr class="separator:a159728a265b7ed81cd5cf329f8cad30e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86026f68eb651de87e4a7720bc708893"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a86026f68eb651de87e4a7720bc708893">dumpBinaryMetaData</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;outputStream, <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;sr)</td></tr>
<tr class="memdesc:a86026f68eb651de87e4a7720bc708893"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dumps the binary meta-data to a stream. <a href="#a86026f68eb651de87e4a7720bc708893">More...</a><br /></td></tr>
<tr class="separator:a86026f68eb651de87e4a7720bc708893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9014b476bfd9e3e9bc7ea755df232bfd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classPxBinaryConverter.html">PxBinaryConverter</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a9014b476bfd9e3e9bc7ea755df232bfd">createBinaryConverter</a> ()</td></tr>
<tr class="memdesc:a9014b476bfd9e3e9bc7ea755df232bfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates binary converter for re-targeting binary-serialized data. <a href="#a9014b476bfd9e3e9bc7ea755df232bfd">More...</a><br /></td></tr>
<tr class="separator:a9014b476bfd9e3e9bc7ea755df232bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33d7707fb8d82862773a6b9ae1d4782e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSerialization.html#a33d7707fb8d82862773a6b9ae1d4782e">createSerializationRegistry</a> (<a class="el" href="classPxPhysics.html">PxPhysics</a> &amp;physics)</td></tr>
<tr class="memdesc:a33d7707fb8d82862773a6b9ae1d4782e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an application managed registry for serialization. <a href="#a33d7707fb8d82862773a6b9ae1d4782e">More...</a><br /></td></tr>
<tr class="separator:a33d7707fb8d82862773a6b9ae1d4782e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility functions for serialization. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0cf59eda36c56e9e66bac0c2b5168094"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cf59eda36c56e9e66bac0c2b5168094">&#9670;&nbsp;</a></span>complete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PxSerialization::complete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> &amp;&#160;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>exceptFor</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>followJoints</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds to a collection all objects such that it can be successfully serialized. </p>
<p>A collection C is complete relative to an other collection D if every object required by C is either in C or D. This function adds objects to a collection, such that it becomes complete with respect to the exceptFor collection. Completeness is needed for serialization. See <a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a>, <a class="el" href="classPxSerialization.html#acbb99dac3e71e78338ab3eec4ab0ab75" title="Serializes a physics collection to an XML output stream. ">PxSerialization::serializeCollectionToXml</a>.</p>
<p>Sdk objects require other sdk object according to the following rules:</p><ul>
<li>joints require their actors and constraint</li>
<li>rigid actors require their shapes</li>
<li>shapes require their material(s) and mesh (triangle mesh, convex mesh or height field), if any</li>
<li>articulations require their links and joints</li>
<li>aggregates require their actors</li>
</ul>
<p>If followJoints is specified another rule is added:</p><ul>
<li>actors require their joints</li>
</ul>
<p>Specifying followJoints will make whole jointed actor chains being added to the collection. Following chains is interrupted whenever a object in exceptFor is encountered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">collection</td><td>Collection which is completed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">exceptFor</td><td>Optional exemption collection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">followJoints</td><td>Specifies whether joints should be added for jointed actors </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a>, <a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a>, <a class="el" href="classPxSerialization.html#acbb99dac3e71e78338ab3eec4ab0ab75" title="Serializes a physics collection to an XML output stream. ">PxSerialization::serializeCollectionToXml</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> </dd></dl>
</div>
</div>
<a id="a9014b476bfd9e3e9bc7ea755df232bfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9014b476bfd9e3e9bc7ea755df232bfd">&#9670;&nbsp;</a></span>createBinaryConverter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classPxBinaryConverter.html">PxBinaryConverter</a>* PxSerialization::createBinaryConverter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates binary converter for re-targeting binary-serialized data. </p>
<dl class="section return"><dt>Returns</dt><dd>Binary converter instance. </dd></dl>
</div>
</div>
<a id="a6c64dc9a55f7ae9ffc8c1802855134ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c64dc9a55f7ae9ffc8c1802855134ed">&#9670;&nbsp;</a></span>createCollectionFromBinary()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classPxCollection.html">PxCollection</a>* PxSerialization::createCollectionFromBinary </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>memBlock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>externalRefs</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserializes a <a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> from memory. </p>
<p>Creates a collection from memory. If the collection has external dependencies another collection can be provided to resolve these.</p>
<p>The memory block provided has to be 128 bytes aligned and contain a contiguous serialized collection as written by <a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a>. The contained binary data needs to be compatible with the current binary format version which is defined by "PX_PHYSICS_VERSION_MAJOR.PX_PHYSICS_VERSION_MINOR.PX_PHYSICS_VERSION_BUGFIX-PX_BINARY_SERIAL_VERSION". For a list of compatible sdk releases refer to the documentation of PX_BINARY_SERIAL_VERSION.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">memBlock</td><td>Pointer to memory block containing the serialized collection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">externalRefs</td><td>Collection to resolve external dependencies</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a>, <a class="el" href="classPxSerialization.html#a0cf59eda36c56e9e66bac0c2b5168094" title="Adds to a collection all objects such that it can be successfully serialized. ">PxSerialization::complete</a>, <a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a>, <a class="el" href="group__extensions.html#gaced14ebcd90bf2d866b38867cde959ae">PX_BINARY_SERIAL_VERSION</a> </dd></dl>
</div>
</div>
<a id="ae2eafca38332e6d7dff642641317e90a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2eafca38332e6d7dff642641317e90a">&#9670;&nbsp;</a></span>createCollectionFromXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classPxCollection.html">PxCollection</a>* PxSerialization::createCollectionFromXml </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxInputData.html">PxInputData</a> &amp;&#160;</td>
<td class="paramname"><em>inputData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCooking.html">PxCooking</a> &amp;&#160;</td>
<td class="paramname"><em>cooking</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>externalRefs</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxStringTable.html">PxStringTable</a> *&#160;</td>
<td class="paramname"><em>stringTable</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html">PxXmlMiscParameter</a> *&#160;</td>
<td class="paramname"><em>outArgs</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> from XML data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputData</td><td>The input data containing the XML collection. </td></tr>
<tr><td class="paramname">cooking</td><td><a class="el" href="classPxCooking.html">PxCooking</a> instance used for sdk object instantiation. </td></tr>
<tr><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes. </td></tr>
<tr><td class="paramname">externalRefs</td><td><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> used to resolve external references. </td></tr>
<tr><td class="paramname">stringTable</td><td><a class="el" href="classPxStringTable.html" title="a table to manage strings. Strings allocated through this object are expected to be owned by this obj...">PxStringTable</a> instance used for storing object names. </td></tr>
<tr><td class="paramname">outArgs</td><td>Optional parameters of physics and scene deserialized from XML. See <a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html" title="Additional PxScene and PxPhysics options stored in XML serialized data. ">PxSerialization::PxXmlMiscParameter</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a <a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> if successful or NULL if it failed.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a>, <a class="el" href="classPxInputData.html" title="Input data class for I/O which provides random read access. ">PxInputData</a>, <a class="el" href="classPxStringTable.html" title="a table to manage strings. Strings allocated through this object are expected to be owned by this obj...">PxStringTable</a>, <a class="el" href="classPxCooking.html">PxCooking</a>, <a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html" title="Additional PxScene and PxPhysics options stored in XML serialized data. ">PxSerialization::PxXmlMiscParameter</a> </dd></dl>
</div>
</div>
<a id="a33d7707fb8d82862773a6b9ae1d4782e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33d7707fb8d82862773a6b9ae1d4782e">&#9670;&nbsp;</a></span>createSerializationRegistry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a>* PxSerialization::createSerializationRegistry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxPhysics.html">PxPhysics</a> &amp;&#160;</td>
<td class="paramname"><em>physics</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an application managed registry for serialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">physics</td><td>Physics SDK to generate create serialization registry</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> </dd></dl>
</div>
</div>
<a id="a84d55e6e21727087653a70cc20557765"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84d55e6e21727087653a70cc20557765">&#9670;&nbsp;</a></span>createSerialObjectIds()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PxSerialization::createSerialObjectIds </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> &amp;&#160;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__common.html#gab2ccfb663643cd2d66b59908189d88cd">PxSerialObjectId</a>&#160;</td>
<td class="paramname"><em>base</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates PxSerialObjectId values for unnamed objects in a collection. </p>
<p>Creates PxSerialObjectId names for unnamed objects in a collection starting at a base value and incrementing, skipping values that are already assigned to objects in the collection.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">collection</td><td>Collection for which names are created </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">base</td><td>Start address for PxSerialObjectId names </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> </dd></dl>
</div>
</div>
<a id="a86026f68eb651de87e4a7720bc708893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86026f68eb651de87e4a7720bc708893">&#9670;&nbsp;</a></span>dumpBinaryMetaData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PxSerialization::dumpBinaryMetaData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;&#160;</td>
<td class="paramname"><em>outputStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dumps the binary meta-data to a stream. </p>
<p>A meta-data file contains information about the SDK's internal classes and about custom user types ready for serialization. Such a file is needed to convert binary-serialized data from one platform to another (re-targeting). The converter needs meta-data files for the source and target platforms to perform conversions.</p>
<p>Custom user types can be supported with <a class="el" href="classPxSerializationRegistry.html#a10e39bebee808707bff3c73f01d60f07" title="Register binary meta data callback. ">PxSerializationRegistry::registerBinaryMetaDataCallback</a> (see the guide for more information).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">outputStream</td><td>Stream to write meta data to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes used for conversion.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxOutputStream.html" title="Output stream class for I/O. ">PxOutputStream</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> </dd></dl>
</div>
</div>
<a id="ad9f930bc95e3372c46bac3347742068f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9f930bc95e3372c46bac3347742068f">&#9670;&nbsp;</a></span>isSerializable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool PxSerialization::isSerializable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> &amp;&#160;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>externalReferences</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the collection is serializable with the externalReferences collection. </p>
<p>Some definitions to explain whether a collection can be serialized or not:</p>
<p>For definitions of <b>requires</b> and <b>complete</b> see <a class="el" href="classPxSerialization.html#a0cf59eda36c56e9e66bac0c2b5168094" title="Adds to a collection all objects such that it can be successfully serialized. ">PxSerialization::complete</a></p>
<p>A serializable object is <b>subordinate</b> if it cannot be serialized on its own The following objects are subordinate:</p><ul>
<li>articulation links</li>
<li>articulation joints</li>
<li>joints</li>
</ul>
<p>A collection C can be serialized with external references collection D iff</p><ul>
<li>C is complete relative to D (no dangling references)</li>
<li>Every object in D required by an object in C has a valid ID (no unnamed references)</li>
<li>Every subordinate object in C is required by another object in C (no orphans)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">collection</td><td>Collection to be checked </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">externalReferences</td><td>the external References collection </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the collection is serializable </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSerialization.html#a0cf59eda36c56e9e66bac0c2b5168094" title="Adds to a collection all objects such that it can be successfully serialized. ">PxSerialization::complete</a>, <a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a>, <a class="el" href="classPxSerialization.html#acbb99dac3e71e78338ab3eec4ab0ab75" title="Serializes a physics collection to an XML output stream. ">PxSerialization::serializeCollectionToXml</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> </dd></dl>
</div>
</div>
<a id="a1d6242bea0c7513bfbfb24670e5cfb03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d6242bea0c7513bfbfb24670e5cfb03">&#9670;&nbsp;</a></span>serializeCollectionToBinary()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool PxSerialization::serializeCollectionToBinary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;&#160;</td>
<td class="paramname"><em>outputStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> &amp;&#160;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>externalRefs</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>exportNames</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes a collection to a binary stream. </p>
<p>Serializes a collection to a stream. In order to resolve external dependencies the externalReferences collection has to be provided. Optionally names of objects that where set for example with <a class="el" href="classPxActor.html#afdcfb185892a5c8311fd0d825b0ce758" title="Sets a name string for the object that can be retrieved with getName(). ">PxActor::setName</a> are serialized along with the objects.</p>
<p>The collection can be successfully serialized if isSerializable(collection) returns true. See <a class="el" href="classPxSerialization.html#ad9f930bc95e3372c46bac3347742068f" title="Returns whether the collection is serializable with the externalReferences collection. ">isSerializable</a>.</p>
<p>The implementation of the output stream needs to fulfill the requirements on the memory block input taken by <a class="el" href="classPxSerialization.html#a6c64dc9a55f7ae9ffc8c1802855134ed" title="Deserializes a PxCollection from memory. ">PxSerialization::createCollectionFromBinary</a>.</p>
<dl class="section note"><dt>Note</dt><dd>Serialization of objects in a scene that is simultaneously being simulated is not supported and leads to undefined behavior.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">outputStream</td><td>into which the collection is serialized </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">collection</td><td>Collection to be serialized </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">externalRefs</td><td>Collection used to resolve external dependencies </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">exportNames</td><td>Specifies whether object names are serialized </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether serialization was successful</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a>, <a class="el" href="classPxOutputStream.html" title="Output stream class for I/O. ">PxOutputStream</a>, <a class="el" href="classPxSerialization.html#a0cf59eda36c56e9e66bac0c2b5168094" title="Adds to a collection all objects such that it can be successfully serialized. ">PxSerialization::complete</a>, <a class="el" href="classPxSerialization.html#a6c64dc9a55f7ae9ffc8c1802855134ed" title="Deserializes a PxCollection from memory. ">PxSerialization::createCollectionFromBinary</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> </dd></dl>
</div>
</div>
<a id="a159728a265b7ed81cd5cf329f8cad30e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a159728a265b7ed81cd5cf329f8cad30e">&#9670;&nbsp;</a></span>serializeCollectionToBinaryDeterministic()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool PxSerialization::serializeCollectionToBinaryDeterministic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;&#160;</td>
<td class="paramname"><em>outputStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> &amp;&#160;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>externalRefs</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>exportNames</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes a collection to a binary stream. </p>
<p>Convenience function that serializes a collection to a stream while rebasing memory addresses and handles to achieve a deterministic output, independent of the PhysX runtime environment the objects have been created in.</p>
<p>The same functionality can be achieved by manually</p><ul>
<li>creating a binary data stream with <a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a></li>
<li>producing the binary meta data of the current runtime platform with <a class="el" href="classPxSerialization.html#a86026f68eb651de87e4a7720bc708893" title="Dumps the binary meta-data to a stream. ">PxSerialization::dumpBinaryMetaData</a></li>
<li>converting the binary data stream with the <a class="el" href="classPxBinaryConverter.html" title="Binary converter for serialized streams. ">PxBinaryConverter</a>, using the binary meta for both source and destination</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSerialization.html#a1d6242bea0c7513bfbfb24670e5cfb03" title="Serializes a collection to a binary stream. ">PxSerialization::serializeCollectionToBinary</a>, <a class="el" href="classPxSerialization.html#a86026f68eb651de87e4a7720bc708893" title="Dumps the binary meta-data to a stream. ">PxSerialization::dumpBinaryMetaData</a>, <a class="el" href="classPxBinaryConverter.html" title="Binary converter for serialized streams. ">PxBinaryConverter</a> </dd></dl>
</div>
</div>
<a id="acbb99dac3e71e78338ab3eec4ab0ab75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbb99dac3e71e78338ab3eec4ab0ab75">&#9670;&nbsp;</a></span>serializeCollectionToXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool PxSerialization::serializeCollectionToXml </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> &amp;&#160;</td>
<td class="paramname"><em>outputStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> &amp;&#160;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxSerializationRegistry.html">PxSerializationRegistry</a> &amp;&#160;</td>
<td class="paramname"><em>sr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxCooking.html">PxCooking</a> *&#160;</td>
<td class="paramname"><em>cooking</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
<td class="paramname"><em>externalRefs</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html">PxXmlMiscParameter</a> *&#160;</td>
<td class="paramname"><em>inArgs</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes a physics collection to an XML output stream. </p>
<p>The collection to be serialized needs to be complete </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSerialization.html#a0cf59eda36c56e9e66bac0c2b5168094" title="Adds to a collection all objects such that it can be successfully serialized. ">PxSerialization.complete</a>. Optionally the XML may contain meshes in binary cooked format for fast loading. It does this when providing a valid non-null <a class="el" href="classPxCooking.html">PxCooking</a> pointer.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Serialization of objects in a scene that is simultaneously being simulated is not supported and leads to undefined behavior.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outputStream</td><td>Stream to save collection to. </td></tr>
<tr><td class="paramname">collection</td><td><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> instance which is serialized. The collection needs to be complete with respect to the externalRefs collection. </td></tr>
<tr><td class="paramname">sr</td><td><a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a> instance with information about registered classes. </td></tr>
<tr><td class="paramname">cooking</td><td>Optional pointer to cooking instance. If provided, cooked mesh data is cached for fast loading. </td></tr>
<tr><td class="paramname">externalRefs</td><td>Collection containing external references. </td></tr>
<tr><td class="paramname">inArgs</td><td>Optional parameters of physics and scene serialized to XML along with the collection. See <a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html" title="Additional PxScene and PxPhysics options stored in XML serialized data. ">PxSerialization::PxXmlMiscParameter</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the collection is successfully serialized.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a>, <a class="el" href="classPxOutputStream.html" title="Output stream class for I/O. ">PxOutputStream</a>, <a class="el" href="classPxSerializationRegistry.html" title="Class serving as a registry for XML (RepX) and binary serializable types. ">PxSerializationRegistry</a>, <a class="el" href="classPxCooking.html">PxCooking</a>, <a class="el" href="structPxSerialization_1_1PxXmlMiscParameter.html" title="Additional PxScene and PxPhysics options stored in XML serialized data. ">PxSerialization::PxXmlMiscParameter</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxSerialization_8h_source.html">PxSerialization.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classPxSerialization.html">PxSerialization</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>