From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/group__scenequery.html | 377 +++++++++++++++++++++ 1 file changed, 377 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/group__scenequery.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__scenequery.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/group__scenequery.html b/PhysX_3.4/Documentation/PhysXAPI/files/group__scenequery.html new file mode 100644 index 00000000..802f5021 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/group__scenequery.html @@ -0,0 +1,377 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: Scenequery + + + + + + + +
+

Scenequery

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

class  PxBatchQuery
 Batched queries object. This is used to perform several queries at the same time. More...
struct  PxQueryFlag
 Filtering flags for scene queries. More...
struct  PxQueryHitType
 Classification of scene query hits (intersections). More...
struct  PxQueryFilterData
 Scene query filtering data. More...
class  PxQueryFilterCallback
 Scene query filtering callbacks. More...
struct  PxHitFlag
 Scene query and geometry query behavior flags. More...
struct  PxActorShape
 collection of set bits defined in PxHitFlag. More...
struct  PxQueryHit
 Scene query hit information. More...
struct  PxLocationHit
 Scene query hit information for raycasts and sweeps returning hit position and normal information. More...
struct  PxRaycastHit
 Stores results of raycast queries. More...
struct  PxOverlapHit
 Stores results of overlap queries. More...
struct  PxSweepHit
 Stores results of sweep queries. More...
struct  PxHitCallback< HitType >
 This callback class facilitates reporting scene query hits (intersections) to the user. More...
struct  PxHitBuffer< HitType >
 Returns scene query hits (intersections) to the user in a preallocated buffer. More...
struct  PxRaycastBufferN< N >
 Returns touching raycast hits to the user in a fixed size array embedded in the buffer class. More...
struct  PxOverlapBufferN< N >
 Returns touching overlap hits to the user in a fixed size array embedded in the buffer class. More...
struct  PxSweepBufferN< N >
 Returns touching sweep hits to the user in a fixed size array embedded in the buffer class. More...

Typedefs

typedef PxFlags
+< PxQueryFlag::Enum, PxU16 > 		PxQueryFlags
 Flags typedef for the set of bits defined in PxQueryFlag.
typedef PX_DEPRECATED
+PxQueryHitType::Enum(* 		PxBatchQueryPreFilterShader )(PxFilterData queryFilterData, PxFilterData objectFilterData, const void *constantBlock, PxU32 constantBlockSize, PxHitFlags &hitFlags)
 Batched query pre-filter shader.
typedef PX_DEPRECATED
+PxQueryHitType::Enum(* 		PxBatchQueryPostFilterShader )(PxFilterData queryFilterData, PxFilterData objectFilterData, const void *constantBlock, PxU32 constantBlockSize, const PxQueryHit &hit)
 Batched query post-filter shader.
typedef bool PxAgain
 Describes query behavior after returning a partial query result via a callback.
typedef PxHitCallback
+< PxRaycastHit > 		PxRaycastCallback
 Raycast query callback.
typedef PxHitCallback
+< PxOverlapHit > 		PxOverlapCallback
 Overlap query callback.
typedef PxHitCallback< PxSweepHit > PxSweepCallback
 Sweep query callback.
typedef PxHitBuffer< PxRaycastHit > PxRaycastBuffer
 Raycast query buffer.
typedef PxHitBuffer< PxOverlapHit > PxOverlapBuffer
 Overlap query buffer.
typedef PxHitBuffer< PxSweepHit > PxSweepBuffer
 Sweep query buffer.

Functions

 PX_COMPILE_TIME_ASSERT (PxQueryFlag::eSTATIC==(1<< 0))
 PX_COMPILE_TIME_ASSERT (PxQueryFlag::eDYNAMIC==(1<< 1))
+

Typedef Documentation

+ +
+
+ + + + +
typedef bool PxAgain
+
+
+ +

+Describes query behavior after returning a partial query result via a callback. +

+If callback returns true, traversal will continue and callback can be issued again. If callback returns false, traversal will stop, callback will not be issued again.

+

See also:
PxHitCallback
+ +
+

+ +

+
+ + + + +
typedef PX_DEPRECATED PxQueryHitType::Enum(* PxBatchQueryPostFilterShader)(PxFilterData queryFilterData, PxFilterData objectFilterData, const void *constantBlock, PxU32 constantBlockSize, const PxQueryHit &hit)
+
+
+ +

+Batched query post-filter shader. +

+Custom filtering logic for batched query intersection candidates. If an intersection candidate object passes the data based filter (see PxQueryFilterData), the filtering shader run on request (see PxQueryFilterData.flags)

+

    +
  • If PxQueryFlag::ePOSTFILTER is set, the postFilter shader is called for each intersection to determine the touch/block status. This overrides any touch/block status previously returned from the preFilter function for this shape.
    • +
+Filtering shaders are not in order along the query direction, rather they are processed in the order in which candidate shapes for testing are found by PhysX' scene traversal algorithms.

+

Deprecated:
The batched query feature has been deprecated in PhysX version 3.4
+
See also:
PxBatchQueryDesc.postFilterShader PxQueryFilterCallback.postFilter PxBatchQueryPreFilterShader
+
Parameters:
+ + + + + + +
[in] queryFilterData Query filter data
[in] objectFilterData Object filter data
[in] constantBlock Global constant filter data (see PxBatchQuery)
[in] constantBlockSize Size of global filter data (see PxBatchQuery)
[in] hit Hit data from the prior exact intersection test.
+
+
Returns:
the new hit type for this hit (see PxQueryHitType)
+
See also:
PxBatchQueryPreFilterShader
+ +
+

+ +

+
+ + + + +
typedef PX_DEPRECATED PxQueryHitType::Enum(* PxBatchQueryPreFilterShader)(PxFilterData queryFilterData, PxFilterData objectFilterData, const void *constantBlock, PxU32 constantBlockSize, PxHitFlags &hitFlags)
+
+
+ +

+Batched query pre-filter shader. +

+Custom filtering logic for batched query intersection candidates. If an intersection candidate object passes the data based filter (see PxQueryFilterData), filtering shader runs if specified in filtering flags (see PxQueryFilterData.flags)

+

+The preFilter shader may overwrite the copy of queryFlags it receives as an argument to specify any of PxHitFlag::eMODIFIABLE_FLAGS on a per-shape basis. Changes apply only to the shape being filtered, and changes to other flags are ignored.

+

    +
  • If PxQueryFlag::ePREFILTER is not set, precise intersection testing is performed using the original query's filterData.flags.
    • +
+Filtering calls are not guaranteed to be sorted along the ray or sweep direction.

+

Deprecated:
The batched query feature has been deprecated in PhysX version 3.4
+
See also:
PxBatchQueryDesc.preFilterShader PxQueryFilterCallback.preFilter PxBatchQueryPostFilterShader
+
Parameters:
+ + + + + + +
[in] queryFilterData Query filter data
[in] objectFilterData Object filter data
[in] constantBlock Global constant filter data (see PxBatchQuery)
[in] constantBlockSize Size of global filter data (see PxBatchQuery)
[in,out] hitFlags Per-object modifiable hit flags (only flags from PxHitFlag::eMODIFIABLE_FLAGS mask can be modified)
+
+
Returns:
the updated hit type for this hit (see PxQueryHitType)
+
See also:
PxBatchQueryPostFilterShader
+ +
+

+ +

+
+ + + + +
typedef PxHitBuffer<PxOverlapHit> PxOverlapBuffer
+
+
+ +

+Overlap query buffer. +

+ +

+

+ +

+
+ + + + +
typedef PxHitCallback<PxOverlapHit> PxOverlapCallback
+
+
+ +

+Overlap query callback. +

+ +

+

+ +

+
+ + + + +
typedef PxFlags<PxQueryFlag::Enum,PxU16> PxQueryFlags
+
+
+ +

+Flags typedef for the set of bits defined in PxQueryFlag. +

+ +

+

+ +

+
+ + + + +
typedef PxHitBuffer<PxRaycastHit> PxRaycastBuffer
+
+
+ +

+Raycast query buffer. +

+ +

+

+ +

+
+ + + + +
typedef PxHitCallback<PxRaycastHit> PxRaycastCallback
+
+
+ +

+Raycast query callback. +

+ +

+

+ +

+
+ + + + +
typedef PxHitBuffer<PxSweepHit> PxSweepBuffer
+
+
+ +

+Sweep query buffer. +

+ +

+

+ +

+
+ + + + +
typedef PxHitCallback<PxSweepHit> PxSweepCallback
+
+
+ +

+Sweep query callback. +

+ +

+

+

Function Documentation

+ +
+
+ + + + + + + + + +
PX_COMPILE_TIME_ASSERT (PxQueryFlag::eDYNAMIC  = =(1<< 1)  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_COMPILE_TIME_ASSERT (PxQueryFlag::eSTATIC  = =(1<< 0)  ) 
+
+
+ +

+ +

+

+

+ +

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3