agi.foundation.tracking

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

Class WaypointVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

java.lang.Object

agi.foundation.tracking.EntityVisualizer<TEntity>

agi.foundation.tracking.WaypointVisualizer<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

IDisposable, AutoCloseable

public class WaypointVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>
extends EntityVisualizer<TEntity>

An EntityVisualizer that creates a waypoint for each position in an entity's historical track.

This visualizer uses a single PointBatchPrimitive to efficiently render each waypoint.

See Also:

EntityHistory, HistoryGenerator, HistoryVisualizer

Constructor Summary

Constructors

Constructor and Description
WaypointVisualizer(TypeLiteral<TEntity> typeLiteralTEntity) Initializes a new instance.
WaypointVisualizer(TypeLiteral<TEntity> typeLiteralTEntity, EntitySet<TEntity> entities, HistoryGenerator<TEntity> historyGenerator) Creates a new instance with the provided EntitySet and HistoryGenerator.
WaypointVisualizer(TypeLiteral<TEntity> typeLiteralTEntity, EntitySet<TEntity> entities, HistoryGenerator<TEntity> historyGenerator, SetHint setHint) Creates a new instance with the provided EntitySet, HistoryGenerator and SetHint (get).

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing) Releases any resources associated with this instance.
Color	getColor() Gets the color.
boolean	getDisplay() Gets a value indicating whether the entities are displayed.
DisplayCondition	getDisplayCondition() Gets the DisplayCondition.
boolean	getDisplayOutline() Gets a value indicating whether to outline each point.
EntitySet<TEntity>	getEntities() Gets the entities being visualized.
HistoryGenerator<TEntity>	getHistoryGenerator() Gets the HistoryGenerator used for retrieving track data.
Color	getOutlineColor() Gets the color of the outline.
float	getOutlineTranslucency() Gets the translucency of the point outline.
float	getOutlineWidth() Gets the width of the outline, in pixels.
float	getPixelSize() Gets the size of each point in pixels.
SetHint	getSetHint() Gets the SetHint (get) of the underlying primitive.
float	getTranslucency() Gets the translucency.
Iterable<TEntity>	pick(PickResult pickResult) Given a PickResult, returns the entities that were picked.
void	setColor(Color value) Sets the color.
void	setDisplay(boolean value) Sets a value indicating whether the entities are displayed.
void	setDisplayCondition(DisplayCondition value) Sets the DisplayCondition.
void	setDisplayOutline(boolean value) Sets a value indicating whether to outline each point.
void	setEntities(EntitySet<TEntity> value) Sets the entities being visualized.
void	setHistoryGenerator(HistoryGenerator<TEntity> value) Sets the HistoryGenerator used for retrieving track data.
void	setOutlineColor(Color value) Sets the color of the outline.
void	setOutlineTranslucency(float value) Sets the translucency of the point outline.
void	setOutlineWidth(float value) Sets the width of the outline, in pixels.
void	setPixelSize(float value) Sets the size of each point in pixels.
void	setTranslucency(float value) Sets the translucency.
void	update(Transaction transaction) Updates the underlying primitive to reflect the latest entity track history.

Methods inherited from class agi.foundation.tracking.EntityVisualizer

dispose, pick, pick

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

WaypointVisualizer

public WaypointVisualizer(TypeLiteral<TEntity> typeLiteralTEntity)

Initializes a new instance.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

WaypointVisualizer

public WaypointVisualizer(TypeLiteral<TEntity> typeLiteralTEntity,
                          EntitySet<TEntity> entities,
                          HistoryGenerator<TEntity> historyGenerator)

Creates a new instance with the provided EntitySet and HistoryGenerator.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

entities - The entities to be visualized.

historyGenerator - The instance HistoryGenerator{TEntity} to use to retrieve track data.

WaypointVisualizer

public WaypointVisualizer(TypeLiteral<TEntity> typeLiteralTEntity,
                          EntitySet<TEntity> entities,
                          HistoryGenerator<TEntity> historyGenerator,
                          @Nonnull
                          SetHint setHint)

Creates a new instance with the provided EntitySet, HistoryGenerator and SetHint (get).

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

entities - The entities to be visualized.

historyGenerator - The instance HistoryGenerator{TEntity} to use to retrieve track data.

setHint - The SetHint (get) to use for the underlying primitives./>

Method Detail

dispose

protected void dispose(boolean disposing)

Releases any resources associated with this instance.

Specified by:

dispose in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

Parameters:

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

getHistoryGenerator

public final HistoryGenerator<TEntity> getHistoryGenerator()

Gets the HistoryGenerator used for retrieving track data.

setHistoryGenerator

public final void setHistoryGenerator(HistoryGenerator<TEntity> value)

Sets the HistoryGenerator used for retrieving track data.

getPixelSize

public final float getPixelSize()

Gets the size of each point in pixels.

setPixelSize

public final void setPixelSize(float value)

Sets the size of each point in pixels.

getDisplayOutline

public final boolean getDisplayOutline()

Gets a value indicating whether to outline each point.

setDisplayOutline

public final void setDisplayOutline(boolean value)

Sets a value indicating whether to outline each point.

getOutlineColor

@Nonnull
public final Color getOutlineColor()

Gets the color of the outline.

setOutlineColor

public final void setOutlineColor(@Nonnull
                                  Color value)

Sets the color of the outline.

getOutlineTranslucency

public final float getOutlineTranslucency()

Gets the translucency of the point outline. 0 is opaque and 1 is transparent.

setOutlineTranslucency

public final void setOutlineTranslucency(float value)

Sets the translucency of the point outline. 0 is opaque and 1 is transparent.

getOutlineWidth

public final float getOutlineWidth()

Gets the width of the outline, in pixels.

setOutlineWidth

public final void setOutlineWidth(float value)

Sets the width of the outline, in pixels.

getSetHint

@Nonnull
public final SetHint getSetHint()

Gets the SetHint (get) of the underlying primitive.

getEntities

public EntitySet<TEntity> getEntities()

Gets the entities being visualized.

Specified by:

getEntities in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

setEntities

public void setEntities(EntitySet<TEntity> value)

Sets the entities being visualized.

Specified by:

setEntities in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

getColor

@Nonnull
public Color getColor()

Description copied from class: EntityVisualizer

Gets the color.

Specified by:

getColor in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

setColor

public void setColor(@Nonnull
                     Color value)

Description copied from class: EntityVisualizer

Sets the color.

Specified by:

setColor in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

getTranslucency

public float getTranslucency()

Gets the translucency. 0 is opaque and 1 is transparent.

Specified by:

getTranslucency in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

setTranslucency

public void setTranslucency(float value)

Sets the translucency. 0 is opaque and 1 is transparent.

Specified by:

setTranslucency in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

getDisplay

public boolean getDisplay()

Gets a value indicating whether the entities are displayed.

Specified by:

getDisplay in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

setDisplay

public void setDisplay(boolean value)

Sets a value indicating whether the entities are displayed.

Specified by:

setDisplay in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

getDisplayCondition

public DisplayCondition getDisplayCondition()

Description copied from class: EntityVisualizer

Gets the DisplayCondition.

Specified by:

getDisplayCondition in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

setDisplayCondition

public void setDisplayCondition(DisplayCondition value)

Description copied from class: EntityVisualizer

Sets the DisplayCondition.

Specified by:

setDisplayCondition in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

update

public void update(Transaction transaction)

Updates the underlying primitive to reflect the latest entity track history.

Specified by:

update in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

Parameters:

transaction - The transaction to use.

Throws:

ArgumentNullException - Thrown if transaction is null.

PropertyInvalidException - Thrown if Entities (get / set) is null.

PropertyInvalidException - Thrown if HistoryGenerator (get / set) is null.

pick

public Iterable<TEntity> pick(PickResult pickResult)

Given a PickResult, returns the entities that were picked.

Specified by:

pick in class EntityVisualizer<TEntity extends IEntityLastUpdate & IEntityIdentifier & IEntityPosition>

Parameters:

pickResult - The result of the Insight3D pick.

Returns:

The list of picked entities.

Throws:

ArgumentNullException - Thrown if pickResult is null.