737 lines
49 KiB
HTML
737 lines
49 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>PxAggregate 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('classPxAggregate.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="classPxAggregate-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PxAggregate 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>Class to aggregate actors into a single broad-phase entry.
|
|
<a href="classPxAggregate.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PxAggregate_8h_source.html">PxAggregate.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PxAggregate:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPxAggregate__inherit__graph.png" border="0" usemap="#PxAggregate_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="PxAggregate_inherit__map" id="PxAggregate_inherit__map">
|
|
<area shape="rect" id="node2" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="20,5,88,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for PxAggregate:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPxAggregate__coll__graph.png" border="0" usemap="#PxAggregate_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="PxAggregate_coll__map" id="PxAggregate_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:a4e49bed771f4c7804dfac6882c2af273"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a4e49bed771f4c7804dfac6882c2af273">release</a> ()=0</td></tr>
|
|
<tr class="memdesc:a4e49bed771f4c7804dfac6882c2af273"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the aggregate object. <a href="#a4e49bed771f4c7804dfac6882c2af273">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e49bed771f4c7804dfac6882c2af273"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7072365e9d3fe7a2de85753ebbf8df23"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a7072365e9d3fe7a2de85753ebbf8df23">addActor</a> (<a class="el" href="classPxActor.html">PxActor</a> &actor, const <a class="el" href="classPxBVHStructure.html">PxBVHStructure</a> *bvhStructure=NULL)=0</td></tr>
|
|
<tr class="memdesc:a7072365e9d3fe7a2de85753ebbf8df23"><td class="mdescLeft"> </td><td class="mdescRight">Adds an actor to the aggregate object. <a href="#a7072365e9d3fe7a2de85753ebbf8df23">More...</a><br /></td></tr>
|
|
<tr class="separator:a7072365e9d3fe7a2de85753ebbf8df23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70b1868fc13cbd7675684380cd434613"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a70b1868fc13cbd7675684380cd434613">removeActor</a> (<a class="el" href="classPxActor.html">PxActor</a> &actor)=0</td></tr>
|
|
<tr class="memdesc:a70b1868fc13cbd7675684380cd434613"><td class="mdescLeft"> </td><td class="mdescRight">Removes an actor from the aggregate object. <a href="#a70b1868fc13cbd7675684380cd434613">More...</a><br /></td></tr>
|
|
<tr class="separator:a70b1868fc13cbd7675684380cd434613"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c3be9f9fedc1bfd461272789555c488"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a4c3be9f9fedc1bfd461272789555c488">addArticulation</a> (<a class="el" href="classPxArticulationBase.html">PxArticulationBase</a> &articulation)=0</td></tr>
|
|
<tr class="memdesc:a4c3be9f9fedc1bfd461272789555c488"><td class="mdescLeft"> </td><td class="mdescRight">Adds an articulation to the aggregate object. <a href="#a4c3be9f9fedc1bfd461272789555c488">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c3be9f9fedc1bfd461272789555c488"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e4276769e02d0c3b9389c26f2477619"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a0e4276769e02d0c3b9389c26f2477619">removeArticulation</a> (<a class="el" href="classPxArticulationBase.html">PxArticulationBase</a> &articulation)=0</td></tr>
|
|
<tr class="memdesc:a0e4276769e02d0c3b9389c26f2477619"><td class="mdescLeft"> </td><td class="mdescRight">Removes an articulation from the aggregate object. <a href="#a0e4276769e02d0c3b9389c26f2477619">More...</a><br /></td></tr>
|
|
<tr class="separator:a0e4276769e02d0c3b9389c26f2477619"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a070c8dee88ae92f062417ac5a20a5a64"><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="classPxAggregate.html#a070c8dee88ae92f062417ac5a20a5a64">getNbActors</a> () const =0</td></tr>
|
|
<tr class="memdesc:a070c8dee88ae92f062417ac5a20a5a64"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of actors contained in the aggregate. <a href="#a070c8dee88ae92f062417ac5a20a5a64">More...</a><br /></td></tr>
|
|
<tr class="separator:a070c8dee88ae92f062417ac5a20a5a64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae54ef106d3797674aa08b0d32400c8a3"><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="classPxAggregate.html#ae54ef106d3797674aa08b0d32400c8a3">getMaxNbActors</a> () const =0</td></tr>
|
|
<tr class="memdesc:ae54ef106d3797674aa08b0d32400c8a3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves max amount of actors that can be contained in the aggregate. <a href="#ae54ef106d3797674aa08b0d32400c8a3">More...</a><br /></td></tr>
|
|
<tr class="separator:ae54ef106d3797674aa08b0d32400c8a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e87d0b4af5f03e6323ec3817086b366"><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="classPxAggregate.html#a0e87d0b4af5f03e6323ec3817086b366">getActors</a> (<a class="el" href="classPxActor.html">PxActor</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:a0e87d0b4af5f03e6323ec3817086b366"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve all actors contained in the aggregate. <a href="#a0e87d0b4af5f03e6323ec3817086b366">More...</a><br /></td></tr>
|
|
<tr class="separator:a0e87d0b4af5f03e6323ec3817086b366"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa70f305e7f2934d99afd74d28b0c0194"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classPxScene.html">PxScene</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#aa70f305e7f2934d99afd74d28b0c0194">getScene</a> ()=0</td></tr>
|
|
<tr class="memdesc:aa70f305e7f2934d99afd74d28b0c0194"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene which this aggregate belongs to. <a href="#aa70f305e7f2934d99afd74d28b0c0194">More...</a><br /></td></tr>
|
|
<tr class="separator:aa70f305e7f2934d99afd74d28b0c0194"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecc9a58a8966bb5b76fd82b655efb43e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#aecc9a58a8966bb5b76fd82b655efb43e">getSelfCollision</a> () const =0</td></tr>
|
|
<tr class="memdesc:aecc9a58a8966bb5b76fd82b655efb43e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves aggregate's self-collision flag. <a href="#aecc9a58a8966bb5b76fd82b655efb43e">More...</a><br /></td></tr>
|
|
<tr class="separator:aecc9a58a8966bb5b76fd82b655efb43e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41fd8f74448689e95c88a788a5a34fe3"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a41fd8f74448689e95c88a788a5a34fe3">getConcreteTypeName</a> () const</td></tr>
|
|
<tr class="memdesc:a41fd8f74448689e95c88a788a5a34fe3"><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#a41fd8f74448689e95c88a788a5a34fe3">More...</a><br /></td></tr>
|
|
<tr class="separator:a41fd8f74448689e95c88a788a5a34fe3"><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:a5a056899bfb00d7165bd04bcb6e0dc52"><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="classPxAggregate.html#a5a056899bfb00d7165bd04bcb6e0dc52">PxAggregate</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:a5a056899bfb00d7165bd04bcb6e0dc52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab837e81a00421796a5a7f1f0a3551fe0"><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="classPxAggregate.html#ab837e81a00421796a5a7f1f0a3551fe0">PxAggregate</a> (<a class="el" href="group__common.html#ga1e3721588799f5fbb18d76e4aab7d018">PxBaseFlags</a> baseFlags)</td></tr>
|
|
<tr class="separator:ab837e81a00421796a5a7f1f0a3551fe0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3eff872c05654d1bea567c091cbee916"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a3eff872c05654d1bea567c091cbee916">~PxAggregate</a> ()</td></tr>
|
|
<tr class="separator:a3eff872c05654d1bea567c091cbee916"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83cd67a19da4c9b8a53e57e3c72bd879"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAggregate.html#a83cd67a19da4c9b8a53e57e3c72bd879">isKindOf</a> (const char *name) const</td></tr>
|
|
<tr class="memdesc:a83cd67a19da4c9b8a53e57e3c72bd879"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#a83cd67a19da4c9b8a53e57e3c72bd879">More...</a><br /></td></tr>
|
|
<tr class="separator:a83cd67a19da4c9b8a53e57e3c72bd879"><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>Class to aggregate actors into a single broad-phase entry. </p>
|
|
<p>A <a class="el" href="classPxAggregate.html" title="Class to aggregate actors into a single broad-phase entry. ">PxAggregate</a> object is a collection of PxActors, which will exist as a single entry in the broad-phase structures. This has 3 main benefits:</p>
|
|
<p>1) it reduces "broad phase pollution" by allowing a collection of spatially coherent broad-phase entries to be replaced by a single aggregated entry (e.g. a ragdoll or a single actor with a large number of attached shapes).</p>
|
|
<p>2) it reduces broad-phase memory usage</p>
|
|
<p>3) filtering can be optimized a lot if self-collisions within an aggregate are not needed. For example if you don't need collisions between ragdoll bones, it's faster to simply disable filtering once and for all, for the aggregate containing the ragdoll, rather than filtering out each bone-bone collision in the filter shader.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK. ">PxActor</a>, <a class="el" href="classPxPhysics.html#a4209ffb5ab43cd7d9c6a59e4139c1993" title="Creates an aggregate with the specified maximum size and selfCollision property. ">PxPhysics.createAggregate</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a5a056899bfb00d7165bd04bcb6e0dc52"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a056899bfb00d7165bd04bcb6e0dc52">◆ </a></span>PxAggregate() <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> PxAggregate::PxAggregate </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="ab837e81a00421796a5a7f1f0a3551fe0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab837e81a00421796a5a7f1f0a3551fe0">◆ </a></span>PxAggregate() <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> PxAggregate::PxAggregate </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="a3eff872c05654d1bea567c091cbee916"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3eff872c05654d1bea567c091cbee916">◆ </a></span>~PxAggregate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual PxAggregate::~PxAggregate </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="a7072365e9d3fe7a2de85753ebbf8df23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7072365e9d3fe7a2de85753ebbf8df23">◆ </a></span>addActor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PxAggregate::addActor </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classPxActor.html">PxActor</a> & </td>
|
|
<td class="paramname"><em>actor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classPxBVHStructure.html">PxBVHStructure</a> * </td>
|
|
<td class="paramname"><em>bvhStructure</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Adds an actor to the aggregate object. </p>
|
|
<p>A warning is output if the total number of actors is reached, or if the incoming actor already belongs to an aggregate.</p>
|
|
<p>If the aggregate belongs to a scene, adding an actor to the aggregate also adds the actor to that scene.</p>
|
|
<p>If the actor already belongs to a scene, a warning is output and the call is ignored. You need to remove the actor from the scene first, before adding it to the aggregate.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>When BVHStructure is provided the actor shapes are grouped together. The scene query pruning structure inside PhysX SDK will store/update one bound per actor. The scene queries against such an actor will query actor bounds and then make a local space query against the provided BVH structure, which is in actor's local space.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>The actor that should be added to the aggregate </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">bvhStructure</td><td>BVHStructure for actor shapes. return true if success </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c3be9f9fedc1bfd461272789555c488"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c3be9f9fedc1bfd461272789555c488">◆ </a></span>addArticulation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PxAggregate::addArticulation </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classPxArticulationBase.html">PxArticulationBase</a> & </td>
|
|
<td class="paramname"><em>articulation</em></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>Adds an articulation to the aggregate object. </p>
|
|
<p>A warning is output if the total number of actors is reached (every articulation link counts as an actor), or if the incoming articulation already belongs to an aggregate.</p>
|
|
<p>If the aggregate belongs to a scene, adding an articulation to the aggregate also adds the articulation to that scene.</p>
|
|
<p>If the articulation already belongs to a scene, a warning is output and the call is ignored. You need to remove the articulation from the scene first, before adding it to the aggregate.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">articulation</td><td>The articulation that should be added to the aggregate return true if success </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e87d0b4af5f03e6323ec3817086b366"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e87d0b4af5f03e6323ec3817086b366">◆ </a></span>getActors()</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> PxAggregate::getActors </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classPxActor.html">PxActor</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 all actors contained in the aggregate. </p>
|
|
<p>You can retrieve the number of actor pointers by calling <a class="el" href="classPxAggregate.html#a070c8dee88ae92f062417ac5a20a5a64" title="Returns the number of actors contained in the aggregate. ">getNbActors()</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 actor pointers written to the buffer.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> getNbShapes() </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a41fd8f74448689e95c88a788a5a34fe3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41fd8f74448689e95c88a788a5a34fe3">◆ </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* PxAggregate::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="ae54ef106d3797674aa08b0d32400c8a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae54ef106d3797674aa08b0d32400c8a3">◆ </a></span>getMaxNbActors()</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> PxAggregate::getMaxNbActors </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>Retrieves max amount of actors that can be contained in the aggregate. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Max aggregate size.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxPhysics.html#a4209ffb5ab43cd7d9c6a59e4139c1993" title="Creates an aggregate with the specified maximum size and selfCollision property. ">PxPhysics::createAggregate()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a070c8dee88ae92f062417ac5a20a5a64"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a070c8dee88ae92f062417ac5a20a5a64">◆ </a></span>getNbActors()</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> PxAggregate::getNbActors </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 actors contained in the aggregate. </p>
|
|
<p>You can use <a class="el" href="classPxAggregate.html#a0e87d0b4af5f03e6323ec3817086b366" title="Retrieve all actors contained in the aggregate. ">getActors()</a> to retrieve the actor pointers.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of actors contained in the aggregate.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK. ">PxActor</a> <a class="el" href="classPxAggregate.html#a0e87d0b4af5f03e6323ec3817086b366" title="Retrieve all actors contained in the aggregate. ">getActors()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa70f305e7f2934d99afd74d28b0c0194"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa70f305e7f2934d99afd74d28b0c0194">◆ </a></span>getScene()</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="classPxScene.html">PxScene</a>* PxAggregate::getScene </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>Retrieves the scene which this aggregate belongs to. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Owner Scene. NULL if not part of a scene.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. ">PxScene</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aecc9a58a8966bb5b76fd82b655efb43e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecc9a58a8966bb5b76fd82b655efb43e">◆ </a></span>getSelfCollision()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PxAggregate::getSelfCollision </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>Retrieves aggregate's self-collision flag. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>self-collision flag </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a83cd67a19da4c9b8a53e57e3c72bd879"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a83cd67a19da4c9b8a53e57e3c72bd879">◆ </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 PxAggregate::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="a4e49bed771f4c7804dfac6882c2af273"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e49bed771f4c7804dfac6882c2af273">◆ </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 PxAggregate::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>Deletes the aggregate object. </p>
|
|
<p>Deleting the <a class="el" href="classPxAggregate.html" title="Class to aggregate actors into a single broad-phase entry. ">PxAggregate</a> object does not delete the aggregated actors. If the <a class="el" href="classPxAggregate.html" title="Class to aggregate actors into a single broad-phase entry. ">PxAggregate</a> object belongs to a scene, the aggregated actors are automatically re-inserted in that scene. If you intend to delete both the <a class="el" href="classPxAggregate.html" title="Class to aggregate actors into a single broad-phase entry. ">PxAggregate</a> and its actors, it is best to release the actors first, then release the <a class="el" href="classPxAggregate.html" title="Class to aggregate actors into a single broad-phase entry. ">PxAggregate</a> when it is empty. </p>
|
|
|
|
<p>Implements <a class="el" href="classPxBase.html#afe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70b1868fc13cbd7675684380cd434613"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70b1868fc13cbd7675684380cd434613">◆ </a></span>removeActor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PxAggregate::removeActor </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classPxActor.html">PxActor</a> & </td>
|
|
<td class="paramname"><em>actor</em></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>Removes an actor from the aggregate object. </p>
|
|
<p>A warning is output if the incoming actor does not belong to the aggregate. Otherwise the actor is removed from the aggregate. If the aggregate belongs to a scene, the actor is reinserted in that scene. If you intend to delete the actor, it is best to call <a class="el" href="classPxActor.html#a589a4e70ef83b583ee6a4fc5c7767762" title="Deletes the actor. ">PxActor::release()</a> directly. That way the actor will be automatically removed from its aggregate (if any) and not reinserted in a scene.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>The actor that should be removed from the aggregate return true if success </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e4276769e02d0c3b9389c26f2477619"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e4276769e02d0c3b9389c26f2477619">◆ </a></span>removeArticulation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PxAggregate::removeArticulation </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classPxArticulationBase.html">PxArticulationBase</a> & </td>
|
|
<td class="paramname"><em>articulation</em></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>Removes an articulation from the aggregate object. </p>
|
|
<p>A warning is output if the incoming articulation does not belong to the aggregate. Otherwise the articulation is removed from the aggregate. If the aggregate belongs to a scene, the articulation is reinserted in that scene. If you intend to delete the articulation, it is best to call <a class="el" href="classPxArticulation.html#a05473039f1bd3bb20f824be6ae5aa435" title="Releases the PxBase instance, please check documentation of release in derived class. ">PxArticulation::release()</a> directly. That way the articulation will be automatically removed from its aggregate (if any) and not reinserted in a scene.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">articulation</td><td>The articulation that should be removed from the aggregate return true if success </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="PxAggregate_8h_source.html">PxAggregate.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="classPxAggregate.html">PxAggregate</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>
|