Files
PhysX4.1/physx/documentation/PhysXAPI/files/group__Serializers.html
2025-11-28 23:13:44 +05:30

267 lines
16 KiB
HTML

<!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>Serializers</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('group__Serializers.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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Serializers</div> </div>
</div><!--header-->
<div class="contents">
<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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html">PxRepXSerializer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializer interface for RepX (Xml) serialization. <a href="classPxRepXSerializer.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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga6018c37f238db16a878cfcba49091c4a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Serializers.html#ga6018c37f238db16a878cfcba49091c4a">PX_NEW_REPX_SERIALIZER</a>(T)&#160;&#160;&#160;*PX_PLACEMENT_NEW(<a class="el" href="group__foundation.html#ga2f06b47e22c6e93701d766444c67f3a6">PxGetFoundation</a>().getAllocatorCallback().allocate(sizeof(T), &quot;PxRepXSerializer&quot;, __FILE__, __LINE__ ), T)(<a class="el" href="group__foundation.html#ga2f06b47e22c6e93701d766444c67f3a6">PxGetFoundation</a>().getAllocatorCallback())</td></tr>
<tr class="memdesc:ga6018c37f238db16a878cfcba49091c4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preprocessor macro for RepX serializer creation. <a href="#ga6018c37f238db16a878cfcba49091c4a">More...</a><br /></td></tr>
<tr class="separator:ga6018c37f238db16a878cfcba49091c4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58cfb644e0a72e0f2be6624397735411"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Serializers.html#ga58cfb644e0a72e0f2be6624397735411">PX_DELETE_REPX_SERIALIZER</a>(x)&#160;&#160;&#160;{ <a class="el" href="classPxRepXSerializer.html">PxRepXSerializer</a>* s = x; if (s) { <a class="el" href="group__foundation.html#ga2f06b47e22c6e93701d766444c67f3a6">PxGetFoundation</a>().getAllocatorCallback().deallocate(s); } }</td></tr>
<tr class="memdesc:ga58cfb644e0a72e0f2be6624397735411"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preprocessor Macro to simplify RepX serializer delete. <a href="#ga58cfb644e0a72e0f2be6624397735411">More...</a><br /></td></tr>
<tr class="separator:ga58cfb644e0a72e0f2be6624397735411"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf191e298bb6922cf8a727058a7980552"><td class="memTemplParams" colspan="2">template&lt;typename TDataType &gt; </td></tr>
<tr class="memitem:gaf191e298bb6922cf8a727058a7980552"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> physx::PxRepXObject&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Serializers.html#gaf191e298bb6922cf8a727058a7980552">PxCreateRepXObject</a> (const TDataType *inType, const <a class="el" href="group__common.html#gab2ccfb663643cd2d66b59908189d88cd">physx::PxSerialObjectId</a> inId)</td></tr>
<tr class="memdesc:gaf191e298bb6922cf8a727058a7980552"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inline helper template function to create <a class="el" href="structPxRepXObject.html" title="Helper class containing the mapping of id to object, and type name. ">PxRepXObject</a> from TDataType type supporting PxTypeInfo&lt;TDataType&gt;::name. <a href="#gaf191e298bb6922cf8a727058a7980552">More...</a><br /></td></tr>
<tr class="separator:gaf191e298bb6922cf8a727058a7980552"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52eaefd69a4f9833a09892780b797a8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> physx::PxRepXObject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Serializers.html#ga52eaefd69a4f9833a09892780b797a8c">PxCreateRepXObject</a> (const physx::PxBase *inType, const <a class="el" href="group__common.html#gab2ccfb663643cd2d66b59908189d88cd">physx::PxSerialObjectId</a> inId)</td></tr>
<tr class="memdesc:ga52eaefd69a4f9833a09892780b797a8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inline helper function to create <a class="el" href="structPxRepXObject.html" title="Helper class containing the mapping of id to object, and type name. ">PxRepXObject</a> from a <a class="el" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. ">PxBase</a> instance. <a href="#ga52eaefd69a4f9833a09892780b797a8c">More...</a><br /></td></tr>
<tr class="separator:ga52eaefd69a4f9833a09892780b797a8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa245288765787cf190f85fd720e81851"><td class="memTemplParams" colspan="2">template&lt;typename TDataType &gt; </td></tr>
<tr class="memitem:gaa245288765787cf190f85fd720e81851"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> physx::PxRepXObject&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Serializers.html#gaa245288765787cf190f85fd720e81851">PxCreateRepXObject</a> (const TDataType *inType)</td></tr>
<tr class="memdesc:gaa245288765787cf190f85fd720e81851"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inline helper template function to create <a class="el" href="structPxRepXObject.html" title="Helper class containing the mapping of id to object, and type name. ">PxRepXObject</a> form TDataType type using inType pointer as a PxSerialObjectId id. <a href="#gaa245288765787cf190f85fd720e81851">More...</a><br /></td></tr>
<tr class="separator:gaa245288765787cf190f85fd720e81851"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga58cfb644e0a72e0f2be6624397735411"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58cfb644e0a72e0f2be6624397735411">&#9670;&nbsp;</a></span>PX_DELETE_REPX_SERIALIZER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PX_DELETE_REPX_SERIALIZER</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td>&#160;&#160;&#160;{ <a class="el" href="classPxRepXSerializer.html">PxRepXSerializer</a>* s = x; if (s) { <a class="el" href="group__foundation.html#ga2f06b47e22c6e93701d766444c67f3a6">PxGetFoundation</a>().getAllocatorCallback().deallocate(s); } }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Preprocessor Macro to simplify RepX serializer delete. </p>
</div>
</div>
<a id="ga6018c37f238db16a878cfcba49091c4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6018c37f238db16a878cfcba49091c4a">&#9670;&nbsp;</a></span>PX_NEW_REPX_SERIALIZER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PX_NEW_REPX_SERIALIZER</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">T</td><td>)</td>
<td>&#160;&#160;&#160;*PX_PLACEMENT_NEW(<a class="el" href="group__foundation.html#ga2f06b47e22c6e93701d766444c67f3a6">PxGetFoundation</a>().getAllocatorCallback().allocate(sizeof(T), &quot;PxRepXSerializer&quot;, __FILE__, __LINE__ ), T)(<a class="el" href="group__foundation.html#ga2f06b47e22c6e93701d766444c67f3a6">PxGetFoundation</a>().getAllocatorCallback())</td>
</tr>
</table>
</div><div class="memdoc">
<p>Preprocessor macro for RepX serializer creation. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf191e298bb6922cf8a727058a7980552"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf191e298bb6922cf8a727058a7980552">&#9670;&nbsp;</a></span>PxCreateRepXObject() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TDataType &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> physx::PxRepXObject PxCreateRepXObject </td>
<td>(</td>
<td class="paramtype">const TDataType *&#160;</td>
<td class="paramname"><em>inType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__common.html#gab2ccfb663643cd2d66b59908189d88cd">physx::PxSerialObjectId</a>&#160;</td>
<td class="paramname"><em>inId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inline helper template function to create <a class="el" href="structPxRepXObject.html" title="Helper class containing the mapping of id to object, and type name. ">PxRepXObject</a> from TDataType type supporting PxTypeInfo&lt;TDataType&gt;::name. </p>
<p class="reference">Referenced by <a class="el" href="group__Serializers.html#gaa245288765787cf190f85fd720e81851">PxCreateRepXObject()</a>.</p>
</div>
</div>
<a id="ga52eaefd69a4f9833a09892780b797a8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga52eaefd69a4f9833a09892780b797a8c">&#9670;&nbsp;</a></span>PxCreateRepXObject() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> physx::PxRepXObject PxCreateRepXObject </td>
<td>(</td>
<td class="paramtype">const physx::PxBase *&#160;</td>
<td class="paramname"><em>inType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__common.html#gab2ccfb663643cd2d66b59908189d88cd">physx::PxSerialObjectId</a>&#160;</td>
<td class="paramname"><em>inId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inline helper function to create <a class="el" href="structPxRepXObject.html" title="Helper class containing the mapping of id to object, and type name. ">PxRepXObject</a> from a <a class="el" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. ">PxBase</a> instance. </p>
<p class="reference">References <a class="el" href="group__foundation.html#ga4a83a657390b324a460f14684e5accee">PX_ASSERT</a>.</p>
</div>
</div>
<a id="gaa245288765787cf190f85fd720e81851"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa245288765787cf190f85fd720e81851">&#9670;&nbsp;</a></span>PxCreateRepXObject() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TDataType &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> physx::PxRepXObject PxCreateRepXObject </td>
<td>(</td>
<td class="paramtype">const TDataType *&#160;</td>
<td class="paramname"><em>inType</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inline helper template function to create <a class="el" href="structPxRepXObject.html" title="Helper class containing the mapping of id to object, and type name. ">PxRepXObject</a> form TDataType type using inType pointer as a PxSerialObjectId id. </p>
<p class="reference">References <a class="el" href="group__Serializers.html#gaf191e298bb6922cf8a727058a7980552">PxCreateRepXObject()</a>.</p>
</div>
</div>
</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="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>