LabelVisualizer<TEntity> Class

An EntityVisualizer<TEntity> which creates a label for each entity.

Inheritance Hierarchy

System.Object
AGI.Foundation.Tracking.EntityVisualizer<TEntity>
AGI.Foundation.Tracking.LabelVisualizer<TEntity>

Namespace: AGI.Foundation.Tracking
Assembly: AGI.Foundation.Tracking.Graphics (in AGI.Foundation.Tracking.Graphics.dll) Version: 25.1.421.0 (25.1.421.0)

Syntax

C++

Copy

public class LabelVisualizer<TEntity> : EntityVisualizer<TEntity>
where TEntity : class, IEntityIdentifier, IEntityPosition

Public Class LabelVisualizer(Of TEntity As {Class, IEntityIdentifier, IEntityPosition})
	Inherits EntityVisualizer(Of TEntity)

generic<typename TEntity>
where TEntity : ref class, IEntityIdentifier, IEntityPosition
public ref class LabelVisualizer : public EntityVisualizer<TEntity>

type LabelVisualizer<'TEntity when 'TEntity : not struct and IEntityIdentifier and IEntityPosition> =  
    class
        inherit EntityVisualizer<'TEntity>
    end

Type Parameters

TEntity: The type of entity.

The LabelVisualizer<TEntity> type exposes the following members.

Constructors

	Name	Description
	LabelVisualizer<TEntity>()	Initializes a new instance.
	LabelVisualizer<TEntity>(EntitySet<TEntity>, LabelCallback<TEntity>)	Creates a new instance with the provided EntitySet<TEntity> and LabelCallback<TEntity>.
	LabelVisualizer<TEntity>(EntitySet<TEntity>, LabelCallback<TEntity>, SetHint)	Creates a new instance with the provided EntitySet<TEntity>, LabelCallback<TEntity> and SetHint.

Top

Properties

	Name	Description
	Callback	Gets or sets the LabelCallback<TEntity> used to determine the label.
	Color	Gets or sets the color. (Overrides EntityVisualizer<TEntity>.Color.)
	Display	Gets or sets a value indicating whether the entities are displayed. (Overrides EntityVisualizer<TEntity>.Display.)
	DisplayCondition	Gets or sets the DisplayCondition. (Overrides EntityVisualizer<TEntity>.DisplayCondition.)
	Entities	Gets or sets the entities being visualized. (Overrides EntityVisualizer<TEntity>.Entities.)
	EyeOffset	Gets or sets the eye offset of each label from the position of the entity.
	Font	Gets or sets the GraphicsFont to use to draw label text.
	Origin	Gets or sets the origin of each label.
	OutlineColor	Gets or sets the outline color for the label text.
	OutlineTranslucency	Gets or sets the translucency of the label outline. 0 is opaque and 1 is transparent.
	PixelOffset	Gets or sets the pixel offset of each label from the position of the entity.
	SetHint	Gets the SetHint of the underlying primitive.
	TextureFilter	Gets or sets filter to use.
	Translucency	Gets or sets the translucency. 0 is opaque and 1 is transparent. (Overrides EntityVisualizer<TEntity>.Translucency.)

Top

Methods

	Name	Description
	Dispose()	Releases any resources associated with this instance. (Inherited from EntityVisualizer<TEntity>.)
	Dispose(Boolean)	Releases any resources associated with this instance. (Overrides EntityVisualizer<TEntity>.Dispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Pick(PickResult)	Given a PickResult, returns the entities that were picked. (Overrides EntityVisualizer<TEntity>.Pick(PickResult).)
	Pick(PickResult, 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. (Inherited from EntityVisualizer<TEntity>.)
	Pick<TPrimitive>(PickResult, IEnumerable<TPrimitive>)	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. (Inherited from EntityVisualizer<TEntity>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Updates the underlying primitive to reflect the latest entity state. (Overrides EntityVisualizer<TEntity>.Update(Transaction).)

Top

Remarks

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

Reference

AGI.Foundation.Tracking Namespace

LabelVisualizer<AddLanguageSpecificTextSet("LST9CC30DC9_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TEntity>AddLanguageSpecificTextSet("LST9CC30DC9_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

LabelVisualizer<TEntity> Class