Click or drag to resize

ViewFromToTEntity Class

Tracks an entity or Point with a Camera from the location of another entity or Point.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.TrackingViewFromToTEntity

Namespace:  AGI.Foundation.Tracking
Assembly:  AGI.Foundation.Tracking.Graphics (in AGI.Foundation.Tracking.Graphics.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class ViewFromTo<TEntity>
where TEntity : class, IEntityPosition

Type Parameters

TEntity
The type of entity.

The ViewFromToTEntity type exposes the following members.

Constructors
  NameDescription
Public methodViewFromToTEntity
Initializes a new instance.
Public methodViewFromToTEntity(Camera, Point, Point)
Create a new instance, specifying a view from one Point to another using the specified Camera.
Public methodViewFromToTEntity(Camera, Point, TEntity)
Create a new instance, specifying a view from a TEntity to a Point using the specified Camera.
Public methodViewFromToTEntity(Camera, TEntity, Point)
Create a new instance, specifying a view from a Point to a TEntity using the specified Camera.
Public methodViewFromToTEntity(Camera, TEntity, TEntity)
Creates a new instance, specifying a view from one TEntity to another using the specified Camera.
Top
Properties
  NameDescription
Public propertyCamera
Gets or sets the Camera.
Public propertyFromEntity
Gets the entity whose position will be used to place the camera or null if a Point is being used.
Public propertyFromPoint
Gets the Point whose position will be used to place the camera or null if an entity is being used.
Public propertyShape
Gets or sets the Ellipsoid to rotate the camera about. Defaults to Shape
Public propertyToEntity
Gets the entity whose position will be used to aim the camera or null if a Point is being used.
Public propertyToPoint
Gets the Point whose position will be used to aim the camera or null if an entity is being used.
Top
Methods
  NameDescription
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 methodRefreshEvaluators
Forces recreation of the evaluators being used when viewing to or from a Point and the Point's definition has changed.
Public methodSetFrom(TEntity)
Specifies the entity at which the camera will be aimed.
Public methodSetFrom(Point)
Specifies a Point which will be used to place the camera.
Public methodSetTo(TEntity)
Specifies the entity at which the camera will be placed.
Public methodSetTo(Point)
Specifies the Point at which the camera will be aimed.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Moves the camera's reference point to the position of the to entity while placing the camera at the position of the from entity.
Top
Remarks
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 for details on adjusting mouse handling. This class only modifies camera properties related to Position and ReferencePoint. All other properties can still be adjusted manually.
See Also