agi.foundation.tracking

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

Class MarkerVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>

java.lang.Object

agi.foundation.tracking.EntityVisualizer<TEntity>

agi.foundation.tracking.MarkerVisualizer<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

IDisposable, AutoCloseable

public class MarkerVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>
extends EntityVisualizer<TEntity>

An EntityVisualizer which creates a marker for each entity.

This visualizer uses a MarkerBatchPrimitive to efficiently render each entity marker.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing) Releases any resources associated with this instance.
MarkerCallback<TEntity>	getCallback() Gets the MarkerCallback used to determine the marker.
Color	getColor() Gets the color.
boolean	getDisplay() Gets a value indicating whether the entities are displayed.
DisplayCondition	getDisplayCondition() Gets the DisplayCondition.
EntitySet<TEntity>	getEntities() Gets the entities being visualized.
Cartesian	getEyeOffset() Gets the eye offset of each marker from the position of the entity.
Origin	getOrigin() Gets the origin of each marker.
PointF	getPixelOffset() Gets the pixel offset of each marker from the position of the entity.
SetHint	getSetHint() Gets the SetHint (get) of the underlying primitive.
DimensionF	getSize() Gets the size of the markers in the unit defined by SizeUnit (get / set).
MarkerBatchSizeSource	getSizeSource() Gets the size source.
MarkerBatchUnit	getSizeUnit() Gets the size unit.
float	getTranslucency() Gets the translucency.
Iterable<TEntity>	pick(PickResult pickResult) Given a PickResult, returns the entities that were picked.
void	setCallback(MarkerCallback<TEntity> value) Sets the MarkerCallback used to determine the marker.
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	setEntities(EntitySet<TEntity> value) Sets the entities being visualized.
void	setEyeOffset(Cartesian value) Sets the eye offset of each marker from the position of the entity.
void	setOrigin(Origin value) Sets the origin of each marker.
void	setPixelOffset(PointF value) Sets the pixel offset of each marker from the position of the entity.
void	setSize(DimensionF value) Sets the size of the markers in the unit defined by SizeUnit (get / set).
void	setSizeSource(MarkerBatchSizeSource value) Sets the size source.
void	setSizeUnit(MarkerBatchUnit value) Sets the size unit.
void	setTranslucency(float value) Sets the translucency.
void	update(Transaction transaction) Updates the underlying primitive to reflect the latest entity state.

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

MarkerVisualizer

public MarkerVisualizer(TypeLiteral<TEntity> typeLiteralTEntity)

Initializes a new instance.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

MarkerVisualizer

public MarkerVisualizer(TypeLiteral<TEntity> typeLiteralTEntity,
                        EntitySet<TEntity> entities,
                        MarkerCallback<TEntity> callback)

Creates a new instance with the provided EntitySet and MarkerCallback.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

entities - The entities to be visualized.

callback - The callback used to determine each entity's marker.

MarkerVisualizer

public MarkerVisualizer(TypeLiteral<TEntity> typeLiteralTEntity,
                        EntitySet<TEntity> entities,
                        MarkerCallback<TEntity> callback,
                        @Nonnull
                        SetHint setHint)

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

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

entities - The entities to be visualized.

callback - The callback used to determine each entity's marker.

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 IEntityIdentifier & IEntityPosition>

Parameters:

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

getSize

@Nonnull
public final DimensionF getSize()

Gets the size of the markers in the unit defined by SizeUnit (get / set). Defaults to pixels. Size (get / set) for details.

setSize

public final void setSize(@Nonnull
                          DimensionF value)

Sets the size of the markers in the unit defined by SizeUnit (get / set). Defaults to pixels. Size (get / set) for details.

getSizeUnit

@Nonnull
public final MarkerBatchUnit getSizeUnit()

Gets the size unit. SizeUnit (get / set) for details.

setSizeUnit

public final void setSizeUnit(@Nonnull
                              MarkerBatchUnit value)

Sets the size unit. SizeUnit (get / set) for details.

getSizeSource

@Nonnull
public final MarkerBatchSizeSource getSizeSource()

Gets the size source. SizeSource (get) for details.

setSizeSource

public final void setSizeSource(@Nonnull
                                MarkerBatchSizeSource value)

Sets the size source. SizeSource (get) for details.

getOrigin

@Nonnull
public final Origin getOrigin()

Gets the origin of each marker. Origin (get / set) for details.

setOrigin

public final void setOrigin(@Nonnull
                            Origin value)

Sets the origin of each marker. Origin (get / set) for details.

getEyeOffset

@Nonnull
public final Cartesian getEyeOffset()

Gets the eye offset of each marker from the position of the entity. EyeOffset (get / set) for details.

setEyeOffset

public final void setEyeOffset(@Nonnull
                               Cartesian value)

Sets the eye offset of each marker from the position of the entity. EyeOffset (get / set) for details.

getPixelOffset

@Nonnull
public final PointF getPixelOffset()

Gets the pixel offset of each marker from the position of the entity. PixelOffset (get / set) for details.

setPixelOffset

public final void setPixelOffset(@Nonnull
                                 PointF value)

Sets the pixel offset of each marker from the position of the entity. PixelOffset (get / set) for details.

getCallback

public final MarkerCallback<TEntity> getCallback()

Gets the MarkerCallback used to determine the marker.

setCallback

public final void setCallback(MarkerCallback<TEntity> value)

Sets the MarkerCallback used to determine the marker.

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 IEntityIdentifier & IEntityPosition>

setEntities

public void setEntities(EntitySet<TEntity> value)

Sets the entities being visualized.

Specified by:

setEntities in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>

getColor

@Nonnull
public Color getColor()

Description copied from class: EntityVisualizer

Gets the color.

Specified by:

getColor in class EntityVisualizer<TEntity extends 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 IEntityIdentifier & IEntityPosition>

getTranslucency

public float getTranslucency()

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

Specified by:

getTranslucency in class EntityVisualizer<TEntity extends 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 IEntityIdentifier & IEntityPosition>

getDisplay

public boolean getDisplay()

Gets a value indicating whether the entities are displayed.

Specified by:

getDisplay in class EntityVisualizer<TEntity extends 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 IEntityIdentifier & IEntityPosition>

getDisplayCondition

public DisplayCondition getDisplayCondition()

Description copied from class: EntityVisualizer

Gets the DisplayCondition.

Specified by:

getDisplayCondition in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>

setDisplayCondition

public void setDisplayCondition(DisplayCondition value)

Description copied from class: EntityVisualizer

Sets the DisplayCondition.

Specified by:

setDisplayCondition in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>

update

public void update(Transaction transaction)

Updates the underlying primitive to reflect the latest entity state.

Specified by:

update in class EntityVisualizer<TEntity extends 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 Callback (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 IEntityIdentifier & IEntityPosition>

Parameters:

pickResult - The result of the Insight3D pick.

Returns:

The list of picked entities.

Throws:

ArgumentNullException - Thrown if pickResult is null.