NetworkTransformComponent class final
Drives the owning node's transform from a TransformReplica.
Replicated poses arrive at packet rate; rendering a little in the past through a small sample buffer turns them into smooth motion, the standard snapshot-interpolation tradeoff of latency for continuity. The delay sizes itself from the measured arrival cadence and jitter, easing between minDelay and delay (the ceiling and starting value), so a clean local link renders barely behind while a jittery one buffers deep.
An owned, predicted entity uses PredictedTransformComponent instead, so
local input renders instantly rather than a delay in the past.
Constructors
- NetworkTransformComponent(TransformReplica replica, {Duration delay = const Duration(milliseconds: 100), Duration minDelay = const Duration(milliseconds: 25), bool adaptive = true, NowMicros now = defaultNowMicros})
Properties
- adaptive → bool
-
Whether the delay tracks measured arrival cadence and jitter.
final
- currentDelay → Duration
-
How far in the past remote poses currently render.
no setter
- delay → Duration
-
The deepest (and initial) render delay; the fixed delay when
adaptive is off.
final
- enabled ↔ bool
-
Whether this component's
updatehook 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
onLoadhas completed.no setterinherited - isMounted → bool
-
Whether the owning node is part of a live scene graph.
no setterinherited
- minDelay → Duration
-
The shallowest the adaptive delay will go.
final
- node → Node
-
The node this component is attached to.
no setterinherited
- replica → TransformReplica
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cloneFor(
Node cloneOwner) → Component? -
Returns a copy of this component for
cloneOwner, theNode.clonecounterpart of the owning node, or null to not carry the component to clones (the default).inherited -
fixedUpdate(
double fixedDt) → void -
Called once per fixed physics step while the component is mounted,
enabled, and loaded.fixedDtis the fixed timestep of the surroundingPhysicsWorld, 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
-
sampleAt(
int micros) → (Vector3, Quaternion) -
The interpolated pose at monotonic time
micros. -
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. A traversal visits each component at most once. Removing this component or an earlier sibling is safe. A component inserted before the current traversal position starts on the next frame. Reordering component or child lists during traversal is unsupported.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited