GenericJoint class Physics
A six-degree-of-freedom constraint with per-axis motion configs.
Constructors
-
GenericJoint({Node? otherNode, Vector3? localAnchorA, Vector3? localAnchorB, Quaternion? localBasisA, Quaternion? localBasisB, Map<
JointAxis, JointAxisConfig> ? axes, bool collisionsEnabled = false})
Properties
- collisionsEnabled ↔ bool
-
Whether the joined bodies still collide with each other.
getter/setter pairinherited
- enabled ↔ bool
-
Whether this component's update hook runs each frame.
getter/setter pairinherited
- handle → int?
-
The joint's simulation handle, or null while unmounted.
no setterinherited
- 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
- localAnchorA ↔ Vector3
-
getter/setter pair
- localAnchorB ↔ Vector3
-
getter/setter pair
- localBasisA ↔ Quaternion
-
getter/setter pair
- localBasisB ↔ Quaternion
-
getter/setter pair
- node → Node
-
The node this component is attached to.
no setterinherited
- otherNode → Node?
-
The body on the other side, or null to anchor against the world.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- world → PhysicsWorld?
-
The owning world while mounted.
no setterinherited
Methods
-
buildDesc(
int bodyA, int bodyB, bool collisionsEnabled) → JointDesc -
Builds the description for the current property values.
override
-
cloneFor(
Node cloneOwner) → Component? -
Returns a copy of this component for
cloneOwner, the Node.clone counterpart of the owning node, or null to not carry the component to clones (the default).inherited -
configForAxis(
JointAxis axis) → JointAxisConfig -
fixedUpdate(
double fixedDt) → void -
Called once per fixed physics step while the component is mounted,
enabled, and loaded.
fixedDtis 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
-
push(
) → void -
Reconfigures the live joint after a property change.
inherited
-
setAxisConfig(
JointAxis axis, JointAxisConfig config) → void -
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.
deltaSecondsis the elapsed time since the previous tick.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited