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

PxHitBuffer< HitType > Struct Template Reference
+ +[Scenequery] +

Returns scene query hits (intersections) to the user in a preallocated buffer. +More... +

+#include <PxQueryReport.h> +

+

+Inheritance diagram for PxHitBuffer< HitType >:
+
+

Inheritance graph
+ +PxHitCallback\< HitType \> +
[legend]
+
+Collaboration diagram for PxHitBuffer< HitType >:
+
+

Collaboration graph
+ +PxHitCallback\< HitType \> +
[legend]
+ +

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

Public Member Functions

 PxHitBuffer (HitType *aTouches=NULL, PxU32 aMaxNbTouches=0)
 Initializes the buffer with user memory.
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.
PX_INLINE PxU32 getNbTouches () const
PX_INLINE const HitType * getTouches () const
PX_INLINE const HitType & getTouch (const PxU32 index) const
PX_INLINE PxU32 getMaxNbTouches () const
virtual ~PxHitBuffer ()

Protected Member Functions

virtual PxAgain processTouches (const HitType *buffer, PxU32 nbHits)
 virtual callback function used to communicate query results to the user.
+

Detailed Description

+

template<typename HitType>
+ struct PxHitBuffer< HitType >

+ +Returns scene query hits (intersections) to the user in a preallocated buffer. +

+Will clip touch hits to maximum buffer capacity. When clipped, an arbitrary subset of touching hits will be discarded. Overflow does not trigger warnings or errors. block and hasBlock will be valid in finalizeQuery callback and after query completion. Touching hits are guaranteed to have closer or same distance ( <= condition) as the globally nearest blocking hit at the time any processTouches() callback is issued.

+

Note:
Pre-made typedef shorthands, such as PxRaycastBuffer can be used for raycast, overlap and sweep queries.
+
See also:
PxHitCallback

+PxRaycastBuffer PxOverlapBuffer PxSweepBuffer PxRaycastBufferN PxOverlapBufferN PxSweepBufferN

+

Constructor & Destructor Documentation

+ +
+
+
+template<typename HitType>
+ + + + + + + + + + + + + + + + + + +
PxHitBuffer< HitType >::PxHitBuffer (HitType *  aTouches = NULL,
PxU32  aMaxNbTouches = 0 
) [inline]
+
+
+ +

+Initializes the buffer with user memory. +

+The buffer is initialized with 0 touch hits by default => query will only report a single closest blocking hit. Use PxQueryFlag::eANY_HIT to tell the query to abort and return any first hit encoutered as blocking.

+

Parameters:
+ + + +
[in] aTouches Optional buffer for recording PxQueryHitType::eTOUCH type hits.
[in] aMaxNbTouches Size of touch buffer.
+
+
See also:
PxHitCallback
+ +
+

+ +

+
+
+template<typename HitType>
+ + + + + + + + +
virtual PxHitBuffer< HitType >::~PxHitBuffer (  )  [inline, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

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

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

+ +

+

+ +

+
+
+template<typename HitType>
+ + + + + + + + +
PX_INLINE PxU32 PxHitBuffer< HitType >::getMaxNbTouches (  )  const [inline]
+
+
+ +

+ +

+

+ +

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

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

+ +

+

+ +

+
+
+template<typename HitType>
+ + + + + + + + +
PX_INLINE PxU32 PxHitBuffer< HitType >::getNbTouches (  )  const [inline]
+
+
+ +

+ +

+

+ +

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

+ +

+

+ +

+
+
+template<typename HitType>
+ + + + + + + + +
PX_INLINE const HitType* PxHitBuffer< HitType >::getTouches (  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+
+template<typename HitType>
+ + + + + + + + + + + + + + + + + + +
virtual PxAgain PxHitBuffer< HitType >::processTouches (const HitType *  buffer,
PxU32  nbHits 
) [inline, protected, virtual]
+
+
+ +

+virtual callback function used to communicate query results to the user. +

+This callback will always be invoked with touches as a buffer if touches was specified as non-NULL. All reported touch hits are guaranteed to be closer than the closest blocking hit.

+

Parameters:
+ + + +
[in] buffer Callback will report touch hits to the user in this buffer. This pointer will be the same as touches.
[in] nbHits Number of touch hits reported in buffer. This number will not exceed maxNbTouches.
+
+
Note:
There is a significant performance penalty in case multiple touch callbacks are issued (up to 2x)

+to avoid the penalty use a bigger buffer so that all touching hits can be reported in a single buffer.

+If true (again) is returned from the callback, nbTouches will be reset to 0,

+If false is returned, nbTouched will remain unchanged.

+By the time processTouches is first called, the globally closest blocking hit is already determined,

+values of hasBlock and block are final and all touch hits are guaranteed to be closer than the blocking hit.

+touches and maxNbTouches can be modified inside of processTouches callback.

+
Returns:
true to continue receiving callbacks in case there are more hits or false to stop.
+
See also:
PxAgain PxRaycastHit PxSweepHit PxOverlapHit
+ +

Implements PxHitCallback< HitType >.

+ +
+

+

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