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

PxContactPairHeader Struct Reference
+ +[Physics] +

An Instance of this class is passed to PxSimulationEventCallback.onContact(). +More... +

+#include <PxSimulationEventCallback.h> +

+

+Collaboration diagram for PxContactPairHeader:
+
+

Collaboration graph
+ +PxRigidActorPxActorPxBasePxShapePxFlags\< PxBaseFlag::Enum, PxU16 \>PxContactPairPxFlags\< PxContactPairFlag::Enum, PxU16 \>PxFlags\< PxPairFlag::Enum, PxU16 \>PxFlags\< PxContactPairHeaderFlag::Enum, PxU16 \> +
[legend]
+ +

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

Public Member Functions

PX_INLINE PxContactPairHeader ()

Public Attributes

PxRigidActor * actors [2]
 The two actors of the notification shape pairs.
const PxU8 * extraDataStream
 Stream containing extra data as requested in the PxPairFlag flags of the simulation filter.
PxU16 extraDataStreamSize
 Size of the extra data stream [bytes].
PxContactPairHeaderFlags flags
 Additional information on the contact report pair.
struct PxContactPair * pairs
 pointer to the contact pairs
PxU32 nbPairs
 number of contact pairs
+

Detailed Description

+An Instance of this class is passed to PxSimulationEventCallback.onContact(). +

+

See also:
PxSimulationEventCallback.onContact()
+

Constructor & Destructor Documentation

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

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxRigidActor* PxContactPairHeader::actors[2]
+
+
+ +

+The two actors of the notification shape pairs. +

+

Note:
The actor pointers might reference deleted actors. This will be the case if PxPairFlag::eNOTIFY_TOUCH_LOST or PxPairFlag::eNOTIFY_THRESHOLD_FORCE_LOST events were requested for the pair and one of the involved actors gets deleted or removed from the scene. Check the flags member to see whether that is the case. Do not dereference a pointer to a deleted actor. The pointer to a deleted actor is only provided such that user data structures which might depend on the pointer value can be updated.
+
See also:
PxActor
+ +
+

+ +

+
+ + + + +
const PxU8* PxContactPairHeader::extraDataStream
+
+
+ +

+Stream containing extra data as requested in the PxPairFlag flags of the simulation filter. +

+This pointer is only valid if any kind of extra data information has been requested for the contact report pair (see PxPairFlag::ePOST_SOLVER_VELOCITY etc.), else it will be NULL.

+

See also:
PxPairFlag
+ +
+

+ +

+
+ + + + +
PxU16 PxContactPairHeader::extraDataStreamSize
+
+
+ +

+Size of the extra data stream [bytes]. +

+ +

+

+ +

+
+ + + + +
PxContactPairHeaderFlags PxContactPairHeader::flags
+
+
+ +

+Additional information on the contact report pair. +

+

See also:
PxContactPairHeaderFlag
+ +
+

+ +

+
+ + + + +
PxU32 PxContactPairHeader::nbPairs
+
+
+ +

+number of contact pairs +

+ +

+

+ +

+
+ + + + +
struct PxContactPair* PxContactPairHeader::pairs [read]
+
+
+ +

+pointer to the contact pairs +

+ +

+

+

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