MarkerVisualizerTEntity Class

An EntityVisualizerTEntity which creates a marker for each entity.

Inheritance Hierarchy

SystemObject
AGI.Foundation.TrackingEntityVisualizerTEntity
AGI.Foundation.TrackingMarkerVisualizerTEntity

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

Syntax

C++

Copy

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

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

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

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

Type Parameters

TEntity: The type of entity.

The MarkerVisualizerTEntity type exposes the following members.

Constructors

	Name	Description
	MarkerVisualizerTEntity	Initializes a new instance.
	MarkerVisualizerTEntity(EntitySetTEntity, MarkerCallbackTEntity)	Creates a new instance with the provided EntitySetTEntity and MarkerCallbackTEntity.
	MarkerVisualizerTEntity(EntitySetTEntity, MarkerCallbackTEntity, SetHint)	Creates a new instance with the provided EntitySetTEntity, MarkerCallbackTEntity and SetHint.

Top

Properties

	Name	Description
	Callback	Gets or sets the MarkerCallbackTEntity used to determine the marker.
	Color	Gets or sets the color. (Overrides EntityVisualizerTEntityColor.)
	Display	Gets or sets a value indicating whether the entities are displayed. (Overrides EntityVisualizerTEntityDisplay.)
	DisplayCondition	Gets or sets the DisplayCondition. (Overrides EntityVisualizerTEntityDisplayCondition.)
	Entities	Gets or sets the entities being visualized. (Overrides EntityVisualizerTEntityEntities.)
	EyeOffset	Gets or sets the eye offset of each marker from the position of the entity.
	Origin	Gets or sets the origin of each marker.
	PixelOffset	Gets or sets the pixel offset of each marker from the position of the entity.
	SetHint	Gets the SetHint of the underlying primitive.
	Size	Gets or sets the size of the markers in the unit defined by SizeUnit. Defaults to pixels.
	SizeSource	Gets or sets the size source.
	SizeUnit	Gets or sets the size unit.
	Translucency	Gets or sets the translucency. 0 is opaque and 1 is transparent. (Overrides EntityVisualizerTEntityTranslucency.)

Top

Methods

	Name	Description
	Dispose	Releases any resources associated with this instance. (Inherited from EntityVisualizerTEntity.)
	Dispose(Boolean)	Releases any resources associated with this instance. (Overrides EntityVisualizerTEntityDispose(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 EntityVisualizerTEntityPick(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 EntityVisualizerTEntity.)
	PickTPrimitive(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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Updates the underlying primitive to reflect the latest entity state. (Overrides EntityVisualizerTEntityUpdate(Transaction).)

Top

Remarks

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

Reference

AGI.Foundation.Tracking Namespace

MarkerVisualizerAddLanguageSpecificTextSet("LSTA873E28C_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TEntityAddLanguageSpecificTextSet("LSTA873E28C_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

MarkerVisualizerTEntity Class