diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxQueryCache.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxQueryCache.html | 183 |
1 files changed, 183 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxQueryCache.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxQueryCache.html new file mode 100644 index 00000000..99dc6213 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxQueryCache.html @@ -0,0 +1,183 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxQueryCache 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>PxQueryCache Struct Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxQueryCache" -->single hit cache for scene queries. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxScene_8h-source.html">PxScene.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxQueryCache:</div> +<div class="dynsection"> +<p><center><img src="structPxQueryCache__coll__graph.png" border="0" usemap="#PxQueryCache__coll__map" alt="Collaboration graph"></center> +<map name="PxQueryCache__coll__map"> +<area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="39,270,121,291"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="60,179,113,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,107,153,128"><area shape="rect" href="classPxShape.html" title="Abstract class for collision shapes." alt="PxShape" coords="132,224,196,246"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,38"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxQueryCache-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 Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryCache.html#810ecb74536e940be1719d60aedfd3cd">PxQueryCache</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor sets to default <a href="#810ecb74536e940be1719d60aedfd3cd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryCache.html#ec86c57516de749a1e2b658a8cb5e5bd">PxQueryCache</a> (<a class="el" href="classPxShape.html">PxShape</a> *s, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> findex)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor to set properties <a href="#ec86c57516de749a1e2b658a8cb5e5bd"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxShape.html">PxShape</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryCache.html#8104d15f64ccdecf8f4d31c9bb5af409">shape</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Shape to test for intersection first. <a href="#8104d15f64ccdecf8f4d31c9bb5af409"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryCache.html#83f3c62b437087d7fab306d003f383a7">actor</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Actor to which the shape belongs. <a href="#83f3c62b437087d7fab306d003f383a7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryCache.html#5d0d3a21b50e766b90c903145592cc7c">faceIndex</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Triangle index to test first - NOT CURRENTLY SUPPORTED. <a href="#5d0d3a21b50e766b90c903145592cc7c"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +single hit cache for scene queries. +<p> +If a cache object is supplied to a scene query, the cached actor/shape pair is checked for intersection first. <dl class="note" compact><dt><b>Note:</b></dt><dd>Filters are not executed for the cached shape. <p> +If intersection is found, the hit is treated as blocking. <p> +Typically actor and shape from the last <a class="el" href="structPxHitCallback.html#63b2851eaf99b190fc468e00e8d1e55d" title="Holds the closest blocking hit result for the query. Invalid if hasBlock is false...">PxHitCallback.block</a> query result is used as a cached actor/shape pair. <p> +Using past touching hits as cache will produce incorrect behavior since the cached hit will always be treated as blocking. <p> +Cache is only used if no touch buffer was provided, for single nearest blocking hit queries and queries using eANY_HIT flag. <p> +if non-zero touch buffer was provided, cache will be ignored<p> +It is the user's responsibility to ensure that the shape and actor are valid, so care must be taken when deleting shapes to invalidate cached references.</dd></dl> +The faceIndex field is an additional hint for a mesh or height field which is not currently used.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#7d7dcd877cee092f8b57c67d79982b50" title="Performs a raycast against objects in the scene, returns results in a PxRaycastBuffer...">PxScene.raycast</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="810ecb74536e940be1719d60aedfd3cd"></a><!-- doxytag: member="PxQueryCache::PxQueryCache" ref="810ecb74536e940be1719d60aedfd3cd" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxQueryCache::PxQueryCache </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor sets to default +<p> + +</div> +</div><p> +<a class="anchor" name="ec86c57516de749a1e2b658a8cb5e5bd"></a><!-- doxytag: member="PxQueryCache::PxQueryCache" ref="ec86c57516de749a1e2b658a8cb5e5bd" args="(PxShape *s, PxU32 findex)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxQueryCache::PxQueryCache </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxShape.html">PxShape</a> * </td> + <td class="paramname"> <em>s</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>findex</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor to set properties +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="83f3c62b437087d7fab306d003f383a7"></a><!-- doxytag: member="PxQueryCache::actor" ref="83f3c62b437087d7fab306d003f383a7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxRigidActor.html">PxRigidActor</a>* <a class="el" href="structPxQueryCache.html#83f3c62b437087d7fab306d003f383a7">PxQueryCache::actor</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Actor to which the shape belongs. +<p> + +</div> +</div><p> +<a class="anchor" name="5d0d3a21b50e766b90c903145592cc7c"></a><!-- doxytag: member="PxQueryCache::faceIndex" ref="5d0d3a21b50e766b90c903145592cc7c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="structPxQueryCache.html#5d0d3a21b50e766b90c903145592cc7c">PxQueryCache::faceIndex</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Triangle index to test first - NOT CURRENTLY SUPPORTED. +<p> + +</div> +</div><p> +<a class="anchor" name="8104d15f64ccdecf8f4d31c9bb5af409"></a><!-- doxytag: member="PxQueryCache::shape" ref="8104d15f64ccdecf8f4d31c9bb5af409" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxShape.html">PxShape</a>* <a class="el" href="structPxQueryCache.html#8104d15f64ccdecf8f4d31c9bb5af409">PxQueryCache::shape</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Shape to test for intersection first. +<p> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="PxScene_8h-source.html">PxScene.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> |