@threlte/rapier
Collider
Colliders represent the geometric shapes that generate contacts and collision events when they touch. Attaching one or multiple colliders to a rigid body allow the rigid-body to be affected by contact forces.
Transform Properties
If a <Collider> component is not a child of a <RigidBody> component, the transform properties are reactive.
Properties
ColliderDesc, CoefficientCombineRule are types imported from '@dimforge/rapier3d-compat'.
If you don't provide any of the properties density, mass or massProperties, Rapier will figure that out for you.
You can provide either a property density, mass or massProperties.
// required
shape:
| 'ball'
| 'capsule'
| 'segment'
| 'triangle'
| 'roundTriangle'
| 'polyline'
| 'trimesh'
| 'cuboid'
| 'roundCuboid'
| 'heightfield'
| 'cylinder'
| 'roundCylinder'
| 'cone'
| 'roundCone'
| 'convexHull'
| 'convexMesh'
| 'roundConvexHull'
| 'roundConvexMesh'
args: Parameters<typeof ColliderDesc[Shape]>
// optional
position: Position | undefined = undefined
scale: Scale | undefined = undefined
rotation: Rotation | undefined = undefined
lookAt: LookAt | undefined = undefined
density: number | undefined = undefined
mass: number | undefined = undefined
massProperties:
| {
mass: number
centerOfMass: Position
principalAngularInertia: Position
angularInertiaLocalFrame: Rotation
} | undefined = undefined
restitution: number | undefined = undefined
restitutionCombineRule: CoefficientCombineRule | undefined = undefined
friction: number | undefined = undefined
frictionCombineRule: CoefficientCombineRule | undefined = undefined
sensor: boolean | undefined = undefined
contactForceEventThreshold: number | undefined = undefined
Bindings
Collider is a type imported from '@dimforge/rapier3d-compat'.
collider: Collider | undefined
Events
RigidBody, Collider and TempContactManifold are types imported from '@dimforge/rapier3d-compat'
collisionenter: CustomEvent<{
targetCollider: Collider
targetRigidBody: RigidBody | null
manifold: TempContactManifold
flipped: boolean
}>
collisionexit: CustomEvent<{
targetCollider: Collider
targetRigidBody: RigidBody | null
}>
sensorenter: CustomEvent<{
targetCollider: Collider
targetRigidBody: RigidBody | null
}>
sensorexit: CustomEvent<{
targetCollider: Collider
targetRigidBody: RigidBody | null
}>
contact: CustomEvent<{
targetCollider: Collider
targetRigidBody: RigidBody | null
manifold: TempContactManifold
flipped: boolean
maxForceDirection: Vector
maxForceMagnitude: number
totalForce: Vector
totalForceMagnitude: number
}>