diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneQueryExt.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneQueryExt.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneQueryExt.html | 887 |
1 files changed, 887 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneQueryExt.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneQueryExt.html new file mode 100644 index 00000000..a30db66a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneQueryExt.html @@ -0,0 +1,887 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSceneQueryExt Class 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>PxSceneQueryExt Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxSceneQueryExt" -->utility functions for use with <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>, related to scene queries. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxSceneQueryExt_8h-source.html">PxSceneQueryExt.h</a>></code> +<p> + +<p> +<a href="classPxSceneQueryExt-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#685f0c17b10451f04067db3b0daa3e9b">raycastAny</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxVec3.html">PxVec3</a> &origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="structPxQueryHit.html">PxSceneQueryHit</a> &hit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> *cache=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Raycast returning any blocking hit, not necessarily the closest. <a href="#685f0c17b10451f04067db3b0daa3e9b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#357ee12cdbb45a9d2e495b0018da9222">raycastSingle</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxVec3.html">PxVec3</a> &origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> outputFlags, <a class="el" href="structPxRaycastHit.html">PxRaycastHit</a> &hit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> *cache=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Raycast returning a single result. <a href="#357ee12cdbb45a9d2e495b0018da9222"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static PxI32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#7e644b6bea879d44e1e67b7912fdaf68">raycastMultiple</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxVec3.html">PxVec3</a> &origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> outputFlags, <a class="el" href="structPxRaycastHit.html">PxRaycastHit</a> *hitBuffer, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> hitBufferSize, bool &blockingHit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> *cache=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Raycast returning multiple results. <a href="#7e644b6bea879d44e1e67b7912fdaf68"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#e1f498d024c8072f1d5036ca34412f84">sweepAny</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> queryFlags, <a class="el" href="structPxQueryHit.html">PxSceneQueryHit</a> &hit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> *cache=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>, PxReal inflation=0.0f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sweep returning any blocking hit, not necessarily the closest. <a href="#e1f498d024c8072f1d5036ca34412f84"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#eda6bdd24336f093a8bd7bc76aa82ad8">sweepSingle</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> outputFlags, <a class="el" href="structPxSweepHit.html">PxSweepHit</a> &hit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> *cache=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>, PxReal inflation=0.0f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sweep returning a single result. <a href="#eda6bdd24336f093a8bd7bc76aa82ad8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static PxI32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#2e55cf2e513a120d96e594e516d3e62c">sweepMultiple</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> outputFlags, <a class="el" href="structPxSweepHit.html">PxSweepHit</a> *hitBuffer, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> hitBufferSize, bool &blockingHit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> *cache=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>, PxReal inflation=0.0f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sweep returning multiple results. <a href="#2e55cf2e513a120d96e594e516d3e62c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static PxI32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#d7cba62429567c107a61c09dc378b21a">overlapMultiple</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, <a class="el" href="structPxOverlapHit.html">PxOverlapHit</a> *hitBuffer, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> hitBufferSize, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Test overlap between a geometry and objects in the scene. <a href="#d7cba62429567c107a61c09dc378b21a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneQueryExt.html#3c58a83de3d9b9466fc02bfcbc76dfe5">overlapAny</a> (const <a class="el" href="classPxScene.html">PxScene</a> &scene, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, <a class="el" href="structPxOverlapHit.html">PxOverlapHit</a> &hit, const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> *filterCall=NULL, PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> queryClient=<a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Test returning, for a given geometry, any overlapping object in the scene. <a href="#3c58a83de3d9b9466fc02bfcbc76dfe5"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +utility functions for use with <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>, related to scene queries. +<p> +Some of these functions have been deprecated (removed) in PhysX 3.4. We re-implement them here for easy migration from 3.3 to 3.4.<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> </dd></dl> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="3c58a83de3d9b9466fc02bfcbc76dfe5"></a><!-- doxytag: member="PxSceneQueryExt::overlapAny" ref="3c58a83de3d9b9466fc02bfcbc76dfe5" args="(const PxScene &scene, const PxGeometry &geometry, const PxTransform &pose, PxOverlapHit &hit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool PxSceneQueryExt::overlapAny </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geometry</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>pose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxOverlapHit.html">PxOverlapHit</a> & </td> + <td class="paramname"> <em>hit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Test returning, for a given geometry, any overlapping object in the scene. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Filtering: Overlap tests do not distinguish between touching and blocking hit types. Both trigger a hit.<p> +<a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b64de0c4ad4267c954d51e99905e69a399e" title="Report all hits for meshes rather than just the first. Not applicable to sweep queries...">PxHitFlag::eMESH_MULTIPLE</a> and <a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b64aff8ff06630f9388c0ff8f20b7bbd9d3">PxHitFlag::eMESH_BOTH_SIDES</a> have no effect in this case</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to check for overlap (supported types are: box, sphere, capsule, convex). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the object. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hit</em> </td><td>Pointer to store the overlapping object to. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to overlap. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if an overlap was found.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000050">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> <a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d7cba62429567c107a61c09dc378b21a"></a><!-- doxytag: member="PxSceneQueryExt::overlapMultiple" ref="d7cba62429567c107a61c09dc378b21a" args="(const PxScene &scene, const PxGeometry &geometry, const PxTransform &pose, PxOverlapHit *hitBuffer, PxU32 hitBufferSize, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static PxI32 PxSceneQueryExt::overlapMultiple </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geometry</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>pose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxOverlapHit.html">PxOverlapHit</a> * </td> + <td class="paramname"> <em>hitBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>hitBufferSize</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Test overlap between a geometry and objects in the scene. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Filtering: Overlap tests do not distinguish between touching and blocking hit types. Both get written to the hit buffer.<p> +<a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b64de0c4ad4267c954d51e99905e69a399e" title="Report all hits for meshes rather than just the first. Not applicable to sweep queries...">PxHitFlag::eMESH_MULTIPLE</a> and <a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b64aff8ff06630f9388c0ff8f20b7bbd9d3">PxHitFlag::eMESH_BOTH_SIDES</a> have no effect in this case</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to check for overlap (supported types are: box, sphere, capsule, convex). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the object. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hitBuffer</em> </td><td>Buffer to store the overlapping objects to. If the buffer overflows, an arbitrary subset of overlapping objects is stored (typically the query should be restarted with a larger buffer). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hitBufferSize</em> </td><td>Size of the hit buffer. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to overlap. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of hits in the buffer, or -1 if the buffer overflowed.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000049">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> <a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="685f0c17b10451f04067db3b0daa3e9b"></a><!-- doxytag: member="PxSceneQueryExt::raycastAny" ref="685f0c17b10451f04067db3b0daa3e9b" args="(const PxScene &scene, const PxVec3 &origin, const PxVec3 &unitDir, const PxReal distance, PxSceneQueryHit &hit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, const PxSceneQueryCache *cache=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool PxSceneQueryExt::raycastAny </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>origin</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>distance</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxQueryHit.html">PxSceneQueryHit</a> & </td> + <td class="paramname"> <em>hit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> * </td> + <td class="paramname"> <em>cache</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Raycast returning any blocking hit, not necessarily the closest. +<p> +Returns whether any rigid actor is hit along the ray.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Shooting a ray from within an object leads to different results depending on the shape type. Please check the details in article SceneQuery. User can ignore such objects by using one of the provided filter mechanisms.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>origin</em> </td><td>Origin of the ray. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the ray. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Length of the ray. Needs to be larger than 0. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hit</em> </td><td>Raycast hit information. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to be blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cache</em> </td><td>Cached hit shape (optional). Ray is tested against cached shape first. If no hit is found the ray gets queried against the scene. Note: Filtering is not executed for a cached shape if supplied; instead, if a hit is found, it is assumed to be a blocking hit. Note: Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000043">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> <a class="el" href="group__extensions.html#g871e9d89cdf9bbab58883b5f0822b5c3">PxSceneQueryCache</a> <a class="el" href="group__extensions.html#g55259fcecc0dd432e8c97f80a1425aad">PxSceneQueryHit</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7e644b6bea879d44e1e67b7912fdaf68"></a><!-- doxytag: member="PxSceneQueryExt::raycastMultiple" ref="7e644b6bea879d44e1e67b7912fdaf68" args="(const PxScene &scene, const PxVec3 &origin, const PxVec3 &unitDir, const PxReal distance, PxSceneQueryFlags outputFlags, PxRaycastHit *hitBuffer, PxU32 hitBufferSize, bool &blockingHit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, const PxSceneQueryCache *cache=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static PxI32 PxSceneQueryExt::raycastMultiple </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>origin</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>distance</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> </td> + <td class="paramname"> <em>outputFlags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxRaycastHit.html">PxRaycastHit</a> * </td> + <td class="paramname"> <em>hitBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>hitBufferSize</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool & </td> + <td class="paramname"> <em>blockingHit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> * </td> + <td class="paramname"> <em>cache</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Raycast returning multiple results. +<p> +Find all rigid actors that get hit along the ray. Each result contains data as specified by the outputFlags field.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Touching hits are not ordered.<p> +Shooting a ray from within an object leads to different results depending on the shape type. Please check the details in article SceneQuery. User can ignore such objects by using one of the provided filter mechanisms.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>origin</em> </td><td>Origin of the ray. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the ray. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Length of the ray. Needs to be larger than 0. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>outputFlags</em> </td><td>Specifies which properties should be written to the hit information </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hitBuffer</em> </td><td>Raycast hit information buffer. If the buffer overflows, the blocking hit is returned as the last entry together with an arbitrary subset of the nearer touching hits (typically the query should be restarted with a larger buffer). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hitBufferSize</em> </td><td>Size of the hit buffer. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>blockingHit</em> </td><td>True if a blocking hit was found. If found, it is the last in the buffer, preceded by any touching hits which are closer. Otherwise the touching hits are listed. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to be touching. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cache</em> </td><td>Cached hit shape (optional). Ray is tested against cached shape first then against the scene. Note: Filtering is not executed for a cached shape if supplied; instead, if a hit is found, it is assumed to be a blocking hit. Note: Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of hits in the buffer, or -1 if the buffer overflowed.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000045">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries.">PxRaycastHit</a> <a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> <a class="el" href="group__extensions.html#g871e9d89cdf9bbab58883b5f0822b5c3">PxSceneQueryCache</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="357ee12cdbb45a9d2e495b0018da9222"></a><!-- doxytag: member="PxSceneQueryExt::raycastSingle" ref="357ee12cdbb45a9d2e495b0018da9222" args="(const PxScene &scene, const PxVec3 &origin, const PxVec3 &unitDir, const PxReal distance, PxSceneQueryFlags outputFlags, PxRaycastHit &hit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, const PxSceneQueryCache *cache=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool PxSceneQueryExt::raycastSingle </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>origin</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>distance</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> </td> + <td class="paramname"> <em>outputFlags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxRaycastHit.html">PxRaycastHit</a> & </td> + <td class="paramname"> <em>hit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> * </td> + <td class="paramname"> <em>cache</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Raycast returning a single result. +<p> +Returns the first rigid actor that is hit along the ray. Data for a blocking hit will be returned as specified by the outputFlags field. Touching hits will be ignored.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Shooting a ray from within an object leads to different results depending on the shape type. Please check the details in article SceneQuery. User can ignore such objects by using one of the provided filter mechanisms.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>origin</em> </td><td>Origin of the ray. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the ray. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Length of the ray. Needs to be larger than 0. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>outputFlags</em> </td><td>Specifies which properties should be written to the hit information </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hit</em> </td><td>Raycast hit information. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to be blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cache</em> </td><td>Cached hit shape (optional). Ray is tested against cached shape first then against the scene. Note: Filtering is not executed for a cached shape if supplied; instead, if a hit is found, it is assumed to be a blocking hit. Note: Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000044">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries.">PxRaycastHit</a> <a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> <a class="el" href="group__extensions.html#g871e9d89cdf9bbab58883b5f0822b5c3">PxSceneQueryCache</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e1f498d024c8072f1d5036ca34412f84"></a><!-- doxytag: member="PxSceneQueryExt::sweepAny" ref="e1f498d024c8072f1d5036ca34412f84" args="(const PxScene &scene, const PxGeometry &geometry, const PxTransform &pose, const PxVec3 &unitDir, const PxReal distance, PxSceneQueryFlags queryFlags, PxSceneQueryHit &hit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, const PxSceneQueryCache *cache=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT, PxReal inflation=0.0f)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool PxSceneQueryExt::sweepAny </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geometry</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>pose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>distance</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> </td> + <td class="paramname"> <em>queryFlags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxQueryHit.html">PxSceneQueryHit</a> & </td> + <td class="paramname"> <em>hit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> * </td> + <td class="paramname"> <em>cache</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>inflation</em> = <code>0.0f</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sweep returning any blocking hit, not necessarily the closest. +<p> +Returns whether any rigid actor is hit along the sweep path.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If a shape from the scene is already overlapping with the query shape in its starting position, behavior is controlled by the PxSceneQueryFlag::eINITIAL_OVERLAP flag.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to sweep (supported types are: box, sphere, capsule, convex). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the sweep object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the sweep. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Sweep distance. Needs to be larger than 0. Will be clamped to PX_MAX_SWEEP_DISTANCE. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryFlags</em> </td><td>Combination of PxSceneQueryFlag defining the query behavior </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hit</em> </td><td>Sweep hit information. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to be blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cache</em> </td><td>Cached hit shape (optional). Sweep is performed against cached shape first. If no hit is found the sweep gets queried against the scene. Note: Filtering is not executed for a cached shape if supplied; instead, if a hit is found, it is assumed to be a blocking hit. Note: Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inflation</em> </td><td>This parameter creates a skin around the swept geometry which increases its extents for sweeping. The sweep will register a hit as soon as the skin touches a shape, and will return the corresponding distance and normal. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000046">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> <a class="el" href="group__extensions.html#g55259fcecc0dd432e8c97f80a1425aad">PxSceneQueryHit</a> <a class="el" href="group__extensions.html#g871e9d89cdf9bbab58883b5f0822b5c3">PxSceneQueryCache</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2e55cf2e513a120d96e594e516d3e62c"></a><!-- doxytag: member="PxSceneQueryExt::sweepMultiple" ref="2e55cf2e513a120d96e594e516d3e62c" args="(const PxScene &scene, const PxGeometry &geometry, const PxTransform &pose, const PxVec3 &unitDir, const PxReal distance, PxSceneQueryFlags outputFlags, PxSweepHit *hitBuffer, PxU32 hitBufferSize, bool &blockingHit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, const PxSceneQueryCache *cache=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT, PxReal inflation=0.0f)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static PxI32 PxSceneQueryExt::sweepMultiple </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geometry</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>pose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>distance</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> </td> + <td class="paramname"> <em>outputFlags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxSweepHit.html">PxSweepHit</a> * </td> + <td class="paramname"> <em>hitBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>hitBufferSize</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool & </td> + <td class="paramname"> <em>blockingHit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> * </td> + <td class="paramname"> <em>cache</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>inflation</em> = <code>0.0f</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sweep returning multiple results. +<p> +Find all rigid actors that get hit along the sweep. Each result contains data as specified by the outputFlags field.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Touching hits are not ordered.<p> +If a shape from the scene is already overlapping with the query shape in its starting position, behavior is controlled by the PxSceneQueryFlag::eINITIAL_OVERLAP flag.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to sweep (supported types are: box, sphere, capsule, convex). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the sweep object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the sweep. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Sweep distance. Needs to be larger than 0. Will be clamped to PX_MAX_SWEEP_DISTANCE. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>outputFlags</em> </td><td>Specifies which properties should be written to the hit information. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hitBuffer</em> </td><td>Sweep hit information buffer. If the buffer overflows, the blocking hit is returned as the last entry together with an arbitrary subset of the nearer touching hits (typically the query should be restarted with a larger buffer). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hitBufferSize</em> </td><td>Size of the hit buffer. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>blockingHit</em> </td><td>True if a blocking hit was found. If found, it is the last in the buffer, preceded by any touching hits which are closer. Otherwise the touching hits are listed. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to be touching. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cache</em> </td><td>Cached hit shape (optional). Sweep is performed against cached shape first then against the scene. Note: Filtering is not executed for a cached shape if supplied; instead, if a hit is found, it is assumed to be a blocking hit. Note: Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inflation</em> </td><td>This parameter creates a skin around the swept geometry which increases its extents for sweeping. The sweep will register a hit as soon as the skin touches a shape, and will return the corresponding distance and normal. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of hits in the buffer, or -1 if the buffer overflowed.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000048">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries.">PxSweepHit</a> <a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> <a class="el" href="group__extensions.html#g871e9d89cdf9bbab58883b5f0822b5c3">PxSceneQueryCache</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="eda6bdd24336f093a8bd7bc76aa82ad8"></a><!-- doxytag: member="PxSceneQueryExt::sweepSingle" ref="eda6bdd24336f093a8bd7bc76aa82ad8" args="(const PxScene &scene, const PxGeometry &geometry, const PxTransform &pose, const PxVec3 &unitDir, const PxReal distance, PxSceneQueryFlags outputFlags, PxSweepHit &hit, const PxSceneQueryFilterData &filterData=PxSceneQueryFilterData(), PxSceneQueryFilterCallback *filterCall=NULL, const PxSceneQueryCache *cache=NULL, PX_DEPRECATED PxClientID queryClient=PX_DEFAULT_CLIENT, PxReal inflation=0.0f)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool PxSceneQueryExt::sweepSingle </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geometry</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>pose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>distance</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> </td> + <td class="paramname"> <em>outputFlags</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxSweepHit.html">PxSweepHit</a> & </td> + <td class="paramname"> <em>hit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a> & </td> + <td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxSceneQueryFilterData</a>()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxSceneQueryFilterCallback</a> * </td> + <td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxQueryCache.html">PxSceneQueryCache</a> * </td> + <td class="paramname"> <em>cache</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td> + <td class="paramname"> <em>queryClient</em> = <code><a class="el" href="PxClient_8h.html#8bc840c3fd493df8b6072d055d050fb4">PX_DEFAULT_CLIENT</a></code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>inflation</em> = <code>0.0f</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sweep returning a single result. +<p> +Returns the first rigid actor that is hit along the ray. Data for a blocking hit will be returned as specified by the outputFlags field. Touching hits will be ignored.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If a shape from the scene is already overlapping with the query shape in its starting position, behavior is controlled by the PxSceneQueryFlag::eINITIAL_OVERLAP flag.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>scene</em> </td><td>The scene </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to sweep (supported types are: box, sphere, capsule, convex). </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the sweep object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the sweep. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Sweep distance. Needs to be larger than 0. Will be clamped to PX_MAX_SWEEP_DISTANCE. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>outputFlags</em> </td><td>Specifies which properties should be written to the hit information. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hit</em> </td><td>Sweep hit information. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags are set. If NULL, all hits are assumed to be blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cache</em> </td><td>Cached hit shape (optional). Sweep is performed against cached shape first then against the scene. Note: Filtering is not executed for a cached shape if supplied; instead, if a hit is found, it is assumed to be a blocking hit. Note: Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queryClient</em> </td><td>ID of the client doing the query </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inflation</em> </td><td>This parameter creates a skin around the swept geometry which increases its extents for sweeping. The sweep will register a hit as soon as the skin touches a shape, and will return the corresponding distance and normal. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found.</dd></dl> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000047">Deprecated:</a></b></dt><dd><a class="el" href="structPxActorClientBehaviorFlag.html" title="Multiclient behavior bit flags for actors.">PxActorClientBehaviorFlag</a> feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g2ddebd682bdb0bdb1db7ba113a93afe4">PxSceneQueryFlags</a> <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries.">PxSweepHit</a> <a class="el" href="group__extensions.html#g4d19f53556b8b6114e8a359d326c6d10">PxSceneQueryFilterData</a> <a class="el" href="group__extensions.html#gf9d442ec851f833a9276ddb7ea46dd23">PxSceneQueryFilterCallback</a> <a class="el" href="group__extensions.html#g871e9d89cdf9bbab58883b5f0822b5c3">PxSceneQueryCache</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxSceneQueryExt_8h-source.html">PxSceneQueryExt.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> |