agi.foundation.tracking

(agi.foundation.tracking.graphics-2024r3.jar)

Class HistoryGenerator<TEntity extends IEntityIdentifier & IEntityPosition & IEntityLastUpdate>

java.lang.Object

agi.foundation.tracking.HistoryGenerator<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

IDisposable, AutoCloseable

public class HistoryGenerator<TEntity extends IEntityIdentifier & IEntityPosition & IEntityLastUpdate>
extends Object
implements IDisposable

Maintains position information for visualizing track history.

In most cases, it is much more efficient to create a single instance of HistoryGenerator with an EntitySet containing all entities being visualized, rather than creating a unique instance for each EntityVisualizer that requires it. The amount of history kept is specified by HistoryLength (get / set) subtracted from the value of the current SceneManager Time (get).

See Also:

EntityHistory, HistoryVisualizer, WaypointVisualizer

Constructor Summary

Constructors

Constructor and Description
HistoryGenerator(TypeLiteral<TEntity> typeLiteralTEntity, EntitySet<TEntity> entities, Duration historyLength) Creates a new instance using the specified EntitySet and Duration.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases any resources associated with this instance.
protected void	dispose(boolean disposing) Releases any resources associated with this instance.
EntitySet<TEntity>	getEntities() Gets the entities for which history is being maintained.
EntityHistory	getHistory(TEntity entity) Gets the EntityHistory for the provided entity, or null if no history is found.
Duration	getHistoryLength() Gets the length of history to keep in memory for each track.
long	getLastUpdate() Gets the number of ticks returned by Stopwatch.getTimestamp() at the time of the last history update.
void	setHistoryLength(Duration value) Sets the length of history to keep in memory for each track.

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

HistoryGenerator

public HistoryGenerator(TypeLiteral<TEntity> typeLiteralTEntity,
                        @Nonnull
                        EntitySet<TEntity> entities,
                        @Nonnull
                        Duration historyLength)

Creates a new instance using the specified EntitySet and Duration.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

entities - The entities for which to track history.

historyLength - The length of history to keep in memory for each track.

Throws:

ArgumentNullException - Thrown if entities is null.

ArgumentOutOfRangeException - Thrown is historyLength is negative.

Method Detail

dispose

public final void dispose()

Releases any resources associated with this instance.

Specified by:

dispose in interface IDisposable

dispose

protected void dispose(boolean disposing)

Releases any resources associated with this instance.

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.

getHistoryLength

@Nonnull
public final Duration getHistoryLength()

Gets the length of history to keep in memory for each track.

Throws:

ArgumentOutOfRangeException - Thrown is value is negative.

setHistoryLength

public final void setHistoryLength(@Nonnull
                                   Duration value)

Sets the length of history to keep in memory for each track.

Throws:

ArgumentOutOfRangeException - Thrown is value is negative.

getEntities

@Nonnull
public final EntitySet<TEntity> getEntities()

Gets the entities for which history is being maintained.

getLastUpdate

public final long getLastUpdate()

Gets the number of ticks returned by Stopwatch.getTimestamp() at the time of the last history update.

getHistory

@Nullable
public final EntityHistory getHistory(@Nonnull
                                                 TEntity entity)

Gets the EntityHistory for the provided entity, or null if no history is found.

Parameters:

entity - The entity whose history to access.

Returns:

The entity history, or null if no history is found.