agi.foundation.graphics

(agi.foundation.graphics-2025r1.jar)

Class RealTimeSimulationAnimation

java.lang.Object

agi.foundation.graphics.advanced.MinimalForwardAnimation

agi.foundation.graphics.advanced.ForwardAnimation

agi.foundation.graphics.advanced.ForwardAndBackwardAnimation

agi.foundation.graphics.RealTimeSimulationAnimation

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class RealTimeSimulationAnimation
extends ForwardAndBackwardAnimation

Allows the user to animate at any time: past, present, or future. The time between each animation frame is based on wall clock time. If the last frame rendered one second ago in wall clock time, the current frame will render at a time equal to the previous frame's time plus one second. A TimeMultiplier (get / set) can be adjusted to make the simulation time progress faster or slower than real time.

Nested Class Summary

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

ForwardAnimation.AnimationState

Field Summary

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

m_endCycle, m_endTime, m_startCycle, m_startTime

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

m_time

Constructor Summary

Constructors

Constructor and Description
RealTimeSimulationAnimation() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected JulianDate	getNextTime() Gets the next animation time.
double	getTimeMultiplier() Gets the multiplier describing the rate of simulation time relative to real time.
Duration	getTimeStep() Gets the quantity of real time, in seconds, that is stepped when ForwardAnimation.stepForward() or ForwardAndBackwardAnimation.stepBackward() is called.
protected void	onLooping(JulianDate newTime)
protected void	onStarted(boolean forward)
protected void	onTimeUpdate() Called when the user sets the Time (get / set).
void	setTimeMultiplier(double value) Sets the multiplier describing the rate of simulation time relative to real time.
void	setTimeStep(Duration value) Sets the quantity of real time, in seconds, that is stepped when ForwardAnimation.stepForward() or ForwardAndBackwardAnimation.stepBackward() is called.
protected void	stepBackwardTime()
protected void	stepForwardTime()

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

getEndCycle, getEndTime, getStartCycle, getStartTime, nextFrame, playBackward, resetTime, setEndCycle, setEndTime, setStartCycle, setStartTime, stepBackward, validateAnimation

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

addHasReset, addPaused, addStarted, addStopped, animate, dispose, getAnimatingForward, getIsAnimating, getIsPaused, getIsReset, getIsStopped, getMessageLoopType, getRefreshRate, getState, getTargetedFramesPerSecond, getTime, onHasReset, onPaused, 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

Constructor Detail

RealTimeSimulationAnimation

public RealTimeSimulationAnimation()

Initializes a new instance.

Method Detail

getTimeMultiplier

public final double getTimeMultiplier()

Gets the multiplier describing the rate of simulation time relative to real time. For example, if this value is 2.0, two seconds of simulation time will pass for each each second of real time.

setTimeMultiplier

public final void setTimeMultiplier(double value)

Sets the multiplier describing the rate of simulation time relative to real time. For example, if this value is 2.0, two seconds of simulation time will pass for each each second of real time.

getTimeStep

@Nonnull
public final Duration getTimeStep()

Gets the quantity of real time, in seconds, that is stepped when ForwardAnimation.stepForward() or ForwardAndBackwardAnimation.stepBackward() is called. The simulation time will be stepped by this value times the TimeMultiplier (get / set). For example, if this value is 60.0, and TimeMultiplier (get / set) is 3.0, Time (get / set) will be stepped by 60.0 * 3.0 = 180.0 seconds when ForwardAnimation.stepForward() is called.

setTimeStep

public final void setTimeStep(Duration value)

Sets the quantity of real time, in seconds, that is stepped when ForwardAnimation.stepForward() or ForwardAndBackwardAnimation.stepBackward() is called. The simulation time will be stepped by this value times the TimeMultiplier (get / set). For example, if this value is 60.0, and TimeMultiplier (get / set) is 3.0, Time (get / set) will be stepped by 60.0 * 3.0 = 180.0 seconds when ForwardAnimation.stepForward() is called.

getNextTime

protected JulianDate getNextTime()

Description copied from class: ForwardAnimation

Gets the next animation time.

Specified by:

getNextTime in class ForwardAnimation

stepForwardTime

protected void stepForwardTime()

Specified by:

stepForwardTime in class ForwardAndBackwardAnimation

stepBackwardTime

protected void stepBackwardTime()

Specified by:

stepBackwardTime in class ForwardAndBackwardAnimation

onTimeUpdate

protected void onTimeUpdate()

Description copied from class: ForwardAnimation

Called when the user sets the Time (get / set).

Overrides:

onTimeUpdate in class ForwardAnimation

onStarted

protected void onStarted(boolean forward)

Overrides:

onStarted in class ForwardAnimation

onLooping

protected void onLooping(JulianDate newTime)

Overrides:

onLooping in class ForwardAndBackwardAnimation