ModelVisualizer<TEntity> Class

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

Inheritance Hierarchy

System.Object
AGI.Foundation.Tracking.EntityVisualizer<TEntity>
AGI.Foundation.Tracking.ModelVisualizer<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 ModelVisualizer<TEntity> : EntityVisualizer<TEntity>
where TEntity : class, IEntityIdentifier, IEntityPosition, IEntityOrientation

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

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

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

Type Parameters

TEntity: The type of entity.

The ModelVisualizer<TEntity> type exposes the following members.

Constructors

	Name	Description
	ModelVisualizer<TEntity>()	Initializes a new instance.
	ModelVisualizer<TEntity>(EntitySet<TEntity>, ModelCallback<TEntity>)	Creates a new instance with the provided EntitySet<TEntity> and ModelCallback<TEntity>.

Top

Properties

	Name	Description
	Callback	Gets or sets the ModelCallback<TEntity> used to retrieve a model for each entity.
	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.)
	Scale	Gets or sets the scale of the models, with 1 being actual size.
	Translucency	Gets or sets the translucency. Translucency is not supported for models, so this property always returns 0 and cannot be set. (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 primitives to reflect the latest entity state. (Overrides EntityVisualizer<TEntity>.Update(Transaction).)

Top

Remarks

This visualizer uses an instance ModelPrimitive for each entity. It is required that each ModelPrimitive have exactly one entity associated with it. A single instance of ModelPrimitive cannot be used for multiple entities nor can multiple ModelPrimitive instances be used for a single entity. The primitive's ReferenceFrame, Display, DisplayCondition, Color, Scale, Tag, Orientation and Position properties will be modified and should never be set explicitly. All other properties and methods, such as loading a new model file or adjusting articulations, can be used normally.

Reference

AGI.Foundation.Tracking Namespace

ModelVisualizer<AddLanguageSpecificTextSet("LSTC0CCFB41_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TEntity>AddLanguageSpecificTextSet("LSTC0CCFB41_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

ModelVisualizer<TEntity> Class