agi.foundation.tracking

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

Class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>

java.lang.Object

agi.foundation.tracking.EntityVisualizer<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

HistoryVisualizer, LabelVisualizer, MarkerVisualizer, ModelVisualizer, PointVisualizer, SensorFieldOfViewVisualizer, WaypointVisualizer

public abstract class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>
extends Object
implements IDisposable

Abstract base class for visualizers, which display entities in Insight3D.

See Also:

Visualization with Insight3D topic

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityVisualizer(TypeLiteral<TEntity> typeLiteralTEntity) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases any resources associated with this instance.
protected abstract void	dispose(boolean disposing) Releases any resources associated with this instance.
abstract Color	getColor() Gets the color.
abstract boolean	getDisplay() Gets a value indicating whether the entities are displayed.
abstract DisplayCondition	getDisplayCondition() Gets the DisplayCondition.
abstract EntitySet<TEntity>	getEntities() Gets the entities being visualized.
abstract float	getTranslucency() Gets the translucency.
abstract Iterable<TEntity>	pick(PickResult pickResult) Given a PickResult, returns the entities that were picked.
protected <TPrimitive extends Primitive> Iterable<TEntity>	pick(PickResult pickResult, Iterable<TPrimitive> primitives) Given a list of primitives and a PickResult, returns the primitives that were picked.
protected Iterable<TEntity>	pick(PickResult pickResult, Primitive primitive) Given a PickResult and Primitive, returns a list of entities that were picked.
abstract void	setColor(Color value) Sets the color.
abstract void	setDisplay(boolean value) Sets a value indicating whether the entities are displayed.
abstract void	setDisplayCondition(DisplayCondition value) Sets the DisplayCondition.
abstract void	setEntities(EntitySet<TEntity> value) Sets the entities being visualized.
abstract void	setTranslucency(float value) Sets the translucency.
abstract void	update(Transaction transaction) Updates all graphics to reflect the entities in the provided transaction.

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

EntityVisualizer

protected EntityVisualizer(TypeLiteral<TEntity> typeLiteralTEntity)

Initializes a new instance.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

Method Detail

dispose

public final void dispose()

Releases any resources associated with this instance.

Specified by:

dispose in interface IDisposable

dispose

protected abstract 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.

getEntities

public abstract EntitySet<TEntity> getEntities()

Gets the entities being visualized.

setEntities

public abstract void setEntities(EntitySet<TEntity> value)

Sets the entities being visualized.

getColor

@Nonnull
public abstract Color getColor()

Gets the color.

setColor

public abstract void setColor(@Nonnull
                              Color value)

Sets the color.

getTranslucency

public abstract float getTranslucency()

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

setTranslucency

public abstract void setTranslucency(float value)

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

getDisplay

public abstract boolean getDisplay()

Gets a value indicating whether the entities are displayed.

setDisplay

public abstract void setDisplay(boolean value)

Sets a value indicating whether the entities are displayed.

getDisplayCondition

public abstract DisplayCondition getDisplayCondition()

Gets the DisplayCondition.

setDisplayCondition

public abstract void setDisplayCondition(DisplayCondition value)

Sets the DisplayCondition.

update

public abstract void update(@Nonnull
                            Transaction transaction)

Updates all graphics to reflect the entities in the provided transaction.

Parameters:

transaction - The transaction to use.

pick

@Nonnull
public abstract Iterable<TEntity> pick(@Nonnull
                                                 PickResult pickResult)

Given a PickResult, returns the entities that were picked.

Parameters:

pickResult - The result of the Insight3D pick.

Returns:

The list of picked entities.

Throws:

ArgumentNullException - Thrown if pickResult is null.

pick

@Nonnull
protected final <TPrimitive extends Primitive> Iterable<TEntity> pick(@Nonnull
                                                                                PickResult pickResult,
                                                                                @Nonnull
                                                                                Iterable<TPrimitive> primitives)

Given a list of primitives and a PickResult, returns the primitives that were picked. The primitives in the list are expected to contain an entity in their Tag property.

Type Parameters:

TPrimitive - The type of primitive.

Parameters:

pickResult - The result of the Insight3D pick.

primitives - The list of primitives being used by the visualizer. The primitive Tag property should be an entity.

Returns:

The list of picked entities.

Throws:

ArgumentNullException - Thrown if pickResult is null.

ArgumentNullException - Thrown if primitives is null.

pick

@Nonnull
protected final Iterable<TEntity> pick(@Nonnull
                                                 PickResult pickResult,
                                                 @Nonnull
                                                 Primitive primitive)

Given a PickResult and Primitive, returns a list of entities that were picked. This is best used to respond to a pick involving a batch primitive.

Parameters:

pickResult - The result of the Insight3D pick.

primitive - The primitive that was picked.

Returns:

The list of picked entities.

Throws:

ArgumentNullException - Thrown if pickResult is null.

ArgumentNullException - Thrown if primitive is null.