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

165 lines
11 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>PxShapeFlag Struct 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('structPxShapeFlag.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-types">Public Types</a> &#124;
<a href="structPxShapeFlag-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxShapeFlag Struct Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Flags which affect the behavior of PxShapes.
<a href="structPxShapeFlag.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxShape_8h_source.html">PxShape.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a6edb481aaa3a998c5d6dd3fc4ad87f1a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxShapeFlag.html#a6edb481aaa3a998c5d6dd3fc4ad87f1a">Enum</a> { <a class="el" href="structPxShapeFlag.html#a6edb481aaa3a998c5d6dd3fc4ad87f1aa7fa4fea0eecda9cc80a7aaa11a22df52">eSIMULATION_SHAPE</a> = (1&lt;&lt;0),
<a class="el" href="structPxShapeFlag.html#a6edb481aaa3a998c5d6dd3fc4ad87f1aabc7ec24b00ed57f3914482f0706c6273">eSCENE_QUERY_SHAPE</a> = (1&lt;&lt;1),
<a class="el" href="structPxShapeFlag.html#a6edb481aaa3a998c5d6dd3fc4ad87f1aaef2b90024dc86be72b68bbaf94a5821d">eTRIGGER_SHAPE</a> = (1&lt;&lt;2),
<a class="el" href="structPxShapeFlag.html#a6edb481aaa3a998c5d6dd3fc4ad87f1aa1b3a6f33eb84ee2dc74eac63aa86f2a4">eVISUALIZATION</a> = (1&lt;&lt;3)
}</td></tr>
<tr class="separator:a6edb481aaa3a998c5d6dd3fc4ad87f1a"><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>Flags which affect the behavior of PxShapes. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> <a class="el" href="classPxShape.html#a3c879df184ef40514589c5aa3d1f2a33" title="Sets shape flags. ">PxShape.setFlag()</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a6edb481aaa3a998c5d6dd3fc4ad87f1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6edb481aaa3a998c5d6dd3fc4ad87f1a">&#9670;&nbsp;</a></span>Enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structPxShapeFlag.html#a6edb481aaa3a998c5d6dd3fc4ad87f1a">PxShapeFlag::Enum</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6edb481aaa3a998c5d6dd3fc4ad87f1aa7fa4fea0eecda9cc80a7aaa11a22df52"></a>eSIMULATION_SHAPE&#160;</td><td class="fielddoc"><p>The shape will partake in collision in the physical simulation. </p>
<dl class="section note"><dt>Note</dt><dd>It is illegal to raise the eSIMULATION_SHAPE and eTRIGGER_SHAPE flags. In the event that one of these flags is already raised the sdk will reject any attempt to raise the other. To raise the eSIMULATION_SHAPE first ensure that eTRIGGER_SHAPE is already lowered.</dd>
<dd>
This flag has no effect if simulation is disabled for the corresponding actor (see <a class="el" href="structPxActorFlag.html#a1bc4c717e79cd547bdbe09a179ee9f1da0838a5b8c88cebfa5d53904bb3b97411" title="Disables simulation for the actor. ">PxActorFlag::eDISABLE_SIMULATION</a>).</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSimulationEventCallback.html#a4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur. ">PxSimulationEventCallback.onContact()</a> <a class="el" href="classPxScene.html#a0cfa2d3835ea936ecd6ff94fbcefd689" title="Sets a user notify object which receives special simulation events when they occur. ">PxScene.setSimulationEventCallback()</a> <a class="el" href="classPxShape.html#a3c879df184ef40514589c5aa3d1f2a33" title="Sets shape flags. ">PxShape.setFlag()</a>, <a class="el" href="classPxShape.html#afc179cb4b2146af98c76623d2fc0db6e" title="Sets shape flags. ">PxShape.setFlags()</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a6edb481aaa3a998c5d6dd3fc4ad87f1aabc7ec24b00ed57f3914482f0706c6273"></a>eSCENE_QUERY_SHAPE&#160;</td><td class="fielddoc"><p>The shape will partake in scene queries (ray casts, overlap tests, sweeps, ...). </p>
</td></tr>
<tr><td class="fieldname"><a id="a6edb481aaa3a998c5d6dd3fc4ad87f1aaef2b90024dc86be72b68bbaf94a5821d"></a>eTRIGGER_SHAPE&#160;</td><td class="fielddoc"><p>The shape is a trigger which can send reports whenever other shapes enter/leave its volume. </p>
<dl class="section note"><dt>Note</dt><dd>Triangle meshes and heightfields can not be triggers. Shape creation will fail in these cases.</dd>
<dd>
Shapes marked as triggers do not collide with other objects. If an object should act both as a trigger shape and a collision shape then create a rigid body with two shapes, one being a trigger shape and the other a collision shape. It is illegal to raise the eTRIGGER_SHAPE and eSIMULATION_SHAPE flags on a single <a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> instance. In the event that one of these flags is already raised the sdk will reject any attempt to raise the other. To raise the eTRIGGER_SHAPE flag first ensure that eSIMULATION_SHAPE flag is already lowered.</dd>
<dd>
Trigger shapes will no longer send notification events for interactions with other trigger shapes.</dd>
<dd>
Shapes marked as triggers are allowed to participate in scene queries, provided the eSCENE_QUERY_SHAPE flag is set.</dd>
<dd>
This flag has no effect if simulation is disabled for the corresponding actor (see <a class="el" href="structPxActorFlag.html#a1bc4c717e79cd547bdbe09a179ee9f1da0838a5b8c88cebfa5d53904bb3b97411" title="Disables simulation for the actor. ">PxActorFlag::eDISABLE_SIMULATION</a>).</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSimulationEventCallback.html#a768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events. ">PxSimulationEventCallback.onTrigger()</a> <a class="el" href="classPxScene.html#a0cfa2d3835ea936ecd6ff94fbcefd689" title="Sets a user notify object which receives special simulation events when they occur. ">PxScene.setSimulationEventCallback()</a> <a class="el" href="classPxShape.html#a3c879df184ef40514589c5aa3d1f2a33" title="Sets shape flags. ">PxShape.setFlag()</a>, <a class="el" href="classPxShape.html#afc179cb4b2146af98c76623d2fc0db6e" title="Sets shape flags. ">PxShape.setFlags()</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a6edb481aaa3a998c5d6dd3fc4ad87f1aa1b3a6f33eb84ee2dc74eac63aa86f2a4"></a>eVISUALIZATION&#160;</td><td class="fielddoc"><p>Enable debug renderer for this shape. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxScene.html#a35f231796a325fcf587e681831c5fcb5" title="Retrieves the render buffer. ">PxScene.getRenderBuffer()</a> <a class="el" href="classPxRenderBuffer.html" title="Interface for points, lines, triangles, and text buffer. ">PxRenderBuffer</a> <a class="el" href="structPxVisualizationParameter.html" title="Debug visualization parameters. ">PxVisualizationParameter</a> </dd></dl>
</td></tr>
</table>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxShape_8h_source.html">PxShape.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="structPxShapeFlag.html">PxShapeFlag</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>