API Reference

Class List

pc.CollisionComponent

Extends: pc.Component

A collision volume. use this in conjunction with a pc.RigidBodyComponent to make a collision volume that can be simulated using the physics engine.

If the pc.Entity does not have a pc.RigidBodyComponent then this collision volume will act as a trigger volume. When an entity with a dynamic or kinematic body enters or leaves an entity with a trigger volume, both entities will receive trigger events.

The following table shows all the events that can be fired between two Entities:

Rigid Body (Static)Rigid Body (Dynamic or Kinematic)Trigger Volume
Rigid Body (Static) -
  • contact
  • collisionstart
  • collisionend
-
Rigid Body (Dynamic or Kinematic)
  • contact
  • collisionstart
  • collisionend
  • contact
  • collisionstart
  • collisionend
  • triggerenter
  • triggerleave
Trigger Volume -
  • triggerenter
  • triggerleave
-

Summary

Properties

assetThe asset for the model of the mesh collision volume - can also be an asset id.
axisThe local space axis with which the capsule or cylinder-shaped collision volume's length is aligned.
halfExtentsThe half-extents of the box-shaped collision volume in the x, y and z axes.
heightThe total height of the capsule or cylinder-shaped collision volume from tip to tip.
modelThe model that is added to the scene graph for the mesh collision volume.
radiusThe radius of the sphere, capsule or cylinder-shaped collision volumes.
typeThe type of the collision volume.

Events

collisionendThe 'collisionend' event is fired two rigid-bodies stop touching.
collisionstartThe 'collisionstart' event is fired when two rigid bodies start touching.
contactThe 'contact' event is fired when a contact occurs between two rigid bodies
triggerenterThe 'triggerenter' event is fired when a rigid body enters a trigger volume.
triggerleaveThe 'triggerleave' event is fired when a rigid body exits a trigger volume.

Inherited

Properties

enabledEnables or disables the component.

Details

Constructor

CollisionComponent(system, entity)

Create a new CollisionComponent

Parameters

systempc.CollisionComponentSystemThe ComponentSystem that created this Component
entitypc.EntityThe Entity that this Component is attached to.

Properties

pc.Assetasset

The asset for the model of the mesh collision volume - can also be an asset id.

Numberaxis

The local space axis with which the capsule or cylinder-shaped collision volume's length is aligned. 0 for X, 1 for Y and 2 for Z. Defaults to 1 (Y-axis).

pc.Vec3halfExtents

The half-extents of the box-shaped collision volume in the x, y and z axes. Defaults to [0.5, 0.5, 0.5]

Numberheight

The total height of the capsule or cylinder-shaped collision volume from tip to tip. Defaults to 2.

pc.Modelmodel

The model that is added to the scene graph for the mesh collision volume.

Numberradius

The radius of the sphere, capsule or cylinder-shaped collision volumes. Defaults to 0.5

Stringtype

The type of the collision volume. Defaults to 'box'. Can be one of the following:

  • box: A box-shaped collision volume.
  • sphere: A sphere-shaped collision volume.
  • capsulse: A capsule-shaped collision volume.
  • cylinder: A cylinder-shaped collision volume.
  • mesh: A collision volume that uses a model asset as its shape.

Events

collisionend

The 'collisionend' event is fired two rigid-bodies stop touching.

Parameters

otherpc.EntityThe pc.Entity that stopped touching this collision volume.

collisionstart

The 'collisionstart' event is fired when two rigid bodies start touching.

Parameters

resultpc.ContactResultDetails of the contact between the two Entities.

contact

The 'contact' event is fired when a contact occurs between two rigid bodies

Parameters

resultpc.ContactResultDetails of the contact between the two rigid bodies.

triggerenter

The 'triggerenter' event is fired when a rigid body enters a trigger volume. a pc.RigidBodyComponent attached.

Parameters

otherpc.EntityThe pc.Entity that entered this collision volume.

triggerleave

The 'triggerleave' event is fired when a rigid body exits a trigger volume. a pc.RigidBodyComponent attached.

Parameters

otherpc.EntityThe pc.Entity that exited this collision volume.

Inherited

Properties

Booleanenabled

Enables or disables the component.