agi.foundation.tracking

(agi.foundation.tracking.graphics-2024r3.jar)

Class ViewFromTo<TEntity extends IEntityPosition>

java.lang.Object

agi.foundation.tracking.ViewFromTo<TEntity>

Type Parameters:

TEntity - The type of entity.

public class ViewFromTo<TEntity extends IEntityPosition>
extends Object

Tracks an entity or Point with a Camera (get / set) from the location of another entity or Point.

By default, Insight3D allows the user to control the view with the mouse. This can create undesired behavior if you're trying to lock the view to both a specific 'to' point and a specific 'from' point, as is the purpose of this class. It's recommended that you disable automatic mouse handling while this view is active. See MouseOptions (get) for details on adjusting mouse handling. This class only modifies camera properties related to Position (get / set) and ReferencePoint (get / set). All other properties can still be adjusted manually.

See Also:

ViewEntityFromOffset, Visualization with Insight3D topic

Constructor Summary

Constructors

Constructor and Description
ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity) Initializes a new instance.
ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity, Camera camera, Point fromPoint, Point toPoint) Create a new instance, specifying a view from one Point to another using the specified Camera (get / set).
ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity, Camera camera, Point fromPoint, TEntity toEntity) Create a new instance, specifying a view from a TEntity to a Point using the specified Camera (get / set).
ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity, Camera camera, TEntity fromEntity, Point toPoint) Create a new instance, specifying a view from a Point to a TEntity using the specified Camera (get / set).
ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity, Camera camera, TEntity fromEntity, TEntity toEntity) Creates a new instance, specifying a view from one TEntity to another using the specified Camera (get / set).

Method Summary

Modifier and Type	Method and Description
Camera	getCamera() Gets the Camera (get / set).
TEntity	getFromEntity() Gets the entity whose position will be used to place the camera or null if a Point is being used.
Point	getFromPoint() Gets the Point whose position will be used to place the camera or null if an entity is being used.
Ellipsoid	getShape() Gets the Ellipsoid to rotate the camera about.
TEntity	getToEntity() Gets the entity whose position will be used to aim the camera or null if a Point is being used.
Point	getToPoint() Gets the Point whose position will be used to aim the camera or null if an entity is being used.
void	refreshEvaluators() Forces recreation of the evaluators being used when viewing to or from a Point and the Point's definition has changed.
void	setCamera(Camera value) Sets the Camera (get / set).
void	setFrom(Point point) Specifies a Point which will be used to place the camera.
void	setFrom(TEntity entity) Specifies the entity at which the camera will be aimed.
void	setShape(Ellipsoid value) Sets the Ellipsoid to rotate the camera about.
void	setTo(Point point) Specifies the Point at which the camera will be aimed.
void	setTo(TEntity entity) Specifies the entity at which the camera will be placed.
void	update(Transaction transaction) Moves the camera's reference point to the position of the to entity while placing the camera at the position of the from entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewFromTo

public ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity)

Initializes a new instance.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

ViewFromTo

public ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity,
                  Camera camera,
                  TEntity fromEntity,
                  TEntity toEntity)

Creates a new instance, specifying a view from one TEntity to another using the specified Camera (get / set).

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

camera - The camera to use.

fromEntity - The entity whose position will represent the camera's position.

toEntity - The entity whose position will represent the camera's reference point.

ViewFromTo

public ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity,
                  Camera camera,
                  Point fromPoint,
                  Point toPoint)

Create a new instance, specifying a view from one Point to another using the specified Camera (get / set).

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

camera - The camera to use.

fromPoint - The Point whose position will represent the camera's position.

toPoint - The Point whose position will represent the camera's reference point.

ViewFromTo

public ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity,
                  Camera camera,
                  TEntity fromEntity,
                  Point toPoint)

Create a new instance, specifying a view from a Point to a TEntity using the specified Camera (get / set).

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

camera - The camera to use.

fromEntity - The entity whose position will represent the camera's position.

toPoint - The Point whose position will represent the camera's reference point.

ViewFromTo

public ViewFromTo(TypeLiteral<TEntity> typeLiteralTEntity,
                  Camera camera,
                  Point fromPoint,
                  TEntity toEntity)

Create a new instance, specifying a view from a TEntity to a Point using the specified Camera (get / set).

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

camera - The camera to use.

fromPoint - The Point whose position will represent the camera's position.

toEntity - The entity whose position will represent the camera's reference point.

Method Detail

getCamera

public final Camera getCamera()

Gets the Camera (get / set).

setCamera

public final void setCamera(Camera value)

Sets the Camera (get / set).

setFrom

public final void setFrom(Point point)

Specifies a Point which will be used to place the camera.

Parameters:

point - The Point to be used to place the camera.

setFrom

public final void setFrom(TEntity entity)

Specifies the entity at which the camera will be aimed.

Parameters:

entity - The entity to be used to aim the camera.

setTo

public final void setTo(Point point)

Specifies the Point at which the camera will be aimed.

Parameters:

point - The Point to be used to aim the camera.

setTo

public final void setTo(TEntity entity)

Specifies the entity at which the camera will be placed.

Parameters:

entity - The entity to be used to place the camera.

getShape

public final Ellipsoid getShape()

Gets the Ellipsoid to rotate the camera about. Defaults to Shape (get / set)

setShape

public final void setShape(Ellipsoid value)

Sets the Ellipsoid to rotate the camera about. Defaults to Shape (get / set)

getToEntity

public final TEntity getToEntity()

Gets the entity whose position will be used to aim the camera or null if a Point is being used.

getFromEntity

public final TEntity getFromEntity()

Gets the entity whose position will be used to place the camera or null if a Point is being used.

getToPoint

public final Point getToPoint()

Gets the Point whose position will be used to aim the camera or null if an entity is being used.

getFromPoint

public final Point getFromPoint()

Gets the Point whose position will be used to place the camera or null if an entity is being used.

refreshEvaluators

public final void refreshEvaluators()

Forces recreation of the evaluators being used when viewing to or from a Point and the Point's definition has changed.

update

public final void update(Transaction transaction)

Moves the camera's reference point to the position of the to entity while placing the camera at the position of the from entity.

Parameters:

transaction - The transaction to use.

Throws:

ArgumentNullException - Thrown if transaction is null.

PropertyInvalidException - Thrown if Camera (get / set) is null.

IllegalStateException - Thrown if either a to or from location has not been specified.