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

PxLocationHit Struct Reference
+ +[Scenequery] +

Scene query hit information for raycasts and sweeps returning hit position and normal information. +More... +

+#include <PxQueryReport.h> +

+

+Inheritance diagram for PxLocationHit:
+
+

Inheritance graph
+ +PxRaycastHitPxSweepHitPxQueryHitPxActorShape +
[legend]
+
+Collaboration diagram for PxLocationHit:
+
+

Collaboration graph
+ +PxQueryHitPxActorShapePxRigidActorPxActorPxBasePxShapePxFlags\< PxBaseFlag::Enum, PxU16 \>PxVec3 +
[legend]
+ +

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

Public Member Functions

PX_INLINE PxLocationHit ()
PX_INLINE bool hadInitialOverlap () const

Public Attributes

PxHitFlags flags
 Hit flags specifying which members contain valid values.
PxVec3 position
PxVec3 normal
 World-space hit normal (flag: PxHitFlag::eNORMAL).
PxF32 distance
 Distance to hit.
+

Detailed Description

+Scene query hit information for raycasts and sweeps returning hit position and normal information. +

+PxHitFlag flags can be passed to scene query functions, as an optimization, to cause the SDK to only generate specific members of this structure.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PX_INLINE PxLocationHit::PxLocationHit (  )  [inline]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
PX_INLINE bool PxLocationHit::hadInitialOverlap (  )  const [inline]
+
+
+ +

+

Note:
For raycast hits: true for shapes overlapping with raycast origin.

+For sweep hits: true for shapes overlapping at zero sweep distance.

+
See also:
PxRaycastHit PxSweepHit
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
PxF32 PxLocationHit::distance
+
+
+ +

+Distance to hit. +

+

Note:
If the eMTD flag is used, distance will be a negative value if shapes are overlapping indicating the penetration depth.

+Otherwise, this value will be >= 0 (flag: PxHitFlag::eDISTANCE)

+ +
+

+ +

+
+ + + + +
PxHitFlags PxLocationHit::flags
+
+
+ +

+Hit flags specifying which members contain valid values. +

+ +

+

+ +

+
+ + + + +
PxVec3 PxLocationHit::normal
+
+
+ +

+World-space hit normal (flag: PxHitFlag::eNORMAL). +

+ +

+

+ +

+
+ + + + +
PxVec3 PxLocationHit::position
+
+
+ +

+World-space hit position (flag: PxHitFlag::ePOSITION) Formerly known as .impact, renamed for clarity. +

+

+

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