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

301 lines
18 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>PxBoxGeometry Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxBoxGeometry.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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classPxBoxGeometry-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxBoxGeometry Class Reference<div class="ingroups"><a class="el" href="group__geomutils.html">Geomutils</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Class representing the geometry of a box.
<a href="classPxBoxGeometry.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxBoxGeometry_8h_source.html">PxBoxGeometry.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxBoxGeometry:</div>
<div class="dyncontent">
<div class="center"><img src="classPxBoxGeometry__inherit__graph.png" border="0" usemap="#PxBoxGeometry_inherit__map" alt="Inheritance graph"/></div>
<map name="PxBoxGeometry_inherit__map" id="PxBoxGeometry_inherit__map">
<area shape="rect" id="node2" href="classPxGeometry.html" title="A geometry object. " alt="" coords="17,5,112,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxBoxGeometry:</div>
<div class="dyncontent">
<div class="center"><img src="classPxBoxGeometry__coll__graph.png" border="0" usemap="#PxBoxGeometry_coll__map" alt="Collaboration graph"/></div>
<map name="PxBoxGeometry_coll__map" id="PxBoxGeometry_coll__map">
<area shape="rect" id="node2" href="classPxGeometry.html" title="A geometry object. " alt="" coords="5,5,100,32"/>
<area shape="rect" id="node3" href="classPxVec3.html" title="3 Element vector class. " alt="" coords="124,5,192,32"/>
</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:aab5633a2c4280cc591bf9f13902405c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxGeometry.html#aab5633a2c4280cc591bf9f13902405c2">PxBoxGeometry</a> ()</td></tr>
<tr class="memdesc:aab5633a2c4280cc591bf9f13902405c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor, initializes to a box with zero dimensions. <a href="#aab5633a2c4280cc591bf9f13902405c2">More...</a><br /></td></tr>
<tr class="separator:aab5633a2c4280cc591bf9f13902405c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef82a3ad150e5c85815d37548deb198c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxGeometry.html#aef82a3ad150e5c85815d37548deb198c">PxBoxGeometry</a> (PxReal hx, PxReal hy, PxReal hz)</td></tr>
<tr class="memdesc:aef82a3ad150e5c85815d37548deb198c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor to initialize half extents from scalar parameters. <a href="#aef82a3ad150e5c85815d37548deb198c">More...</a><br /></td></tr>
<tr class="separator:aef82a3ad150e5c85815d37548deb198c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9df30f1adc5a8cad38f70b3ae106860a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxGeometry.html#a9df30f1adc5a8cad38f70b3ae106860a">PxBoxGeometry</a> (<a class="el" href="classPxVec3.html">PxVec3</a> halfExtents_)</td></tr>
<tr class="memdesc:a9df30f1adc5a8cad38f70b3ae106860a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor to initialize half extents from vector parameter. <a href="#a9df30f1adc5a8cad38f70b3ae106860a">More...</a><br /></td></tr>
<tr class="separator:a9df30f1adc5a8cad38f70b3ae106860a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44ff0ebd02fac58691bf604adfc3fc76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#ga44ff0ebd02fac58691bf604adfc3fc76">isValid</a> () const</td></tr>
<tr class="memdesc:ga44ff0ebd02fac58691bf604adfc3fc76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the geometry is valid. <a href="group__geomutils.html#ga44ff0ebd02fac58691bf604adfc3fc76">More...</a><br /></td></tr>
<tr class="separator:ga44ff0ebd02fac58691bf604adfc3fc76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#a681b898f104db56c0012fe8f7f172d15">getType</a> () const</td></tr>
<tr class="memdesc:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the geometry. <a href="classPxGeometry.html#a681b898f104db56c0012fe8f7f172d15">More...</a><br /></td></tr>
<tr class="separator:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8fe8be4ca1467353956634d550dc8561"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxGeometry.html#a8fe8be4ca1467353956634d550dc8561">halfExtents</a></td></tr>
<tr class="memdesc:a8fe8be4ca1467353956634d550dc8561"><td class="mdescLeft">&#160;</td><td class="mdescRight">Half of the width, height, and depth of the box. <a href="#a8fe8be4ca1467353956634d550dc8561">More...</a><br /></td></tr>
<tr class="separator:a8fe8be4ca1467353956634d550dc8561"><td class="memSeparator" colspan="2">&#160;</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_methods_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:a2507c9f4d63fe816968fe9a2744ac549 inherit pro_methods_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#a2507c9f4d63fe816968fe9a2744ac549">PxGeometry</a> (<a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a> type)</td></tr>
<tr class="separator:a2507c9f4d63fe816968fe9a2744ac549 inherit pro_methods_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:af24eeb8078fbd12e17206029b52a45b6 inherit pro_attribs_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#af24eeb8078fbd12e17206029b52a45b6">mType</a></td></tr>
<tr class="separator:af24eeb8078fbd12e17206029b52a45b6 inherit pro_attribs_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class representing the geometry of a box. </p>
<p>The geometry of a box can be fully specified by its half extents. This is the half of its width, height, and depth. </p><dl class="section note"><dt>Note</dt><dd>The scaling of the box is expected to be baked into these values, there is no additional scaling parameter. </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aab5633a2c4280cc591bf9f13902405c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab5633a2c4280cc591bf9f13902405c2">&#9670;&nbsp;</a></span>PxBoxGeometry() <span class="overload">[1/3]</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> PxBoxGeometry::PxBoxGeometry </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor, initializes to a box with zero dimensions. </p>
</div>
</div>
<a id="aef82a3ad150e5c85815d37548deb198c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef82a3ad150e5c85815d37548deb198c">&#9670;&nbsp;</a></span>PxBoxGeometry() <span class="overload">[2/3]</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> PxBoxGeometry::PxBoxGeometry </td>
<td>(</td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>hx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>hy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>hz</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor to initialize half extents from scalar parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hx</td><td>Initial half extents' x component. </td></tr>
<tr><td class="paramname">hy</td><td>Initial half extents' y component. </td></tr>
<tr><td class="paramname">hz</td><td>Initial half extents' z component. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9df30f1adc5a8cad38f70b3ae106860a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9df30f1adc5a8cad38f70b3ae106860a">&#9670;&nbsp;</a></span>PxBoxGeometry() <span class="overload">[3/3]</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> PxBoxGeometry::PxBoxGeometry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a>&#160;</td>
<td class="paramname"><em>halfExtents_</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor to initialize half extents from vector parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">halfExtents_</td><td>Initial half extents. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8fe8be4ca1467353956634d550dc8561"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fe8be4ca1467353956634d550dc8561">&#9670;&nbsp;</a></span>halfExtents</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> PxBoxGeometry::halfExtents</td>
</tr>
</table>
</div><div class="memdoc">
<p>Half of the width, height, and depth of the box. </p>
<p class="reference">Referenced by <a class="el" href="classPxMassProperties.html#acc8eadc90e93df0e25d4dfb63988a596">PxMassProperties::PxMassProperties()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxBoxGeometry_8h_source.html">PxBoxGeometry.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="classPxBoxGeometry.html">PxBoxGeometry</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>