JavaFX 25 · com.sun.scenario.animation.shared.ClipEnvelope

An instance of ClipEnvelope handles the loop-part of a clip. The functionality to react on a pulse-signal from the timer is implemented in two classes: ClipEnvelope and ClipCore. ClipEnvelope is responsible for the "loop-part" (keeping track of the number of cycles, handling the direction of the clip etc.). ClipCore takes care of the inner part (interpolating the values, triggering the action-functions, ...) Both classes have an abstract public definition and can only be created using the factory method create(). The intent is to provide a general implementation plus eventually some fast-track implementations for common use cases.

Field Summary

Modifier and Type	Field and Description
protected boolean	aborted
protected Animation	animation
protected double	currentRate
protected long	cycleTicks The number of ticks in a single cycle.
protected long	deltaTicks
protected static final double	EPSILON
protected static final long	INDEFINITE
protected boolean	inTimePulse
protected double	rate The rate of the animation that is used to calculate the current rate of an animation.
protected long	ticks The current position of the play head.

Constructor Summary

Access	Constructor and Description
protected	ClipEnvelope(Animation animation)

Method Summary

Modifier and Type	Method and Description
public final void	abortCurrentPulse()
protected abstract double	calculateCurrentRate()
public static ClipEnvelope	create(Animation animation)
public double	getCurrentRate()
public abstract void	jumpTo(long ticks)
public abstract void	setAutoReverse(boolean autoReverse)
protected void	setCurrentRate(double currentRate)
public abstract ClipEnvelope	setCycleCount(int cycleCount)
public abstract ClipEnvelope	setCycleDuration(Duration cycleDuration)
protected void	setInternalCurrentRate(double currentRate)
public abstract void	setRate(double rate)
public void	start()
protected long	ticksRateChange(double newRate)
public abstract void	timePulse(long currentTick)
protected void	updateCycleTicks(Duration cycleDuration)
public boolean	wasSynched()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

aborted	back to summary
protected boolean aborted

animation	back to summary
protected Animation animation

currentRate	back to summary
protected double currentRate

cycleTicks	back to summary
protected long cycleTicks The number of ticks in a single cycle. Calculated from the cycle duration. Always >=0.

deltaTicks	back to summary
protected long deltaTicks

EPSILON	back to summary
protected static final double EPSILON

INDEFINITE	back to summary
protected static final long INDEFINITE

inTimePulse	back to summary
protected boolean inTimePulse

rate	back to summary
protected double rate The rate of the animation that is used to calculate the current rate of an animation. It is the same as animation.rate, only ignores animation.rate = 0, so can never be 0.

ticks	back to summary
protected long ticks The current position of the play head. 0 <= ticks <= totalTicks

Constructor Detail

ClipEnvelope	back to summary
protected ClipEnvelope(Animation animation)

Method Detail

abortCurrentPulse	back to summary
public final void abortCurrentPulse()

calculateCurrentRate	back to summary
protected abstract double calculateCurrentRate()

create	back to summary
public static ClipEnvelope create(Animation animation)

getCurrentRate	back to summary
public double getCurrentRate()

jumpTo	back to summary
public abstract void jumpTo(long ticks)

setAutoReverse	back to summary
public abstract void setAutoReverse(boolean autoReverse)

setCurrentRate	back to summary
protected void setCurrentRate(double currentRate)

setCycleCount	back to summary
public abstract ClipEnvelope setCycleCount(int cycleCount)

setCycleDuration	back to summary
public abstract ClipEnvelope setCycleDuration(Duration cycleDuration)

setInternalCurrentRate	back to summary
protected void setInternalCurrentRate(double currentRate)

setRate	back to summary
public abstract void setRate(double rate)

start	back to summary
public void start()

ticksRateChange	back to summary
protected long ticksRateChange(double newRate)

timePulse	back to summary
public abstract void timePulse(long currentTick)

updateCycleTicks	back to summary
protected void updateCycleTicks(Duration cycleDuration)