Collider class abstract Physics

Common surface for a collision volume attached to a Node.

A collider pairs a shape with a material and a local pose. A node may carry several colliders; together they form a compound around that node's transform.

Concrete subclasses live in backend packages. Hold a reference as Collider so user code stays portable between backends.

Inheritance
Implementers

Constructors

Collider()

Properties

collisionLayer ↔ int
Bitmask identifying this collider's layer. A contact is generated only when each side's collisionLayer is set in the other side's collisionMask.
getter/setter pair
collisionMask ↔ int
Bitmask of layers this collider responds to.
getter/setter pair
enabled ↔ bool
Whether this component's update hook runs each frame.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
isAttached → bool
Whether this component is currently attached to a node.
no setterinherited
isLoaded → bool
Whether onLoad has completed.
no setterinherited
isMounted → bool
Whether the owning node is part of a live scene graph.
no setterinherited
isTrigger ↔ bool
When true, this collider emits TriggerEntered / TriggerExited events but does not produce a contact response.
getter/setter pair
localPose ↔ Matrix4
Pose of the collider relative to its owning Node. Used when one node carries multiple colliders, or when the collision volume is offset from the node's origin.
getter/setter pair
material ↔ PhysicsMaterial
getter/setter pair
node → Node
The node this component is attached to.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape ↔ Shape
getter/setter pair

Methods

fixedUpdate(double fixedDt) → void
Called once per fixed physics step while the component is mounted, enabled, and loaded. fixedDt is the fixed timestep of the surrounding PhysicsWorld, not the frame interval.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onAttach() → void
Called when this component is added to a node.
inherited
onDetach() → void
Called when this component is removed from a node.
inherited
onLoad() → Future<void>
Optional asynchronous setup, such as loading an asset.
inherited
onMount() → void
Called when the owning node enters a live scene graph.
inherited
onUnmount() → void
Called when the owning node leaves a live scene graph.
inherited
toString() → String
A string representation of this object.
inherited
update(double deltaSeconds) → void
Called once per frame while the component is mounted, enabled, and loaded. deltaSeconds is the elapsed time since the previous tick.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited