Projection

java.lang.Object
- agi.foundation.graphics.advanced.Projection

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

ProjectionStream
```
public class Projection
extends Object
implements IDisposable
```
A Projection represents a simplified camera with a Position, Orientation, and FieldOfViewHorizontal and FieldOfViewVertical. Unlike a real world camera, Projection has a nearest and farthest viewing distance, as defined by the NearPlane and FarPlane properties. For example, Projection can be used to represent a UAV's camera, to allow for projecting video onto terrain. See the Raster and Projection Streams topic for such an example.

See Also:

ProjectionStream, ProjectedRaster, View Frustum topic, Raster and Projection Streams topic

Constructor Summary

Constructors
Constructor and Description
`Projection()` Initializes a new instance.
`Projection(Cartesian position, UnitQuaternion orientation, double fieldOfViewHorizontal, double fieldOfViewVertical, double nearPlane, double farPlane)` Initializes a new instance.
`Projection(Projection projection)` Initializes a new instance from another projection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`protected void`	`dispose(boolean disposing)`
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`double`	`getFarPlane()` Gets the far plane associated with the `Projection`.
`double`	`getFieldOfViewHorizontal()` Gets the horizontal field of view associated with the `Projection`.
`double`	`getFieldOfViewVertical()` Gets the vertical field of view associated with the `Projection`.
`double`	`getNearPlane()` Gets the near plane associated with the `Projection`.
`UnitQuaternion`	`getOrientation()` Gets the `UnitQuaternion` defining the orientation of the `Projection` in the central body's fixed reference frame.
`Cartesian`	`getPosition()` Gets the `Cartesian` defining the position of the `Projection` in the central body's fixed reference frame.
`void`	`setFarPlane(double value)` Sets the far plane associated with the `Projection`.
`void`	`setFieldOfViewHorizontal(double value)` Sets the horizontal field of view associated with the `Projection`.
`void`	`setFieldOfViewVertical(double value)` Sets the vertical field of view associated with the `Projection`.
`void`	`setNearPlane(double value)` Sets the near plane associated with the `Projection`.
`void`	`setOrientation(UnitQuaternion value)` Sets the `UnitQuaternion` defining the orientation of the `Projection` in the central body's fixed reference frame.
`void`	`setPosition(Cartesian xyz)` Sets the `Cartesian` defining the position of the `Projection` in the central body's fixed reference frame.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable
close

- Constructor Detail
  - Projection
```
public Projection()
```
    Initializes a new instance.
  - Projection
```
public Projection(Cartesian position,
                  UnitQuaternion orientation,
                  double fieldOfViewHorizontal,
                  double fieldOfViewVertical,
                  double nearPlane,
                  double farPlane)
```
    Initializes a new instance.
    
    Parameters:
    
    position - The Cartesian defining the position of the Projection.
    
    orientation - The UnitQuaternion defining the orientation of the Projection.
    
    fieldOfViewHorizontal - The horizontal field of view associated with the Projection.
    
    fieldOfViewVertical - The vertical field of view associated with the Projection.
    
    nearPlane - The near plane associated with the Projection.
    
    farPlane - The far plane associated with the Projection.
  - Projection
```
public Projection(Projection projection)
```
    Initializes a new instance from another projection.
    
    Parameters:
    
    projection - The Projection from which to initialize the new instance.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: java.lang.Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - the Exception raised by this method
    
    See Also:
    
    WeakReference, PhantomReference
  - dispose
```
public final void dispose()
```
    Description copied from interface: IDisposable
    
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
    
    Specified by:
    
    dispose in interface IDisposable
  - dispose
```
protected void dispose(boolean disposing)
```
  - getPosition
```
public final Cartesian getPosition()
```
    Gets the Cartesian defining the position of the Projection in the central body's fixed reference frame.
  - setPosition
```
public final void setPosition(Cartesian xyz)
```
    Sets the Cartesian defining the position of the Projection in the central body's fixed reference frame.
  - getOrientation
```
public final UnitQuaternion getOrientation()
```
    Gets the UnitQuaternion defining the orientation of the Projection in the central body's fixed reference frame.
  - setOrientation
```
public final void setOrientation(UnitQuaternion value)
```
    Sets the UnitQuaternion defining the orientation of the Projection in the central body's fixed reference frame.
  - getFieldOfViewHorizontal
```
public final double getFieldOfViewHorizontal()
```
    Gets the horizontal field of view associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - setFieldOfViewHorizontal
```
public final void setFieldOfViewHorizontal(double value)
```
    Sets the horizontal field of view associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - getFieldOfViewVertical
```
public final double getFieldOfViewVertical()
```
    Gets the vertical field of view associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - setFieldOfViewVertical
```
public final void setFieldOfViewVertical(double value)
```
    Sets the vertical field of view associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - getNearPlane
```
public final double getNearPlane()
```
    Gets the near plane associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - setNearPlane
```
public final void setNearPlane(double value)
```
    Sets the near plane associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - getFarPlane
```
public final double getFarPlane()
```
    Gets the far plane associated with the Projection.
    
    See Also:
    
    View Frustum topic
  - setFarPlane
```
public final void setFarPlane(double value)
```
    Sets the far plane associated with the Projection.
    
    See Also:
    
    View Frustum topic

Class Projection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

Projection

Projection

Method Detail

finalize

dispose

dispose

getPosition

setPosition

getOrientation

setOrientation

getFieldOfViewHorizontal

setFieldOfViewHorizontal

getFieldOfViewVertical

setFieldOfViewVertical

getNearPlane

setNearPlane

getFarPlane

setFarPlane