agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r2.jar)

Class ForwardAndBackwardAnimation

java.lang.Object

agi.foundation.graphics.advanced.MinimalForwardAnimation

agi.foundation.graphics.advanced.ForwardAnimation

agi.foundation.graphics.advanced.ForwardAndBackwardAnimation

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

RealTimeSimulationAnimation, SimulationAnimation

public abstract class ForwardAndBackwardAnimation
extends ForwardAnimation

The base class for animation classes that can animate both forward and backward.

Nested Class Summary

Nested classes/interfaces inherited from class agi.foundation.graphics.advanced.ForwardAnimation

ForwardAnimation.AnimationState

Field Summary

Fields

Modifier and Type	Field and Description
protected SimulationAnimationCycle	m_endCycle
protected JulianDate	m_endTime
protected SimulationAnimationCycle	m_startCycle
protected JulianDate	m_startTime

Fields inherited from class agi.foundation.graphics.advanced.ForwardAnimation

m_time

Method Summary

Modifier and Type	Method and Description
SimulationAnimationCycle	getEndCycle() Gets the end cycle.
JulianDate	getEndTime() Gets the end time of the animation.
SimulationAnimationCycle	getStartCycle() Gets the start cycle.
JulianDate	getStartTime() Gets the start time of the animation.
void	nextFrame() Advances to the next frame.
protected void	onLooping(JulianDate newTime)
void	playBackward() Starts animation backward.
protected void	resetTime() Resets the current animation time.
void	setEndCycle(SimulationAnimationCycle value) Sets the end cycle.
void	setEndTime(JulianDate value) Sets the end time of the animation.
void	setStartCycle(SimulationAnimationCycle value) Sets the start cycle.
void	setStartTime(JulianDate value) Sets the start time of the animation.
void	stepBackward() Steps animation backward.
protected abstract void	stepBackwardTime()
protected abstract void	stepForwardTime()
protected void	validateAnimation() Validates that animation can occur, throwing an exception if it cannot.

Methods inherited from class agi.foundation.graphics.advanced.ForwardAnimation

addHasReset, addPaused, addStarted, addStopped, animate, dispose, getAnimatingForward, getIsAnimating, getIsPaused, getIsReset, getIsStopped, getMessageLoopType, getNextTime, getRefreshRate, getState, getTargetedFramesPerSecond, getTime, onHasReset, onPaused, onStarted, onTimeUpdate, pause, playForward, removeHasReset, removePaused, removeStarted, removeStopped, reset, setAnimatingForward, setMessageLoopType, setRefreshRate, setState, setTargetedFramesPerSecond, setTime, startAnimationPump, stepForward, stopAnimationPump

Methods inherited from class agi.foundation.graphics.advanced.MinimalForwardAnimation

animate, dispose, getResourceTimerEnabled, resourceTimerCallback, setResourceTimerEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Field Detail

m_startTime

@Nonnull
protected JulianDate m_startTime

m_endTime

@Nonnull
protected JulianDate m_endTime

m_startCycle

protected SimulationAnimationCycle m_startCycle

m_endCycle

protected SimulationAnimationCycle m_endCycle

Method Detail

nextFrame

public void nextFrame()

Advances to the next frame. This method is called automatically during rendering, and should not be called directly.

Specified by:

nextFrame in class ForwardAnimation

getStartTime

@Nonnull
public final JulianDate getStartTime()

Gets the start time of the animation.

setStartTime

public final void setStartTime(@Nonnull
                               JulianDate value)

Sets the start time of the animation.

getEndTime

@Nonnull
public final JulianDate getEndTime()

Gets the end time of the animation.

setEndTime

public final void setEndTime(@Nonnull
                             JulianDate value)

Sets the end time of the animation.

getStartCycle

public final SimulationAnimationCycle getStartCycle()

Gets the start cycle.

setStartCycle

public final void setStartCycle(SimulationAnimationCycle value)

Sets the start cycle.

getEndCycle

public final SimulationAnimationCycle getEndCycle()

Gets the end cycle.

setEndCycle

public final void setEndCycle(SimulationAnimationCycle value)

Sets the end cycle.

playBackward

public final void playBackward()

Starts animation backward.

stepBackward

public final void stepBackward()

Steps animation backward.

validateAnimation

protected void validateAnimation()

Description copied from class: ForwardAnimation

Validates that animation can occur, throwing an exception if it cannot.

Overrides:

validateAnimation in class ForwardAnimation

stepForwardTime

protected abstract void stepForwardTime()

stepBackwardTime

protected abstract void stepBackwardTime()

resetTime

protected void resetTime()

Description copied from class: ForwardAnimation

Resets the current animation time.

Specified by:

resetTime in class ForwardAnimation

onLooping

protected void onLooping(JulianDate newTime)