Click or drag to resize

LabelVisualizerTEntity Class

Inheritance Hierarchy
SystemObject
  AGI.Foundation.TrackingEntityVisualizerTEntity
    AGI.Foundation.TrackingLabelVisualizerTEntity

Namespace:  AGI.Foundation.Tracking
Assembly:  AGI.Foundation.Tracking.Graphics (in AGI.Foundation.Tracking.Graphics.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public class LabelVisualizer<TEntity> : EntityVisualizer<TEntity>
where TEntity : class, IEntityIdentifier, IEntityPosition

Type Parameters

TEntity
The type of entity.

The LabelVisualizerTEntity type exposes the following members.

Constructors
  NameDescription
Public methodLabelVisualizerTEntity
Initializes a new instance.
Public methodLabelVisualizerTEntity(EntitySetTEntity, LabelCallbackTEntity)
Public methodLabelVisualizerTEntity(EntitySetTEntity, LabelCallbackTEntity, SetHint)
Top
Properties
  NameDescription
Public propertyCallback
Public propertyColor
Gets or sets the color.
(Overrides EntityVisualizerTEntityColor.)
Public propertyDisplay
Gets or sets a value indicating whether the entities are displayed.
(Overrides EntityVisualizerTEntityDisplay.)
Public propertyDisplayCondition
Gets or sets the DisplayCondition.
(Overrides EntityVisualizerTEntityDisplayCondition.)
Public propertyEntities
Gets or sets the entities being visualized.
(Overrides EntityVisualizerTEntityEntities.)
Public propertyEyeOffset
Gets or sets the eye offset of each label from the position of the entity.
Public propertyFont
Gets or sets the GraphicsFont to use to draw label text.
Public propertyOrigin
Gets or sets the origin of each label.
Public propertyOutlineColor
Gets or sets the outline color for the label text.
Public propertyOutlineTranslucency
Gets or sets the translucency of the label outline. 0 is opaque and 1 is transparent.
Public propertyPixelOffset
Gets or sets the pixel offset of each label from the position of the entity.
Public propertySetHint
Gets the SetHint of the underlying primitive.
Public propertyTextureFilter
Gets or sets filter to use.
Public propertyTranslucency
Gets or sets the translucency. 0 is opaque and 1 is transparent.
(Overrides EntityVisualizerTEntityTranslucency.)
Top
Methods
  NameDescription
Public methodDispose
Releases any resources associated with this instance.
(Inherited from EntityVisualizerTEntity.)
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
(Overrides EntityVisualizerTEntityDispose(Boolean).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPick(PickResult)
Given a PickResult, returns the entities that were picked.
(Overrides EntityVisualizerTEntityPick(PickResult).)
Protected methodPick(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 EntityVisualizerTEntity.)
Protected methodPickTPrimitive(PickResult, IEnumerableTPrimitive)
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 EntityVisualizerTEntity.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Updates the underlying primitive to reflect the latest entity state.
(Overrides EntityVisualizerTEntityUpdate(Transaction).)
Top
Remarks
This visualizer uses a TextBatchPrimitive to efficiently render each entity label.
See Also