PhysX Collider Component

The PhysX Collider component adds a PhysX collider to an entity so that the entity can be included in PhysX simulation. The collider can be defined by a mesh you create, automatically generated convex meshes, shapes that have been automatically fit to a decomposed mesh, or a simple shape primitive selected in the the PhysX Collider component. The PhysX Collider component can also define a trigger area or a force region.

Note:

The PhysX Collider component attached to an entity by itself creates a static (non-moving) entity. Add a PhysX Rigid Body component with a PhysX Collider component to create a dynamic or a kinematic entity. Dynamic entities have simulated movement in response to collisions and forces. Kinematic entities aren’t affected by collisions or forces, but are driven by scripted movement. For information about the various PhysX collider types and how to process them, refer to Process PhysX Collider Assets.

Provider

PhysX Gem

Properties

Base properties

Shape properties

Sets the collider for the collider component. A collider can be a primitive shape or a physics asset. Primitive shape colliders are not meshes. They are defined by simple dimension parameters that describe a box, sphere, or capsule. Primitive shape colliders are high performance, but they may not accurately represent the surface of the mesh provided by a Mesh component. Physics asset colliders are based on meshes that are processed by Asset Processor. Physics asset colliders can more accurately represent the shape of the mesh provided by a Mesh component, but incur a higher performance cost over primitive shapes. This property is set automatically if a .pxmesh product asset exists for the associated mesh or actor asset. For information on processing collider assets, refer to Process PhysX Collider Assets .

• PhysicsAsset
• Sphere
• Box
• Capsule

Collider component mode

In collider component mode, you can edit colliders with manipulators in the viewport. To enter collider component mode, choose the Edit button at the bottom of the PhysX Collider component properties in the Entity Inspector.

Sub component modes

There are three editing modes available in collider component mode.

Resize (Sphere Shape)

Sphere resize mode has one linear manipulator that controls the Radius property.

Resize (Box Shape)

Box resize mode has six linear manipulators, one on each side of the box. The manipulators control the width, depth, and height Dimensions property.

Resize (Capsule Shape)

Capsule resize mode has two linear manipulators. The manipulator at the top of the capsule controls the Height property. The manipulator on the side controls the Radius property.

Offset

Offset mode has a three-axis translate manipulator.

Rotation

Rotation mode has a three-axis rotate manipulator.

Resize (Physics Asset Shape)

Physics Asset resize mode has a three-axis scale manipulator.

Collider component mode hotkeys

The following navigation hotkeys are available in collider component mode.

Colliders as triggers

Triggers allow colliders to perform efficient overlap tests. Colliders marked as triggers won’t be affected by forces when they intersect with another collider. This is useful for detecting when something enters a certain area or when two objects overlap. Use Lua or Script Canvas to detect overlap.

Note:

Because triggers don’t perform contact resolution, the contact points between a trigger and another collider aren’t available. Triangle meshes are not supported as triggers.