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

PxTriggerPair Struct Reference
+ +[Physics] +

Descriptor for a trigger pair. +More... +

+#include <PxSimulationEventCallback.h> +

+

+Collaboration diagram for PxTriggerPair:
+
+

Collaboration graph
+ +PxRigidActorPxActorPxBasePxShapePxFlags\< PxBaseFlag::Enum, PxU16 \>PxFlags\< PxTriggerPairFlag::Enum, PxU8 \> +
[legend]
+ +

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

Public Member Functions

PX_INLINE PxTriggerPair ()

Public Attributes

PxShape * triggerShape
 The shape that has been marked as a trigger.
PxRigidActor * triggerActor
 The actor to which triggerShape is attached.
PxShape * otherShape
 The shape causing the trigger event.
PxRigidActor * otherActor
 The actor to which otherShape is attached.
PxPairFlag::Enum status
 Type of trigger event (eNOTIFY_TOUCH_FOUND or eNOTIFY_TOUCH_LOST). eNOTIFY_TOUCH_PERSISTS events are not supported.
PxTriggerPairFlags flags
 Additional information on the pair (see PxTriggerPairFlag).
+

Detailed Description

+Descriptor for a trigger pair. +

+An array of these structs gets passed to the PxSimulationEventCallback::onTrigger() report.

+

Note:
The shape pointers might reference deleted shapes. This will be the case if PxPairFlag::eNOTIFY_TOUCH_LOST events were requested for the pair and one of the involved shapes gets deleted. Check the flags member to see whether that is the case. Do not dereference a pointer to a deleted shape. The pointer to a deleted shape is only provided such that user data structures which might depend on the pointer value can be updated.
+
See also:
PxSimulationEventCallback.onTrigger()
+

Constructor & Destructor Documentation

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

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxTriggerPairFlags PxTriggerPair::flags
+
+
+ +

+Additional information on the pair (see PxTriggerPairFlag). +

+ +

+

+ +

+
+ + + + +
PxRigidActor* PxTriggerPair::otherActor
+
+
+ +

+The actor to which otherShape is attached. +

+ +

+

+ +

+
+ + + + +
PxShape* PxTriggerPair::otherShape
+
+
+ +

+The shape causing the trigger event. +

+

Deprecated:
(see PxSimulationEventCallback::onTrigger()) If collision between trigger shapes is enabled, then this member might point to a trigger shape as well.
+ +
+

+ +

+
+ + + + +
PxPairFlag::Enum PxTriggerPair::status
+
+
+ +

+Type of trigger event (eNOTIFY_TOUCH_FOUND or eNOTIFY_TOUCH_LOST). eNOTIFY_TOUCH_PERSISTS events are not supported. +

+ +

+

+ +

+
+ + + + +
PxRigidActor* PxTriggerPair::triggerActor
+
+
+ +

+The actor to which triggerShape is attached. +

+ +

+

+ +

+
+ + + + +
PxShape* PxTriggerPair::triggerShape
+
+
+ +

+The shape that has been marked as a trigger. +

+ +

+

+

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