diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxShapeFlag.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxShapeFlag.html | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxShapeFlag.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxShapeFlag.html new file mode 100644 index 00000000..cf7b1a1f --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxShapeFlag.html @@ -0,0 +1,106 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxShapeFlag Struct Reference</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css"> + </head> + + <body bgcolor="#FFFFFF"> + <div id="header"> + <hr class="first"> + <img alt="" src="images/PhysXlogo.png" align="middle"> <br> + <center> + <a class="qindex" href="main.html">Main Page</a> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxShapeFlag Struct Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxShapeFlag" -->Flags which affect the behavior of PxShapes. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxShape_8h-source.html">PxShape.h</a>></code> +<p> + +<p> +<a href="structPxShapeFlag-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1a">Enum</a> { <br> + <a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1a7fa4fea0eecda9cc80a7aaa11a22df52">eSIMULATION_SHAPE</a> = (1<<0), +<br> + <a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1abc7ec24b00ed57f3914482f0706c6273">eSCENE_QUERY_SHAPE</a> = (1<<1), +<br> + <a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1aef2b90024dc86be72b68bbaf94a5821d">eTRIGGER_SHAPE</a> = (1<<2), +<br> + <a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1a1b3a6f33eb84ee2dc74eac63aa86f2a4">eVISUALIZATION</a> = (1<<3), +<br> + <a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1a760547ce999141103f3d0a1289063ead">ePARTICLE_DRAIN</a> = (1<<4) +<br> + }</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Flags which affect the behavior of PxShapes. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> <a class="el" href="classPxShape.html#3c879df184ef40514589c5aa3d1f2a33" title="Sets shape flags.">PxShape.setFlag()</a> </dd></dl> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="6edb481aaa3a998c5d6dd3fc4ad87f1a"></a><!-- doxytag: member="PxShapeFlag::Enum" ref="6edb481aaa3a998c5d6dd3fc4ad87f1a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="structPxShapeFlag.html#6edb481aaa3a998c5d6dd3fc4ad87f1a">PxShapeFlag::Enum</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="6edb481aaa3a998c5d6dd3fc4ad87f1a7fa4fea0eecda9cc80a7aaa11a22df52"></a><!-- doxytag: member="eSIMULATION_SHAPE" ref="6edb481aaa3a998c5d6dd3fc4ad87f1a7fa4fea0eecda9cc80a7aaa11a22df52" args="" -->eSIMULATION_SHAPE</em> </td><td> +The shape will partake in collision in the physical simulation. +<p> +<dl class="note" compact><dt><b>Note:</b></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.<p> +This flag has no effect if simulation is disabled for the corresponding actor (see <a class="el" href="structPxActorFlag.html#1bc4c717e79cd547bdbe09a179ee9f1d0838a5b8c88cebfa5d53904bb3b97411" title="Disables simulation for the actor.">PxActorFlag::eDISABLE_SIMULATION</a>).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSimulationEventCallback.html#4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur.">PxSimulationEventCallback.onContact()</a> <a class="el" href="classPxScene.html#88f5438bf61cf5c3f767d8b515c51d31" title="Sets a user notify object which receives special simulation events when they occur...">PxScene.setSimulationEventCallback()</a> <a class="el" href="classPxShape.html#3c879df184ef40514589c5aa3d1f2a33" title="Sets shape flags.">PxShape.setFlag()</a>, <a class="el" href="classPxShape.html#fc179cb4b2146af98c76623d2fc0db6e" title="Sets shape flags.">PxShape.setFlags()</a> </dd></dl> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="6edb481aaa3a998c5d6dd3fc4ad87f1abc7ec24b00ed57f3914482f0706c6273"></a><!-- doxytag: member="eSCENE_QUERY_SHAPE" ref="6edb481aaa3a998c5d6dd3fc4ad87f1abc7ec24b00ed57f3914482f0706c6273" args="" -->eSCENE_QUERY_SHAPE</em> </td><td> +The shape will partake in scene queries (ray casts, overlap tests, sweeps, ...). </td></tr> +<tr><td valign="top"><em><a class="anchor" name="6edb481aaa3a998c5d6dd3fc4ad87f1aef2b90024dc86be72b68bbaf94a5821d"></a><!-- doxytag: member="eTRIGGER_SHAPE" ref="6edb481aaa3a998c5d6dd3fc4ad87f1aef2b90024dc86be72b68bbaf94a5821d" args="" -->eTRIGGER_SHAPE</em> </td><td> +The shape is a trigger which can send reports whenever other shapes enter/leave its volume. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Triangle meshes and heightfields can not be triggers. Shape creation will fail in these cases.<p> +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.<p> +Trigger shapes will no longer send notification events for interactions with other trigger shapes. For PhysX 3.4 there is the option to re-enable the reports by raising <a class="el" href="structPxSceneFlag.html#b4c347372b4433d34d983da780916c531d29a32a585c1463b30332ee8e328cad" title="Enable legacy behavior to get trigger reports for interactions between two trigger...">PxSceneFlag::eDEPRECATED_TRIGGER_TRIGGER_REPORTS</a>. In PhysX 3.5 there will be no support for these reports any longer. See the 3.4 migration guide for more information.<p> +Shapes marked as triggers are allowed to participate in scene queries, provided the eSCENE_QUERY_SHAPE flag is set.<p> +This flag has no effect if simulation is disabled for the corresponding actor (see <a class="el" href="structPxActorFlag.html#1bc4c717e79cd547bdbe09a179ee9f1d0838a5b8c88cebfa5d53904bb3b97411" title="Disables simulation for the actor.">PxActorFlag::eDISABLE_SIMULATION</a>).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSimulationEventCallback.html#768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events.">PxSimulationEventCallback.onTrigger()</a> <a class="el" href="classPxScene.html#88f5438bf61cf5c3f767d8b515c51d31" title="Sets a user notify object which receives special simulation events when they occur...">PxScene.setSimulationEventCallback()</a> <a class="el" href="classPxShape.html#3c879df184ef40514589c5aa3d1f2a33" title="Sets shape flags.">PxShape.setFlag()</a>, <a class="el" href="classPxShape.html#fc179cb4b2146af98c76623d2fc0db6e" title="Sets shape flags.">PxShape.setFlags()</a> </dd></dl> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="6edb481aaa3a998c5d6dd3fc4ad87f1a1b3a6f33eb84ee2dc74eac63aa86f2a4"></a><!-- doxytag: member="eVISUALIZATION" ref="6edb481aaa3a998c5d6dd3fc4ad87f1a1b3a6f33eb84ee2dc74eac63aa86f2a4" args="" -->eVISUALIZATION</em> </td><td> +Enable debug renderer for this shape. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#35f231796a325fcf587e681831c5fcb5" 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> +<tr><td valign="top"><em><a class="anchor" name="6edb481aaa3a998c5d6dd3fc4ad87f1a760547ce999141103f3d0a1289063ead"></a><!-- doxytag: member="ePARTICLE_DRAIN" ref="6edb481aaa3a998c5d6dd3fc4ad87f1a760547ce999141103f3d0a1289063ead" args="" -->ePARTICLE_DRAIN</em> </td><td> +Sets the shape to be a particle drain. </td></tr> +</table> +</dl> + +</div> +</div><p> +<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></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a> +</body> +</html> |