NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxShapeFlag Struct Reference

NVIDIA PhysX SDK 3.4 API

PxShapeFlag Struct Reference
[Physics]

Flags which affect the behavior of PxShapes. More...

#include <PxShape.h>

List of all members.


Public Types

enum  Enum {
  eSIMULATION_SHAPE = (1<<0),
  eSCENE_QUERY_SHAPE = (1<<1),
  eTRIGGER_SHAPE = (1<<2),
  eVISUALIZATION = (1<<3),
  ePARTICLE_DRAIN = (1<<4)
}

Detailed Description

Flags which affect the behavior of PxShapes.

See also:
PxShape PxShape.setFlag()

Member Enumeration Documentation

Enumerator:
eSIMULATION_SHAPE  The shape will partake in collision in the physical simulation.

Note:
It is illegal to raise the eSIMULATION_SHAPE and eTRIGGER_SHAPE flags. In the event that one of these flags is already raised the sdk will reject any attempt to raise the other. To raise the eSIMULATION_SHAPE first ensure that eTRIGGER_SHAPE is already lowered.

This flag has no effect if simulation is disabled for the corresponding actor (see PxActorFlag::eDISABLE_SIMULATION).

See also:
PxSimulationEventCallback.onContact() PxScene.setSimulationEventCallback() PxShape.setFlag(), PxShape.setFlags()

eSCENE_QUERY_SHAPE  The shape will partake in scene queries (ray casts, overlap tests, sweeps, ...).
eTRIGGER_SHAPE  The shape is a trigger which can send reports whenever other shapes enter/leave its volume.

Note:
Triangle meshes and heightfields can not be triggers. Shape creation will fail in these cases.

Shapes marked as triggers do not collide with other objects. If an object should act both as a trigger shape and a collision shape then create a rigid body with two shapes, one being a trigger shape and the other a collision shape. It is illegal to raise the eTRIGGER_SHAPE and eSIMULATION_SHAPE flags on a single PxShape instance. In the event that one of these flags is already raised the sdk will reject any attempt to raise the other. To raise the eTRIGGER_SHAPE flag first ensure that eSIMULATION_SHAPE flag is already lowered.

Trigger shapes will no longer send notification events for interactions with other trigger shapes. For PhysX 3.4 there is the option to re-enable the reports by raising PxSceneFlag::eDEPRECATED_TRIGGER_TRIGGER_REPORTS. In PhysX 3.5 there will be no support for these reports any longer. See the 3.4 migration guide for more information.

Shapes marked as triggers are allowed to participate in scene queries, provided the eSCENE_QUERY_SHAPE flag is set.

This flag has no effect if simulation is disabled for the corresponding actor (see PxActorFlag::eDISABLE_SIMULATION).

See also:
PxSimulationEventCallback.onTrigger() PxScene.setSimulationEventCallback() PxShape.setFlag(), PxShape.setFlags()

eVISUALIZATION  Enable debug renderer for this shape.

See also:
PxScene.getRenderBuffer() PxRenderBuffer PxVisualizationParameter

ePARTICLE_DRAIN  Sets the shape to be a particle drain.


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



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