ModelVisualizer

java.lang.Object
- agi.foundation.tracking.EntityVisualizer<TEntity>
- - agi.foundation.tracking.ModelVisualizer<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

IDisposable, AutoCloseable
```
public class ModelVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
extends EntityVisualizer<TEntity>
```
An EntityVisualizer which creates a model for each entity.
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 (get / set), Display (get / set), DisplayCondition (get / set), Color (get / set), Scale (get / set), Tag (get / set), Orientation (get / set) and Position (get / set) 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.

Constructor Summary

Constructors
Constructor and Description
`ModelVisualizer(TypeLiteral<TEntity> typeLiteralTEntity)` Initializes a new instance.
`ModelVisualizer(TypeLiteral<TEntity> typeLiteralTEntity, EntitySet<TEntity> entities, ModelCallback<TEntity> callback)` Creates a new instance with the provided `EntitySet` and `ModelCallback`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`dispose(boolean disposing)` Releases any resources associated with this instance.
`ModelCallback<TEntity>`	`getCallback()` Gets the `ModelCallback` used to retrieve a model for each entity.
`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.
`double`	`getScale()` Gets the scale of the models, with 1 being actual size.
`float`	`getTranslucency()` Gets the translucency.
`Iterable<TEntity>`	`pick(PickResult pickResult)` Given a `PickResult`, returns the entities that were picked.
`void`	`setCallback(ModelCallback<TEntity> value)` Sets the `ModelCallback` used to retrieve a model for each entity.
`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`	`setScale(double value)` Sets the scale of the models, with 1 being actual size.
`void`	`setTranslucency(float value)` Sets the translucency.
`void`	`update(Transaction transaction)` Updates the underlying primitives 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
  - ModelVisualizer
```
public ModelVisualizer(TypeLiteral<TEntity> typeLiteralTEntity)
```
    Initializes a new instance.
    
    Parameters:
    
    typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.
  - ModelVisualizer
```
public ModelVisualizer(TypeLiteral<TEntity> typeLiteralTEntity,
                       EntitySet<TEntity> entities,
                       ModelCallback<TEntity> callback)
```
    Creates a new instance with the provided EntitySet and ModelCallback.
    
    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 model.
- 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 & IEntityOrientation>
    
    Parameters:
    
    disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.
  - getCallback
```
public final ModelCallback<TEntity> getCallback()
```
    Gets the ModelCallback used to retrieve a model for each entity.
  - setCallback
```
public final void setCallback(ModelCallback<TEntity> value)
```
    Sets the ModelCallback used to retrieve a model for each entity.
  - getScale
```
public final double getScale()
```
    Gets the scale of the models, with 1 being actual size.
  - setScale
```
public final void setScale(double value)
```
    Sets the scale of the models, with 1 being actual size.
  - getEntities
```
public EntitySet<TEntity> getEntities()
```
    Gets the entities being visualized.
    
    Specified by:
    
    getEntities in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
  - setEntities
```
public void setEntities(EntitySet<TEntity> value)
```
    Sets the entities being visualized.
    
    Specified by:
    
    setEntities in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
  - getColor
```
@Nonnull
public Color getColor()
```
    Description copied from class: EntityVisualizer
    
    Gets the color.
    
    Specified by:
    
    getColor in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
  - 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 & IEntityOrientation>
  - getTranslucency
```
public float getTranslucency()
```
    Gets the translucency. Translucency is not supported for models, so this property always returns 0 and cannot be set.
    
    Specified by:
    
    getTranslucency in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
    
    Throws:
    
    UnsupportedOperationException - Thrown if set.
  - setTranslucency
```
public void setTranslucency(float value)
```
    Sets the translucency. Translucency is not supported for models, so this property always returns 0 and cannot be set.
    
    Specified by:
    
    setTranslucency in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
    
    Throws:
    
    UnsupportedOperationException - Thrown if set.
  - getDisplay
```
public boolean getDisplay()
```
    Gets a value indicating whether the entities are displayed.
    
    Specified by:
    
    getDisplay in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
  - 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 & IEntityOrientation>
  - getDisplayCondition
```
public DisplayCondition getDisplayCondition()
```
    Description copied from class: EntityVisualizer
    
    Gets the DisplayCondition.
    
    Specified by:
    
    getDisplayCondition in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
  - setDisplayCondition
```
public void setDisplayCondition(DisplayCondition value)
```
    Description copied from class: EntityVisualizer
    
    Sets the DisplayCondition.
    
    Specified by:
    
    setDisplayCondition in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
  - update
```
public void update(Transaction transaction)
```
    Updates the underlying primitives to reflect the latest entity state.
    
    Specified by:
    
    update in class EntityVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>
    
    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 & IEntityOrientation>
    
    Parameters:
    
    pickResult - The result of the Insight3D pick.
    
    Returns:
    
    The list of picked entities.
    
    Throws:
    
    ArgumentNullException - Thrown if pickResult is null.

Class ModelVisualizer<TEntity extends IEntityIdentifier & IEntityPosition & IEntityOrientation>

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.tracking.EntityVisualizer

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

ModelVisualizer

Method Detail

dispose

getCallback

setCallback

getScale

setScale

getEntities

setEntities

getColor

setColor

getTranslucency

setTranslucency

getDisplay

setDisplay

getDisplayCondition

setDisplayCondition

update

pick