agi.foundation.tracking

(agi.foundation.tracking.graphics-2025r1.jar)

Class LabelVisualizer<TEntity extends IEntityIdentifier & IEntityPosition>

java.lang.Object

agi.foundation.tracking.EntityVisualizer<TEntity>

agi.foundation.tracking.LabelVisualizer<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

IDisposable, AutoCloseable

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

An EntityVisualizer which creates a label for each entity.

This visualizer uses a TextBatchPrimitive to efficiently render each entity label.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing) Releases any resources associated with this instance.
LabelCallback<TEntity>	getCallback() Gets the LabelCallback used to determine the label.
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 label from the position of the entity.
GraphicsFont	getFont() Gets the GraphicsFont to use to draw label text.
Origin	getOrigin() Gets the origin of each label.
Color	getOutlineColor() Gets the outline color for the label text.
float	getOutlineTranslucency() Gets the translucency of the label outline.
PointF	getPixelOffset() Gets the pixel offset of each label from the position of the entity.
SetHint	getSetHint() Gets the SetHint (get) of the underlying primitive.
TextureFilter2D	getTextureFilter() Gets filter to use.
float	getTranslucency() Gets the translucency.
Iterable<TEntity>	pick(PickResult pickResult) Given a PickResult, returns the entities that were picked.
void	setCallback(LabelCallback<TEntity> value) Sets the LabelCallback used to determine the label.
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 label from the position of the entity.
void	setFont(GraphicsFont value) Sets the GraphicsFont to use to draw label text.
void	setOrigin(Origin value) Sets the origin of each label.
void	setOutlineColor(Color value) Sets the outline color for the label text.
void	setOutlineTranslucency(float value) Sets the translucency of the label outline.
void	setPixelOffset(PointF value) Sets the pixel offset of each label from the position of the entity.
void	setTextureFilter(TextureFilter2D value) Sets filter to use.
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

LabelVisualizer

public LabelVisualizer(TypeLiteral<TEntity> typeLiteralTEntity)

Initializes a new instance.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

LabelVisualizer

public LabelVisualizer(TypeLiteral<TEntity> typeLiteralTEntity,
                       EntitySet<TEntity> entities,
                       LabelCallback<TEntity> callback)

Creates a new instance with the provided EntitySet and LabelCallback.

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 label.

LabelVisualizer

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

Creates a new instance with the provided EntitySet, LabelCallback 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 label.

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.

getTextureFilter

@Nonnull
public final TextureFilter2D getTextureFilter()

Gets filter to use.

setTextureFilter

public final void setTextureFilter(@Nonnull
                                   TextureFilter2D value)

Sets filter to use.

getFont

@Nonnull
public final GraphicsFont getFont()

Gets the GraphicsFont to use to draw label text.

Throws:

ArgumentNullException - Thrown if value is null.

setFont

public final void setFont(@Nonnull
                          GraphicsFont value)

Sets the GraphicsFont to use to draw label text.

Throws:

ArgumentNullException - Thrown if value is null.

getCallback

public final LabelCallback<TEntity> getCallback()

Gets the LabelCallback used to determine the label.

setCallback

public final void setCallback(LabelCallback<TEntity> value)

Sets the LabelCallback used to determine the label.

getOrigin

@Nonnull
public final Origin getOrigin()

Gets the origin of each label.

setOrigin

public final void setOrigin(@Nonnull
                            Origin value)

Sets the origin of each label.

getEyeOffset

@Nonnull
public final Cartesian getEyeOffset()

Gets the eye offset of each label from the position of the entity.

setEyeOffset

public final void setEyeOffset(@Nonnull
                               Cartesian value)

Sets the eye offset of each label from the position of the entity.

getPixelOffset

@Nonnull
public final PointF getPixelOffset()

Gets the pixel offset of each label from the position of the entity.

setPixelOffset

public final void setPixelOffset(@Nonnull
                                 PointF value)

Sets the pixel offset of each label from the position of the entity.

getOutlineColor

@Nonnull
public final Color getOutlineColor()

Gets the outline color for the label text.

setOutlineColor

public final void setOutlineColor(@Nonnull
                                  Color value)

Sets the outline color for the label text.

getOutlineTranslucency

public final float getOutlineTranslucency()

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

setOutlineTranslucency

public final void setOutlineTranslucency(float value)

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

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.