core/com.pico.spatial.core.ecs/RigidBodyComponent

RigidBodyComponent

@MainThread

A Component responsible for defining the properties of the rigid body, including its RigidBodyMode, MassProperties, CollisionDetectionMode, linear and angular damping, gravity influence, and constraints on translation or rotation in specific directions.

Constructors

RigidBodyComponent

constructor()

The default constructor.

constructor(massProperties: MassProperties, rigidBodyMode: RigidBodyMode)

Constructs a RigidBodyComponent with the specified MassProperties and RigidBodyMode.

Properties

angularDamping

var angularDamping: Float

Controls how fast a dynamic rigid body’s rotational motion approaches the zero rest state. Default value is 0.05.

collisionDetectionMode

var collisionDetectionMode: CollisionDetectionMode

Controls the collision detection mode used in physics simulation. Default value is CollisionDetectionMode.DISCRETE.

isAffectedByGravity

var isAffectedByGravity: Boolean

Determines whether the simulated object should be affected by gravitational forces.

isRotationLocked

var isRotationLocked: Bool3

A tuple of boolean values that indicates whether the rotation of the rigid body is locked around each of the three axes.

isTranslationLocked

var isTranslationLocked: Bool3

A tuple of boolean values representing whether the rigid body's translation is locked along each of the three axes. The default value is Bool3(false, false, false), meaning that translation is not locked along any axis.

linearDamping

var linearDamping: Float

Controls how fast a dynamic rigid body’s translational motion approaches the zero rest state. Default value is 0.02.

massProperties

var massProperties: MassProperties

The rigid body’s MassProperties, including mass, center of mass, inertia, and orientation of inertia.

rigidBodyMode

var rigidBodyMode: RigidBodyMode

Defines what will influence the motion of the object.