TrackEntry class
Stores settings and other state for the playback of an animation on an AnimationState track.
References to a track entry must not be kept after the dispose EventType is reported to AnimationStateListener.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getAlpha(
) → Future< double> - Values < 1 mix this animation with the skeleton's current pose (usually the pose resulting from lower tracks). Defaults to 1, which overwrites the skeleton's current pose with this animation.
-
getAnimation(
) → Animation - The animation to apply for this track entry.
-
getAnimationEnd(
) → double - Seconds for the last frame of this animation. Non-looping animations won't play past this time. Looping animations will loop back to getAnimationStart at this time. Defaults to the animation Animation.getDuration.
-
getAnimationLast(
) → double -
The time in seconds this animation was last applied. Some timelines use this for one-time triggers. Eg, when this
animation is applied, event timelines will fire all events between the
animationLast
time (exclusive) andanimationTime
(inclusive). Defaults to -1 to ensure triggers on frame 0 happen the first time this animation is applied. -
getAnimationStart(
) → double - Seconds when this animation starts, both initially and after looping. Defaults to 0.
-
getAnimationTime(
) → double -
Uses getTrackTime to compute the
animationTime
. When thetrackTime
is 0, theanimationTime
is equal to theanimationStart
time. -
getAttachmentThreshold(
) → double -
When the mix percentage (getMixTime / getMixDuration) is less than the
attachmentThreshold
, attachment timelines are applied while this animation is being mixed out. Defaults to 0, so attachment timelines are not applied while this animation is being mixed out. -
getDelay(
) → double -
Seconds to postpone playing the animation. When this track entry is the current track entry,
delay
postpones incrementing the getTrackTime. When this track entry is queued,delay
is the time from the start of the previous animation to when this track entry will become the current track entry (ie when the previous track entry getTrackTime >= this track entry'sdelay
). -
getDrawOrderThreshold(
) → double -
When the mix percentage (getMixTime / getMixDuration) is less than the
drawOrderThreshold
, draw order timelines are applied while this animation is being mixed out. Defaults to 0, so draw order timelines are not applied while this animation is being mixed out. -
getEventThreshold(
) → double -
When the mix percentage (getMixTime / getMixDuration) is less than the
eventThreshold
, event timelines are applied while this animation is being mixed out. Defaults to 0, so event timelines are not applied while this animation is being mixed out. -
getHoldPrevious(
) → bool -
Seconds to postpone playing the animation. When this track entry is the current track entry,
delay
postpones incrementing the getTrackTime. When this track entry is queued,delay
is the time from the start of the previous animation to when this track entry will become the current track entry (ie when the previous track entry getTrackTime >= this track entry'sdelay
). -
getLoop(
) → bool - If true, the animation will repeat. If false it will not, instead its last frame is applied if played beyond its duration.
-
getMixBlend(
) → MixBlend - Controls how properties keyed in the animation are mixed with lower tracks. Defaults to MixBlend.replace.
-
getMixDuration(
) → double - Seconds for mixing from the previous animation to this animation. Defaults to the value provided by AnimationStateData.getMix based on the animation before this animation (if any).
-
getMixingFrom(
) → TrackEntry? -
The track entry for the previous animation when mixing from the previous animation to this animation, or null if no
mixing is currently occurring. When mixing from multiple animations,
mixingFrom
makes up a linked list. -
getMixingTo(
) → TrackEntry? -
The track entry for the next animation when mixing from this animation to the next animation, or null if no mixing is
currently occurring. When mixing to multiple animations,
mixingTo
makes up a linked list. -
getMixTime(
) → double -
Seconds from 0 to the getMixDuration when mixing from the previous animation to this animation. May be
slightly more than
mixDuration
when the mix is complete. -
getNext(
) → TrackEntry? -
The animation queued to start after this animation, or null if there is none.
next
makes up a doubly linked list. -
getReverse(
) → bool - If true, the animation will be applied in reverse. Events are not fired when an animation is applied in reverse.
-
getShortestRotation(
) → bool - If true, mixing rotation between tracks always uses the shortest rotation direction. If the rotation is animated, the shortest rotation direction may change during the mix.
-
getTimeScale(
) → double - Multiplier for the delta time when this track entry is updated, causing time for this animation to pass slower or faster. Defaults to 1.
-
getTrackComplete(
) → double - If this track entry is non-looping, the track time in seconds when getAnimationEnd is reached, or the current getTrackTime if it has already been reached. If this track entry is looping, the track time when this animation will reach its next getAnimationEnd (the next loop completion).
-
getTrackEnd(
) → double - The track time in seconds when this animation will be removed from the track. Defaults to the highest possible float value, meaning the animation will be applied until a new animation is set or the track is cleared. If the track end time is reached, no other animations are queued for playback, and mixing from any previous animations is complete, then the properties keyed by the animation are set to the setup pose and the track is cleared.
-
getTrackTime(
) → double - Current time in seconds this track entry has been the current track entry. The track time determines getAnimationTime. The track time can be set to start the animation at a time other than 0, without affecting looping.
-
getTtrackIndex(
) → int - The index of the track where this track entry is either current or queued.
-
isComplete(
) → bool - Returns true if at least one loop has been completed.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resetRotationDirections(
) → void - Resets the rotation directions for mixing this entry's rotate timelines. This can be useful to avoid bones rotating the long way around when using alpha and starting animations on other tracks.
-
setAlpha(
double alpha) → void -
setAnimationEnd(
double animationEnd) → void -
setAnimationLast(
double animationLast) → void -
setAnimationStart(
double animationStart) → void -
setAttachmentThreshold(
double attachmentThreshold) → void -
setDelay(
double delay) → void -
setDrawOrderThreshold(
double drawOrderThreshold) → void -
setEventThreshold(
double eventThreshold) → void -
setHoldPrevious(
bool holdPrevious) → void -
setListener(
AnimationStateListener? listener) → void - The listener for events generated by this track entry, or null.
-
setLoop(
bool loop) → void -
setMixBlend(
MixBlend mixBlend) → void -
setMixDuration(
double mixDuration) → void -
setMixTime(
double mixTime) → void -
setReverse(
bool reverse) → void -
setShortestRotation(
bool shortestRotation) → void -
setTimeScale(
double timeScale) → void -
setTrackEnd(
double trackEnd) → void -
setTrackTime(
double trackTime) → void -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited