PhysX SDK 3.2 API Reference: PxContactPair Struct Reference

PhysX SDK 3.2 API

previous page next page

PxContactPair Struct Reference
[Physics]

Contact report pair information. More...

#include <PxSimulationEventCallback.h>

Collaboration diagram for PxContactPair:

Collaboration graph
PxFlags\< PxContactPairFlag::Enum, PxU16 \>PxFlags\< PxPairFlag::Enum, PxU16 \>PxShapePxSerializablePxFlags\< PxSerialFlag::Enum, PxU16 \>
[legend]

List of all members.


Public Member Functions

PX_INLINE PxContactPair ()
PX_INLINE PxU32 extractContacts (PxContactPairPoint *userBuffer, PxU32 bufferSize) const
 Extracts the contact points from the stream and stores them in a convenient format.

Public Attributes

PxShape * shapes [2]
 The two shapes that make up the pair.
const PxU8 * contactStream
 Contact stream containing contact point data.
PxU32 requiredBufferSize
 Size of the contact stream [bytes].
PxU16 contactCount
 Number of contact points stored in the contact stream.
PxContactPairFlags flags
 Additional information on the contact report pair.
PxPairFlags events
 Flags raised due to the contact.
PxU32 internalData [2]

Detailed Description

Contact report pair information.

Instances of this class are passed to PxSimulationEventCallback.onContact(). If contact reports have been requested for a pair of shapes (see PxPairFlag), then the corresponding contact information will be provided through this structure.

See also:
PxSimulationEventCallback.onContact()

Constructor & Destructor Documentation

PX_INLINE PxContactPair::PxContactPair (  )  [inline]

Member Data Documentation

PxU16 PxContactPair::contactCount

Number of contact points stored in the contact stream.

Referenced by extractContacts().

const PxU8* PxContactPair::contactStream

Contact stream containing contact point data.

This pointer is only valid if contact point information has been requested for the contact report pair (see PxPairFlag::eNOTIFY_CONTACT_POINTS). Use extractContacts() as a reference for the data layout of the stream.

Referenced by extractContacts().

PxPairFlags PxContactPair::events

Flags raised due to the contact.

The events field is a combination of:

See the documentation of PxPairFlag for an explanation of each.

See also:
PxPairFlag

PxContactPairFlags PxContactPair::flags

Additional information on the contact report pair.

See also:
PxContactPairFlag

Referenced by extractContacts().

PxU32 PxContactPair::internalData[2]

PxU32 PxContactPair::requiredBufferSize

Size of the contact stream [bytes].

PxShape* PxContactPair::shapes[2]

The two shapes that make up the pair.

Note:
The shape pointers might reference deleted shapes. 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 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:
PxShape

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


Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com
previous page start next page