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/structPxBatchQueryResult.html | 264 +++++++++++++++++++++ 1 file changed, 264 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/structPxBatchQueryResult.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxBatchQueryResult.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxBatchQueryResult.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxBatchQueryResult.html new file mode 100644 index 00000000..b88734c9 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxBatchQueryResult.html @@ -0,0 +1,264 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBatchQueryResult< HitType > Struct Template Reference + + + + + + + +
+

PxBatchQueryResult< HitType > Struct Template Reference
+ +[Physics] +

Generic struct for receiving results of single query in a batch. Gets templated on hit type PxRaycastHit, PxSweepHit or PxOverlapHit. +More... +

+#include <PxBatchQueryDesc.h> +

+

+Collaboration diagram for PxBatchQueryResult< HitType >:
+
+

Collaboration graph
+
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

PX_INLINE PxU32 getNbAnyHits () const
 Computes the number of any hits in this result, blocking or touching.
PX_INLINE const HitType & getAnyHit (const PxU32 index) const
 Convenience iterator used to access any hits in this result, blocking or touching.

Public Attributes

HitType block
 Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true.
HitType * touches
PxU32 nbTouches
 Number of touching hits returned by this query, works in tandem with touches pointer.
void * userData
 Copy of the userData pointer specified in the corresponding query.
PxU8 queryStatus
 Takes on values from PxBatchQueryStatus::Enum.
bool hasBlock
 True if there was a blocking hit.
PxU16 pad
 pads the struct to 16 bytes.
+

Detailed Description

+

template<typename HitType>
+ struct PxBatchQueryResult< HitType >

+ +Generic struct for receiving results of single query in a batch. Gets templated on hit type PxRaycastHit, PxSweepHit or PxOverlapHit. +

+

Deprecated:
The batched query feature has been deprecated in PhysX version 3.4
+

Member Function Documentation

+ +
+
+
+template<typename HitType >
+ + + + + + + + + +
PX_INLINE const HitType& PxBatchQueryResult< HitType >::getAnyHit (const PxU32  index  )  const [inline]
+
+
+ +

+Convenience iterator used to access any hits in this result, blocking or touching. +

+ +

References PX_ASSERT.

+ +
+

+ +

+
+
+template<typename HitType >
+ + + + + + + + +
PX_INLINE PxU32 PxBatchQueryResult< HitType >::getNbAnyHits (  )  const [inline]
+
+
+ +

+Computes the number of any hits in this result, blocking or touching. +

+ +

+

+

Member Data Documentation

+ +
+
+
+template<typename HitType >
+ + + + +
HitType PxBatchQueryResult< HitType >::block
+
+
+ +

+Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true. +

+ +

+

+ +

+
+
+template<typename HitType >
+ + + + +
bool PxBatchQueryResult< HitType >::hasBlock
+
+
+ +

+True if there was a blocking hit. +

+ +

+

+ +

+
+
+template<typename HitType >
+ + + + +
PxU32 PxBatchQueryResult< HitType >::nbTouches
+
+
+ +

+Number of touching hits returned by this query, works in tandem with touches pointer. +

+ +

+

+ +

+
+
+template<typename HitType >
+ + + + +
PxU16 PxBatchQueryResult< HitType >::pad
+
+
+ +

+pads the struct to 16 bytes. +

+ +

+

+ +

+
+
+template<typename HitType >
+ + + + +
PxU8 PxBatchQueryResult< HitType >::queryStatus
+
+
+ +

+Takes on values from PxBatchQueryStatus::Enum. +

+ +

+

+ +

+
+
+template<typename HitType >
+ + + + +
HitType* PxBatchQueryResult< HitType >::touches
+
+
+ +

+This pointer will either be set to NULL for 0 nbTouches or will point into the user provided batch query results buffer specified in PxBatchQueryDesc. +

+

+ +

+
+
+template<typename HitType >
+ + + + +
void* PxBatchQueryResult< HitType >::userData
+
+
+ +

+Copy of the userData pointer specified in the corresponding query. +

+ +

+

+

The documentation for this struct was generated from the following file: +
+ +

+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