ForwardAnimation | DME Component Libraries for Java 2024 r3

java.lang.Object
- agi.foundation.graphics.advanced.MinimalForwardAnimation
- - agi.foundation.graphics.advanced.ForwardAnimation

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

ForwardAndBackwardAnimation, RealTimeAnimation
```
public abstract class ForwardAnimation
extends MinimalForwardAnimation
```
The base class for animation classes that can animate in the forward direction.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class ForwardAnimation.AnimationState

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`ForwardAnimation.AnimationState`

Field Summary

Fields
Modifier and Type Field and Description

protected JulianDate m_time

Fields
Modifier and Type	Field and Description
`protected JulianDate`	`m_time`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHasReset(EventHandler<EventArgs> value)` Adds a handler for an event that occurs if animation has reset.
`void`	`addPaused(EventHandler<EventArgs> value)` Adds a handler for an event that occurs if animation has paused.
`void`	`addStarted(EventHandler<StartedEventArgs> value)` Adds a handler for an event that occurs if animation has started.
`void`	`addStopped(EventHandler<EventArgs> value)` Adds a handler for an event that occurs if animation has stopped.
`protected void`	`animate()` Animates to the next time.
`protected void`	`dispose(boolean disposing)`
`protected boolean`	`getAnimatingForward()` Gets a value indicating whether animation is in the forward direction.
`boolean`	`getIsAnimating()` Gets whether or not animation is playing.
`boolean`	`getIsPaused()` Gets whether animation is paused.
`boolean`	`getIsReset()` Gets whether animation has been reset.
`boolean`	`getIsStopped()` Gets whether animation is stopped.
`MessageLoopType`	`getMessageLoopType()` Gets the type of message loop employed by the application.
`protected abstract JulianDate`	`getNextTime()` Gets the next animation time.
`RefreshRate`	`getRefreshRate()` Gets the rate (fastest or fixed) at which the scene is refreshed during rendering.
`protected ForwardAnimation.AnimationState`	`getState()` Gets the current animation state.
`double`	`getTargetedFramesPerSecond()` Gets the targeted frames per second if `RefreshRate` is set to use `agi.foundation.graphics.advanced.refreshrate.TargetedFramesPerSecond`.
`JulianDate`	`getTime()` Gets the current animation time.
`abstract void`	`nextFrame()` Advances to the next frame.
`protected void`	`onHasReset()`
`protected void`	`onPaused()`
`protected void`	`onStarted(boolean forward)`
`protected void`	`onTimeUpdate()` Called when the user sets the `Time` (`get` / `set`).
`void`	`pause()` Pauses animation.
`void`	`playForward()` Starts animation forward.
`void`	`removeHasReset(EventHandler<EventArgs> value)` Removes a handler for an event that occurs if animation has reset.
`void`	`removePaused(EventHandler<EventArgs> value)` Removes a handler for an event that occurs if animation has paused.
`void`	`removeStarted(EventHandler<StartedEventArgs> value)` Removes a handler for an event that occurs if animation has started.
`void`	`removeStopped(EventHandler<EventArgs> value)` Removes a handler for an event that occurs if animation has stopped.
`void`	`reset()` Resets animation to the start time.
`protected abstract void`	`resetTime()` Resets the current animation time.
`protected void`	`setAnimatingForward(boolean value)` Sets a value indicating whether animation is in the forward direction.
`void`	`setMessageLoopType(MessageLoopType value)` Sets the type of message loop employed by the application.
`void`	`setRefreshRate(RefreshRate value)` Sets the rate (fastest or fixed) at which the scene is refreshed during rendering.
`protected void`	`setState(ForwardAnimation.AnimationState value)` Sets the current animation state.
`void`	`setTargetedFramesPerSecond(double value)` Sets the targeted frames per second if `RefreshRate` is set to use `agi.foundation.graphics.advanced.refreshrate.TargetedFramesPerSecond`.
`void`	`setTime(JulianDate value)` Sets the current animation time.
`protected void`	`startAnimationPump()`
`void`	`stepForward()` Steps animation forward.
`protected void`	`stopAnimationPump()`
`protected void`	`validateAnimation()` Validates that animation can occur, throwing an exception if it cannot.

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_time
```
@Nonnull
protected JulianDate m_time
```
- Method Detail
  - nextFrame
```
public abstract void nextFrame()
```
    Advances to the next frame. This method is called automatically during rendering, and should not be called directly.
  - getIsAnimating
```
public boolean getIsAnimating()
```
    Description copied from class: MinimalForwardAnimation
    
    Gets whether or not animation is playing.
    
    Specified by:
    
    getIsAnimating in class MinimalForwardAnimation
  - getRefreshRate
```
@Nonnull
public RefreshRate getRefreshRate()
```
    Gets the rate (fastest or fixed) at which the scene is refreshed during rendering.
    
    Specified by:
    
    getRefreshRate in class MinimalForwardAnimation
  - setRefreshRate
```
public void setRefreshRate(RefreshRate value)
```
    Sets the rate (fastest or fixed) at which the scene is refreshed during rendering.
    
    Specified by:
    
    setRefreshRate in class MinimalForwardAnimation
  - getTargetedFramesPerSecond
```
public double getTargetedFramesPerSecond()
```
    Description copied from class: MinimalForwardAnimation
    
    Gets the targeted frames per second if RefreshRate is set to use agi.foundation.graphics.advanced.refreshrate.TargetedFramesPerSecond.
    
    Specified by:
    
    getTargetedFramesPerSecond in class MinimalForwardAnimation
  - setTargetedFramesPerSecond
```
public void setTargetedFramesPerSecond(double value)
```
    Description copied from class: MinimalForwardAnimation
    
    Sets the targeted frames per second if RefreshRate is set to use agi.foundation.graphics.advanced.refreshrate.TargetedFramesPerSecond.
    
    Specified by:
    
    setTargetedFramesPerSecond in class MinimalForwardAnimation
  - getTime
```
@Nonnull
public final JulianDate getTime()
```
    Gets the current animation time.
  - setTime
```
public final void setTime(@Nonnull
                          JulianDate value)
```
    Sets the current animation time.
  - getMessageLoopType
```
public final MessageLoopType getMessageLoopType()
```
    Gets the type of message loop employed by the application. By default, this is set to MessageLoopType.AUTO_DETECT.
  - setMessageLoopType
```
public final void setMessageLoopType(MessageLoopType value)
```
    Sets the type of message loop employed by the application. By default, this is set to MessageLoopType.AUTO_DETECT.
  - getIsPaused
```
public final boolean getIsPaused()
```
    Gets whether animation is paused.
  - getIsReset
```
public final boolean getIsReset()
```
    Gets whether animation has been reset.
  - getIsStopped
```
public final boolean getIsStopped()
```
    Gets whether animation is stopped.
  - playForward
```
public final void playForward()
```
    Starts animation forward.
  - stepForward
```
public final void stepForward()
```
    Steps animation forward.
  - pause
```
public final void pause()
```
    Pauses animation.
  - reset
```
public void reset()
```
    Resets animation to the start time.
    
    Specified by:
    
    reset in class MinimalForwardAnimation
  - addStopped
```
public final void addStopped(EventHandler<EventArgs> value)
```
    Adds a handler for an event that occurs if animation has stopped.
  - removeStopped
```
public final void removeStopped(EventHandler<EventArgs> value)
```
    Removes a handler for an event that occurs if animation has stopped.
  - addPaused
```
public final void addPaused(EventHandler<EventArgs> value)
```
    Adds a handler for an event that occurs if animation has paused.
  - removePaused
```
public final void removePaused(EventHandler<EventArgs> value)
```
    Removes a handler for an event that occurs if animation has paused.
  - addStarted
```
public final void addStarted(EventHandler<StartedEventArgs> value)
```
    Adds a handler for an event that occurs if animation has started.
  - removeStarted
```
public final void removeStarted(EventHandler<StartedEventArgs> value)
```
    Removes a handler for an event that occurs if animation has started.
  - addHasReset
```
public final void addHasReset(EventHandler<EventArgs> value)
```
    Adds a handler for an event that occurs if animation has reset.
  - removeHasReset
```
public final void removeHasReset(EventHandler<EventArgs> value)
```
    Removes a handler for an event that occurs if animation has reset.
  - onPaused
```
protected void onPaused()
```
  - onStarted
```
protected void onStarted(boolean forward)
```
  - onHasReset
```
protected void onHasReset()
```
  - getState
```
@Nonnull
protected final ForwardAnimation.AnimationState getState()
```
    Gets the current animation state.
  - setState
```
protected final void setState(@Nonnull
                              ForwardAnimation.AnimationState value)
```
    Sets the current animation state.
  - getAnimatingForward
```
protected final boolean getAnimatingForward()
```
    Gets a value indicating whether animation is in the forward direction. If false, animation is going backwards.
  - setAnimatingForward
```
protected final void setAnimatingForward(boolean value)
```
    Sets a value indicating whether animation is in the forward direction. If false, animation is going backwards.
  - resetTime
```
protected abstract void resetTime()
```
    Resets the current animation time.
  - getNextTime
```
@Nonnull
protected abstract JulianDate getNextTime()
```
    Gets the next animation time.
  - animate
```
protected final void animate()
```
    Animates to the next time.
  - validateAnimation
```
protected void validateAnimation()
```
    Validates that animation can occur, throwing an exception if it cannot.
  - onTimeUpdate
```
protected void onTimeUpdate()
```
    Called when the user sets the Time (get / set).
  - startAnimationPump
```
protected final void startAnimationPump()
```
  - stopAnimationPump
```
protected final void stopAnimationPump()
```
  - dispose
```
protected void dispose(boolean disposing)
```
    Overrides:
    
    dispose in class MinimalForwardAnimation

Class ForwardAnimation

Nested Class Summary

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Field Detail

m_time

Method Detail

nextFrame

getIsAnimating

getRefreshRate

setRefreshRate

getTargetedFramesPerSecond

setTargetedFramesPerSecond

getTime

setTime

getMessageLoopType

setMessageLoopType

getIsPaused

getIsReset

getIsStopped

playForward

stepForward

pause

reset

addStopped

removeStopped

addPaused

removePaused

addStarted

removeStarted

addHasReset

removeHasReset

onPaused

onStarted

onHasReset

getState

setState

getAnimatingForward

setAnimatingForward

resetTime

getNextTime

animate

validateAnimation

onTimeUpdate

startAnimationPump

stopAnimationPump

dispose