479 lines
35 KiB
HTML
479 lines
35 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>PxPruningStructure 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&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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classPxPruningStructure.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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classPxPruningStructure-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PxPruningStructure Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A precomputed pruning structure to accelerate scene queries against newly added actors.
|
|
<a href="classPxPruningStructure.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PxPruningStructure_8h_source.html">PxPruningStructure.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PxPruningStructure:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPxPruningStructure__inherit__graph.png" border="0" usemap="#PxPruningStructure_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="PxPruningStructure_inherit__map" id="PxPruningStructure_inherit__map">
|
|
<area shape="rect" id="node2" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="39,5,107,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for PxPruningStructure:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPxPruningStructure__coll__graph.png" border="0" usemap="#PxPruningStructure_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="PxPruningStructure_coll__map" id="PxPruningStructure_coll__map">
|
|
<area shape="rect" id="node2" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="48,109,116,136"/>
|
|
<area shape="rect" id="node3" href="classPxFlags.html" title="PxFlags\< PxBaseFlag\l::Enum, PxU16 \>" alt="" coords="5,5,159,47"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a1075ac464928c4f97d98e4f287b33182"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a1075ac464928c4f97d98e4f287b33182">release</a> ()=0</td></tr>
|
|
<tr class="memdesc:a1075ac464928c4f97d98e4f287b33182"><td class="mdescLeft"> </td><td class="mdescRight">Release this object. <a href="#a1075ac464928c4f97d98e4f287b33182">More...</a><br /></td></tr>
|
|
<tr class="separator:a1075ac464928c4f97d98e4f287b33182"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c930e8a4f47e3b4a3f1c5bde7f98169"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a6c930e8a4f47e3b4a3f1c5bde7f98169">getRigidActors</a> (<a class="el" href="classPxRigidActor.html">PxRigidActor</a> **userBuffer, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> bufferSize, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> startIndex=0) const =0</td></tr>
|
|
<tr class="memdesc:a6c930e8a4f47e3b4a3f1c5bde7f98169"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve rigid actors in the pruning structure. <a href="#a6c930e8a4f47e3b4a3f1c5bde7f98169">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c930e8a4f47e3b4a3f1c5bde7f98169"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a654e539a68db0ea162d54f8c5ee8c4ed"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a654e539a68db0ea162d54f8c5ee8c4ed">getNbRigidActors</a> () const =0</td></tr>
|
|
<tr class="memdesc:a654e539a68db0ea162d54f8c5ee8c4ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of rigid actors in the pruning structure. <a href="#a654e539a68db0ea162d54f8c5ee8c4ed">More...</a><br /></td></tr>
|
|
<tr class="separator:a654e539a68db0ea162d54f8c5ee8c4ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad469db86fbfab17593651ca26218842f"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#ad469db86fbfab17593651ca26218842f">getConcreteTypeName</a> () const</td></tr>
|
|
<tr class="memdesc:ad469db86fbfab17593651ca26218842f"><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#ad469db86fbfab17593651ca26218842f">More...</a><br /></td></tr>
|
|
<tr class="separator:ad469db86fbfab17593651ca26218842f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classPxBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classPxBase.html">PxBase</a></td></tr>
|
|
<tr class="memitem:a4bc720adef86ea68bfb5845f0e104d23 inherit pub_methods_classPxBase"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a4bc720adef86ea68bfb5845f0e104d23 inherit pub_methods_classPxBase"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPxBase.html#a4bc720adef86ea68bfb5845f0e104d23">is</a> ()</td></tr>
|
|
<tr class="separator:a4bc720adef86ea68bfb5845f0e104d23 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85aa50ac0e5670a2be64411fea62b5e3 inherit pub_methods_classPxBase"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a85aa50ac0e5670a2be64411fea62b5e3 inherit pub_methods_classPxBase"><td class="memTemplItemLeft" align="right" valign="top">const T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPxBase.html#a85aa50ac0e5670a2be64411fea62b5e3">is</a> () const</td></tr>
|
|
<tr class="separator:a85aa50ac0e5670a2be64411fea62b5e3 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4e0691a08e49631dc60014d49c7585f inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#ab4e0691a08e49631dc60014d49c7585f">getConcreteType</a> () const</td></tr>
|
|
<tr class="memdesc:ab4e0691a08e49631dc60014d49c7585f inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Returns concrete type of object. <a href="classPxBase.html#ab4e0691a08e49631dc60014d49c7585f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab4e0691a08e49631dc60014d49c7585f inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dd20bb574075df904e1878f2e771ef9 inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a1dd20bb574075df904e1878f2e771ef9">setBaseFlag</a> (<a class="el" href="structPxBaseFlag.html#ac258de0c7adaa37f81b6ab1b0c86a6ee">PxBaseFlag::Enum</a> flag, bool value)</td></tr>
|
|
<tr class="memdesc:a1dd20bb574075df904e1878f2e771ef9 inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Set <a class="el" href="structPxBaseFlag.html" title="Flags for PxBase. ">PxBaseFlag</a>. <a href="classPxBase.html#a1dd20bb574075df904e1878f2e771ef9">More...</a><br /></td></tr>
|
|
<tr class="separator:a1dd20bb574075df904e1878f2e771ef9 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb391b692c561df0a54c413785e4ebd0 inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#afb391b692c561df0a54c413785e4ebd0">setBaseFlags</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> inFlags)</td></tr>
|
|
<tr class="memdesc:afb391b692c561df0a54c413785e4ebd0 inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Set PxBaseFlags. <a href="classPxBase.html#afb391b692c561df0a54c413785e4ebd0">More...</a><br /></td></tr>
|
|
<tr class="separator:afb391b692c561df0a54c413785e4ebd0 inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9b10efae7733ff9c8b8d3b7d90a9a5f inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#ad9b10efae7733ff9c8b8d3b7d90a9a5f">getBaseFlags</a> () const</td></tr>
|
|
<tr class="memdesc:ad9b10efae7733ff9c8b8d3b7d90a9a5f inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Returns PxBaseFlags. <a href="classPxBase.html#ad9b10efae7733ff9c8b8d3b7d90a9a5f">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9b10efae7733ff9c8b8d3b7d90a9a5f inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38952fcb80e99f1f5dbf774a75ac2c3d inherit pub_methods_classPxBase"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a38952fcb80e99f1f5dbf774a75ac2c3d">isReleasable</a> () const</td></tr>
|
|
<tr class="memdesc:a38952fcb80e99f1f5dbf774a75ac2c3d inherit pub_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Whether the object is subordinate. <a href="classPxBase.html#a38952fcb80e99f1f5dbf774a75ac2c3d">More...</a><br /></td></tr>
|
|
<tr class="separator:a38952fcb80e99f1f5dbf774a75ac2c3d inherit pub_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a034b569b8e1db318efcb97fa3dc03020"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a034b569b8e1db318efcb97fa3dc03020">PxPruningStructure</a> (<a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="separator:a034b569b8e1db318efcb97fa3dc03020"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2123cf6d0ec8f856c4b8cdf7c3693326"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a2123cf6d0ec8f856c4b8cdf7c3693326">PxPruningStructure</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="separator:a2123cf6d0ec8f856c4b8cdf7c3693326"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d56877674adf3eaf854cd677d2b3f56"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a4d56877674adf3eaf854cd677d2b3f56">~PxPruningStructure</a> ()</td></tr>
|
|
<tr class="separator:a4d56877674adf3eaf854cd677d2b3f56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7515d78332f131fb92a15109e1b1136d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#a7515d78332f131fb92a15109e1b1136d">isKindOf</a> (const char *name) const</td></tr>
|
|
<tr class="memdesc:a7515d78332f131fb92a15109e1b1136d"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#a7515d78332f131fb92a15109e1b1136d">More...</a><br /></td></tr>
|
|
<tr class="separator:a7515d78332f131fb92a15109e1b1136d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classPxBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPxBase')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classPxBase.html">PxBase</a></td></tr>
|
|
<tr class="memitem:a263f1ef821c74058ce9335e06cb842a4 inherit pro_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a263f1ef821c74058ce9335e06cb842a4">PxBase</a> (<a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="memdesc:a263f1ef821c74058ce9335e06cb842a4 inherit pro_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Constructor setting concrete type and base flags. <a href="classPxBase.html#a263f1ef821c74058ce9335e06cb842a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a263f1ef821c74058ce9335e06cb842a4 inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58b979202e7382701f74977fe3dd5c6f inherit pro_methods_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a58b979202e7382701f74977fe3dd5c6f">PxBase</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="memdesc:a58b979202e7382701f74977fe3dd5c6f inherit pro_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Deserialization constructor setting base flags. <a href="classPxBase.html#a58b979202e7382701f74977fe3dd5c6f">More...</a><br /></td></tr>
|
|
<tr class="separator:a58b979202e7382701f74977fe3dd5c6f inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfbf62dc32775b068db1c74c7fd3d982 inherit pro_methods_classPxBase"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#adfbf62dc32775b068db1c74c7fd3d982">~PxBase</a> ()</td></tr>
|
|
<tr class="memdesc:adfbf62dc32775b068db1c74c7fd3d982 inherit pro_methods_classPxBase"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classPxBase.html#adfbf62dc32775b068db1c74c7fd3d982">More...</a><br /></td></tr>
|
|
<tr class="separator:adfbf62dc32775b068db1c74c7fd3d982 inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3782ca64c8f12c41443f604e300fc207 inherit pro_methods_classPxBase"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a3782ca64c8f12c41443f604e300fc207 inherit pro_methods_classPxBase"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPxBase.html#a3782ca64c8f12c41443f604e300fc207">typeMatch</a> () const</td></tr>
|
|
<tr class="separator:a3782ca64c8f12c41443f604e300fc207 inherit pro_methods_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_classPxBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classPxBase')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classPxBase.html">PxBase</a></td></tr>
|
|
<tr class="memitem:a1abe9d19726e1f8f8e56abeb2269b5d4 inherit pro_attribs_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#a1abe9d19726e1f8f8e56abeb2269b5d4">mConcreteType</a></td></tr>
|
|
<tr class="separator:a1abe9d19726e1f8f8e56abeb2269b5d4 inherit pro_attribs_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff7105f65905ecb9f6f7993ba28b712d inherit pro_attribs_classPxBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBase.html#aff7105f65905ecb9f6f7993ba28b712d">mBaseFlags</a></td></tr>
|
|
<tr class="separator:aff7105f65905ecb9f6f7993ba28b712d inherit pro_attribs_classPxBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A precomputed pruning structure to accelerate scene queries against newly added actors. </p>
|
|
<p>The pruning structure can be provided to <a class="el" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. ">PxScene</a>:: addActors() in which case it will get merged directly into the scene query optimization AABB tree, thus leading to improved performance when doing queries against the newly added actors. This applies to both static and dynamic actors.</p>
|
|
<dl class="section note"><dt>Note</dt><dd><a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors. ">PxPruningStructure</a> objects can be added to a collection and get serialized. </dd>
|
|
<dd>
|
|
Adding a <a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors. ">PxPruningStructure</a> object to a collection will also add the actors that were used to build the pruning structure.</dd>
|
|
<dd>
|
|
<a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors. ">PxPruningStructure</a> must be released before its rigid actors. </dd>
|
|
<dd>
|
|
<a class="el" href="classPxRigidBody.html" title="PxRigidBody is a base class shared between dynamic rigid body objects. ">PxRigidBody</a> objects can be in one <a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors. ">PxPruningStructure</a> only. </dd>
|
|
<dd>
|
|
Changing the bounds of <a class="el" href="classPxRigidBody.html" title="PxRigidBody is a base class shared between dynamic rigid body objects. ">PxRigidBody</a> objects assigned to a pruning structure that has not been added to a scene yet will invalidate the pruning structure. Same happens if shape scene query flags change or shape gets removed from an actor.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxScene.html#acaae28f21ccf233d0a9c0ad17a1ff5bd" title="Adds actors to this scene. ">PxScene::addActors</a> <a class="el" href="classPxCollection.html" title="Collection class for serialization. ">PxCollection</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a034b569b8e1db318efcb97fa3dc03020"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a034b569b8e1db318efcb97fa3dc03020">◆ </a></span>PxPruningStructure() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxPruningStructure::PxPruningStructure </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#gac1fb4b256a5d900d394e89db170a2b79">PxType</a> </td>
|
|
<td class="paramname"><em>concreteType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td>
|
|
<td class="paramname"><em>baseFlags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2123cf6d0ec8f856c4b8cdf7c3693326"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2123cf6d0ec8f856c4b8cdf7c3693326">◆ </a></span>PxPruningStructure() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxPruningStructure::PxPruningStructure </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> </td>
|
|
<td class="paramname"><em>baseFlags</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d56877674adf3eaf854cd677d2b3f56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d56877674adf3eaf854cd677d2b3f56">◆ </a></span>~PxPruningStructure()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual PxPruningStructure::~PxPruningStructure </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ad469db86fbfab17593651ca26218842f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad469db86fbfab17593651ca26218842f">◆ </a></span>getConcreteTypeName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const char* PxPruningStructure::getConcreteTypeName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns string name of dynamic type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Class name of most derived type of this object. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classPxBase.html#a67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a654e539a68db0ea162d54f8c5ee8c4ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a654e539a68db0ea162d54f8c5ee8c4ed">◆ </a></span>getNbRigidActors()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxPruningStructure::getNbRigidActors </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of rigid actors in the pruning structure. </p>
|
|
<p>You can use <a class="el" href="classPxPruningStructure.html#a6c930e8a4f47e3b4a3f1c5bde7f98169" title="Retrieve rigid actors in the pruning structure. ">getRigidActors()</a> to retrieve the rigid actor pointers.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of rigid actors in the pruning structure.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies in the physics SD...">PxRigidActor</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c930e8a4f47e3b4a3f1c5bde7f98169"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c930e8a4f47e3b4a3f1c5bde7f98169">◆ </a></span>getRigidActors()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxPruningStructure::getRigidActors </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> ** </td>
|
|
<td class="paramname"><em>userBuffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
|
|
<td class="paramname"><em>bufferSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
|
|
<td class="paramname"><em>startIndex</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieve rigid actors in the pruning structure. </p>
|
|
<p>You can retrieve the number of rigid actor pointers by calling <a class="el" href="classPxPruningStructure.html#a654e539a68db0ea162d54f8c5ee8c4ed" title="Returns the number of rigid actors in the pruning structure. ">getNbRigidActors()</a></p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">userBuffer</td><td>The buffer to store the actor pointers. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">bufferSize</td><td>Size of provided user buffer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">startIndex</td><td>Index of first actor pointer to be retrieved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of rigid actor pointers written to the buffer.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies in the physics SD...">PxRigidActor</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7515d78332f131fb92a15109e1b1136d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7515d78332f131fb92a15109e1b1136d">◆ </a></span>isKindOf()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PxPruningStructure::isKindOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>superClass</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns whether a given type name matches with the type of this instance. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classPxBase.html#addfc067afca2f67bda6c497b14424962">PxBase</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="classPxBase.html#addfc067afca2f67bda6c497b14424962">PxBase::isKindOf()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1075ac464928c4f97d98e4f287b33182"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1075ac464928c4f97d98e4f287b33182">◆ </a></span>release()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void PxPruningStructure::release </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Release this object. </p>
|
|
|
|
<p>Implements <a class="el" href="classPxBase.html#afe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="PxPruningStructure_8h_source.html">PxPruningStructure.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="classPxPruningStructure.html">PxPruningStructure</a></li>
|
|
<li class="footer">Copyright © 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>
|