Camera (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.scene.Camera

public final class Camera
extends java.lang.Object

A Camera represents a camera in the scene from which to render an image.

This Camera class uses a float array to store certain parameters. This float array can be accessed by calling getArray(). It is never cloned, so use it with caution.

Because the float array is never cloned, changing its element values will change the state of this class, however, the hasUpdated() method will not be aware of this state change. The preferred way to change the parameters, is to use the methods of this class.

When the pitch and yaw parameters have been changed, it's required to call the update() method, which updates the OrthoNormal Basis.

The float array has the following format:

 
 00 array[ABSOLUTE_OFFSET_APERTURE_RADIUS]:       Aperture Radius
 01 array[ABSOLUTE_OFFSET_EYE_X]:                 Eye X
 02 array[ABSOLUTE_OFFSET_EYE_Y]:                 Eye Y
 03 array[ABSOLUTE_OFFSET_EYE_Z]:                 Eye Z
 04 array[ABSOLUTE_OFFSET_FIELD_OF_VIEW_X]:       Field of View X in Degrees
 05 array[ABSOLUTE_OFFSET_FIELD_OF_VIEW_Y]:       Field of View Y in Degrees
 06 array[ABSOLUTE_OFFSET_FOCAL_DISTANCE]:        Focal Distance
 07 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_X]: OrthoNormal Basis U X
 08 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Y]: OrthoNormal Basis U Y
 09 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Z]: OrthoNormal Basis U Z
 10 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_X]: OrthoNormal Basis V X
 11 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Y]: OrthoNormal Basis V Y
 12 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Z]: OrthoNormal Basis V Z
 13 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_X]: OrthoNormal Basis W X
 14 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Y]: OrthoNormal Basis W Y
 15 array[ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Z]: OrthoNormal Basis W Z
 16 array[ABSOLUTE_OFFSET_RESOLUTION_X]:          Resolution X or Width
 17 array[ABSOLUTE_OFFSET_RESOLUTION_Y]:          Resolution Y or Height
 18 array[ABSOLUTE_OFFSET_CAMERA_LENS]:           Camera Lens (one of CAMERA_LENS_FISHEYE (2) and CAMERA_LENS_THIN (1))

Since:: 1.0.0
Author:: Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABSOLUTE_OFFSET_APERTURE_RADIUS` The absolute offset of the Aperture Radius parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_CAMERA_LENS` The absolute offset of the Camera Lens parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_EYE` The absolute offset of the Eye parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_EYE_X` The absolute offset of the Eye X parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_EYE_Y` The absolute offset of the Eye Y parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_EYE_Z` The absolute offset of the Eye Z parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_FIELD_OF_VIEW` The absolute offset of the Field of View parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_FIELD_OF_VIEW_X` The absolute offset of the Field of View X parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_FIELD_OF_VIEW_Y` The absolute offset of the Field of View Y parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_FOCAL_DISTANCE` The absolute offset of the Focal Distance parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U` The absolute offset of the OrthoNormal Basis U parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_X` The absolute offset of the OrthoNormal Basis U X parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Y` The absolute offset of the OrthoNormal Basis U Y parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Z` The absolute offset of the OrthoNormal Basis U Z parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V` The absolute offset of the OrthoNormal Basis V parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W` The absolute offset of the OrthoNormal Basis W parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_X` The absolute offset of the OrthoNormal Basis V X parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_X` The absolute offset of the OrthoNormal Basis W X parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Y` The absolute offset of the OrthoNormal Basis V Y parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Y` The absolute offset of the OrthoNormal Basis W Y parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Z` The absolute offset of the OrthoNormal Basis V Z parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Z` The absolute offset of the OrthoNormal Basis W Z parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_RESOLUTION` The absolute offset of the Resolution parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_RESOLUTION_X` The absolute offset of the Resolution X parameter in the `float` array.
`static int`	`ABSOLUTE_OFFSET_RESOLUTION_Y` The absolute offset of the Resolution Y parameter in the `float` array.
`static int`	`CAMERA_LENS_FISHEYE` A constant denoting the Camera Lens parameter value for a Fisheye camera lens.
`static int`	`CAMERA_LENS_THIN` A constant denoting the Camera Lens parameter value for a Thin camera lens.
`static int`	`SIZE` A constant containing the size of the `float` array.

Constructor Summary

Constructors
Constructor and Description
`Camera()` Constructs a new default `Camera` instance.
`Camera(float[] array)` Constructs a new `Camera` instance given `array` as the `float` array to store certain parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCameraObserver(CameraObserver cameraObserver)` Adds `cameraObserver` to this `Camera` instance.
`void`	`changeAltitude(float y)` Changes the altitude of this `Camera` instance.
`void`	`changePitch(AngleF pitch)` Changes the pitch angle of this `Camera` instance.
`void`	`changeYaw(AngleF yaw)` Changes the yaw angle of this `Camera` instance.
`void`	`forward(float distance)` Moves this `Camera` instance forward (or backward) with `distance` units.
`float`	`getApertureRadius()` Returns the value of the Aperture Radius parameter.
`float[]`	`getArray()` Returns the `float` array that stores certain parameters.
`float`	`getEyeX()` Returns the value of the Eye X parameter.
`float`	`getEyeY()` Returns the value of the Eye Y parameter.
`float`	`getEyeZ()` Returns the value of the Eye Z parameter.
`float`	`getFieldOfViewX()` Returns the value of the Field of View X parameter.
`float`	`getFieldOfViewY()` Returns the value of the Field of View Y parameter.
`float`	`getFocalDistance()` Returns the value of the Focal Distance parameter.
`float`	`getOrthoNormalBasisUX()` Returns the value of the OrthoNormal Basis U X parameter.
`float`	`getOrthoNormalBasisUY()` Returns the value of the OrthoNormal Basis U Y parameter.
`float`	`getOrthoNormalBasisUZ()` Returns the value of the OrthoNormal Basis U Z parameter.
`float`	`getOrthoNormalBasisVX()` Returns the value of the OrthoNormal Basis V X parameter.
`float`	`getOrthoNormalBasisWX()` Returns the value of the OrthoNormal Basis W X parameter.
`float`	`getOrthoNormalBasisVY()` Returns the value of the OrthoNormal Basis V Y parameter.
`float`	`getOrthoNormalBasisWY()` Returns the value of the OrthoNormal Basis W Y parameter.
`float`	`getOrthoNormalBasisVZ()` Returns the value of the OrthoNormal Basis V Z parameter.
`float`	`getOrthoNormalBasisWZ()` Returns the value of the OrthoNormal Basis W Z parameter.
`AngleF`	`getPitch()` Returns an `AngleF` with the current pitch angle.
`float`	`getResolutionX()` Returns the value of the Resolution X parameter.
`float`	`getResolutionY()` Returns the value of the Resolution Y parameter.
`AngleF`	`getYaw()` Returns an `AngleF` with the current yaw angle.
`boolean`	`hasUpdated()` Returns `true` if, and only if, the state of this `Camera` instance has been updated, `false` otherwise.
`boolean`	`isFisheyeCameraLens()` Returns `true` if, and only if, the Camera Lens parameter is set to Fisheye camera lens, `false` otherwise.
`boolean`	`isThinCameraLens()` Returns `true` if, and only if, the Camera Lens parameter is set to Thin camera lens, `false` otherwise.
`boolean`	`isWalkLockEnabled()` Returns `true` if, and only if, walk lock is enabled, `false` otherwise.
`void`	`removeCameraObserver(CameraObserver cameraObserver)` Removes `cameraObserver` from this `Camera` instance.
`void`	`setApertureRadius(float apertureRadius)` Sets the value of the Aperture Radius parameter.
`void`	`setArray(float[] array)` Sets the `float` array to store certain parameters.
`void`	`setCameraLens(int cameraLens)` Sets the value for the Camera Lens parameter.
`void`	`setEye(float eyeX, float eyeY, float eyeZ)` Sets the values for the Eye X, Eye Y and Eye Z parameters.
`void`	`setFieldOfViewX(float fieldOfViewX)` Sets the value for the Field of View X parameter and calculates the value for the Field of View Y parameter.
`void`	`setFisheyeCameraLens(boolean isFisheyeCameraLens)` Sets the value for the Camera Lens parameter.
`void`	`setFocalDistance(float focalDistance)` Sets the value for the Focal Distance parameter.
`void`	`setPitch(AngleF pitch)` Sets `pitch` as the current pitch angle.
`void`	`setResolution(float resolutionX, float resolutionY)` Sets the values for the Resolution X and Resolution Y parameters.
`void`	`setThinCameraLens(boolean isThinCameraLens)` Sets the value for the Camera Lens parameter.
`void`	`setWalkLockEnabled(boolean isWalkLockEnabled)` Sets the walk lock state.
`void`	`setYaw(AngleF yaw)` Sets `yaw` as the current yaw angle.
`void`	`strafe(float distance)` Moves this `Camera` instance to the left or right with `distance` units.
`void`	`update()` Updates the OrthoNormal Basis parameter using the current pitch and yaw angles and clears the update flag.

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

- Field Detail
  - ABSOLUTE_OFFSET_APERTURE_RADIUS
```
public static final int ABSOLUTE_OFFSET_APERTURE_RADIUS
```
    The absolute offset of the Aperture Radius parameter in the float array. The value is 0.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_CAMERA_LENS
```
public static final int ABSOLUTE_OFFSET_CAMERA_LENS
```
    The absolute offset of the Camera Lens parameter in the float array. The value is 18.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_EYE
```
public static final int ABSOLUTE_OFFSET_EYE
```
    The absolute offset of the Eye parameter in the float array. The value is 1.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_EYE_X
```
public static final int ABSOLUTE_OFFSET_EYE_X
```
    The absolute offset of the Eye X parameter in the float array. The value is 1.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_EYE_Y
```
public static final int ABSOLUTE_OFFSET_EYE_Y
```
    The absolute offset of the Eye Y parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_EYE_Z
```
public static final int ABSOLUTE_OFFSET_EYE_Z
```
    The absolute offset of the Eye Z parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_FIELD_OF_VIEW
```
public static final int ABSOLUTE_OFFSET_FIELD_OF_VIEW
```
    The absolute offset of the Field of View parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_FIELD_OF_VIEW_X
```
public static final int ABSOLUTE_OFFSET_FIELD_OF_VIEW_X
```
    The absolute offset of the Field of View X parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_FIELD_OF_VIEW_Y
```
public static final int ABSOLUTE_OFFSET_FIELD_OF_VIEW_Y
```
    The absolute offset of the Field of View Y parameter in the float array. The value is 5.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_FOCAL_DISTANCE
```
public static final int ABSOLUTE_OFFSET_FOCAL_DISTANCE
```
    The absolute offset of the Focal Distance parameter in the float array. The value is 6.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U
```
    The absolute offset of the OrthoNormal Basis U parameter in the float array. The value is 7.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_X
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_X
```
    The absolute offset of the OrthoNormal Basis U X parameter in the float array. The value is 7.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Y
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Y
```
    The absolute offset of the OrthoNormal Basis U Y parameter in the float array. The value is 8.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Z
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Z
```
    The absolute offset of the OrthoNormal Basis U Z parameter in the float array. The value is 9.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V
```
    The absolute offset of the OrthoNormal Basis V parameter in the float array. The value is 10.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_X
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_X
```
    The absolute offset of the OrthoNormal Basis V X parameter in the float array. The value is 10.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Y
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Y
```
    The absolute offset of the OrthoNormal Basis V Y parameter in the float array. The value is 11.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Z
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Z
```
    The absolute offset of the OrthoNormal Basis V Z parameter in the float array. The value is 12.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W
```
    The absolute offset of the OrthoNormal Basis W parameter in the float array. The value is 13.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_X
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_X
```
    The absolute offset of the OrthoNormal Basis W X parameter in the float array. The value is 13.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Y
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Y
```
    The absolute offset of the OrthoNormal Basis W Y parameter in the float array. The value is 14.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Z
```
public static final int ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Z
```
    The absolute offset of the OrthoNormal Basis W Z parameter in the float array. The value is 15.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_RESOLUTION
```
public static final int ABSOLUTE_OFFSET_RESOLUTION
```
    The absolute offset of the Resolution parameter in the float array. The value is 16.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_RESOLUTION_X
```
public static final int ABSOLUTE_OFFSET_RESOLUTION_X
```
    The absolute offset of the Resolution X parameter in the float array. The value is 16.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_OFFSET_RESOLUTION_Y
```
public static final int ABSOLUTE_OFFSET_RESOLUTION_Y
```
    The absolute offset of the Resolution Y parameter in the float array. The value is 17.
    
    See Also:
    
    Constant Field Values
  - CAMERA_LENS_FISHEYE
```
public static final int CAMERA_LENS_FISHEYE
```
    A constant denoting the Camera Lens parameter value for a Fisheye camera lens. The value is 2.
    
    See Also:
    
    Constant Field Values
  - CAMERA_LENS_THIN
```
public static final int CAMERA_LENS_THIN
```
    A constant denoting the Camera Lens parameter value for a Thin camera lens. The value is 1.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    A constant containing the size of the float array. The size is 19.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Camera
```
public Camera()
```
    Constructs a new default Camera instance.
  - Camera
```
public Camera(float[] array)
```
    Constructs a new Camera instance given array as the float array to store certain parameters.
    This constructor does not clone array.
    If array is null, a NullPointerException will be thrown.
    
    Parameters:
    
    array - the float array to store certain parameters
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, array is null
- Method Detail
  - getPitch
```
public AngleF getPitch()
```
    Returns an AngleF with the current pitch angle.
    
    Returns:
    
    an AngleF with the current pitch angle
  - getYaw
```
public AngleF getYaw()
```
    Returns an AngleF with the current yaw angle.
    
    Returns:
    
    an AngleF with the current yaw angle
  - hasUpdated
```
public boolean hasUpdated()
```
    Returns true if, and only if, the state of this Camera instance has been updated, false otherwise.
    
    Returns:
    
    true if, and only if, the state of this Camera instance has been updated, false otherwise
  - isFisheyeCameraLens
```
public boolean isFisheyeCameraLens()
```
    Returns true if, and only if, the Camera Lens parameter is set to Fisheye camera lens, false otherwise.
    
    Returns:
    
    true if, and only if, the Camera Lens parameter is set to Fisheye camera lens, false otherwise
  - isThinCameraLens
```
public boolean isThinCameraLens()
```
    Returns true if, and only if, the Camera Lens parameter is set to Thin camera lens, false otherwise.
    
    Returns:
    
    true if, and only if, the Camera Lens parameter is set to Thin camera lens, false otherwise
  - isWalkLockEnabled
```
public boolean isWalkLockEnabled()
```
    Returns true if, and only if, walk lock is enabled, false otherwise.
    
    Returns:
    
    true if, and only if, walk lock is enabled, false otherwise
  - getApertureRadius
```
public float getApertureRadius()
```
    Returns the value of the Aperture Radius parameter.
    
    Returns:
    
    the value of the Aperture Radius parameter
  - getEyeX
```
public float getEyeX()
```
    Returns the value of the Eye X parameter.
    
    Returns:
    
    the value of the Eye X parameter
  - getEyeY
```
public float getEyeY()
```
    Returns the value of the Eye Y parameter.
    
    Returns:
    
    the value of the Eye Y parameter
  - getEyeZ
```
public float getEyeZ()
```
    Returns the value of the Eye Z parameter.
    
    Returns:
    
    the value of the Eye Z parameter
  - getFieldOfViewX
```
public float getFieldOfViewX()
```
    Returns the value of the Field of View X parameter.
    
    Returns:
    
    the value of the Field of View X parameter
  - getFieldOfViewY
```
public float getFieldOfViewY()
```
    Returns the value of the Field of View Y parameter.
    
    Returns:
    
    the value of the Field of View Y parameter
  - getFocalDistance
```
public float getFocalDistance()
```
    Returns the value of the Focal Distance parameter.
    
    Returns:
    
    the value of the Focal Distance parameter
  - getOrthoNormalBasisUX
```
public float getOrthoNormalBasisUX()
```
    Returns the value of the OrthoNormal Basis U X parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis U X parameter
  - getOrthoNormalBasisUY
```
public float getOrthoNormalBasisUY()
```
    Returns the value of the OrthoNormal Basis U Y parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis U Y parameter
  - getOrthoNormalBasisUZ
```
public float getOrthoNormalBasisUZ()
```
    Returns the value of the OrthoNormal Basis U Z parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis U Z parameter
  - getOrthoNormalBasisVX
```
public float getOrthoNormalBasisVX()
```
    Returns the value of the OrthoNormal Basis V X parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis V X parameter
  - getOrthoNormalBasisVY
```
public float getOrthoNormalBasisVY()
```
    Returns the value of the OrthoNormal Basis V Y parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis V Y parameter
  - getOrthoNormalBasisVZ
```
public float getOrthoNormalBasisVZ()
```
    Returns the value of the OrthoNormal Basis V Z parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis V Z parameter
  - getOrthoNormalBasisWX
```
public float getOrthoNormalBasisWX()
```
    Returns the value of the OrthoNormal Basis W X parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis W X parameter
  - getOrthoNormalBasisWY
```
public float getOrthoNormalBasisWY()
```
    Returns the value of the OrthoNormal Basis W Y parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis W Y parameter
  - getOrthoNormalBasisWZ
```
public float getOrthoNormalBasisWZ()
```
    Returns the value of the OrthoNormal Basis W Z parameter.
    
    Returns:
    
    the value of the OrthoNormal Basis W Z parameter
  - getResolutionX
```
public float getResolutionX()
```
    Returns the value of the Resolution X parameter.
    
    Returns:
    
    the value of the Resolution X parameter
  - getResolutionY
```
public float getResolutionY()
```
    Returns the value of the Resolution Y parameter.
    
    Returns:
    
    the value of the Resolution Y parameter
  - getArray
```
public float[] getArray()
```
    Returns the float array that stores certain parameters.
    This method will return the actual array and not a clone of it.
    
    Returns:
    
    the float array that stores certain parameters
  - addCameraObserver
```
public void addCameraObserver(CameraObserver cameraObserver)
```
    Adds cameraObserver to this Camera instance.
    If cameraObserver is null, a NullPointerException will be thrown.
    
    Parameters:
    
    cameraObserver - the CameraObserver to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, cameraObserver is null
  - changeAltitude
```
public void changeAltitude(float y)
```
    Changes the altitude of this Camera instance.
    This method changes the Eye Y parameter.
    
    Parameters:
    
    y - the value to add to the Eye Y parameter
  - changePitch
```
public void changePitch(AngleF pitch)
```
    Changes the pitch angle of this Camera instance.
    If pitch is null, a NullPointerException will be thrown.
    
    Parameters:
    
    pitch - the pitch angle to add to the current pitch angle
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, pitch is null
  - changeYaw
```
public void changeYaw(AngleF yaw)
```
    Changes the yaw angle of this Camera instance.
    If yaw is null, a NullPointerException will be thrown.
    
    Parameters:
    
    yaw - the yaw angle to add to the current yaw angle
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, yaw is null
  - forward
```
public void forward(float distance)
```
    Moves this Camera instance forward (or backward) with distance units.
    If isWalkLockEnabled() returns true, this method will only affect the X- and Z-axes. Otherwise all axes will be affected.
    
    Parameters:
    
    distance - the distance to move
  - removeCameraObserver
```
public void removeCameraObserver(CameraObserver cameraObserver)
```
    Removes cameraObserver from this Camera instance.
    If cameraObserver is null, a NullPointerException will be thrown.
    
    Parameters:
    
    cameraObserver - the CameraObserver to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, cameraObserver is null
  - setApertureRadius
```
public void setApertureRadius(float apertureRadius)
```
    Sets the value of the Aperture Radius parameter.
    
    Parameters:
    
    apertureRadius - the new value of the Aperture Radius parameter
  - setArray
```
public void setArray(float[] array)
```
    Sets the float array to store certain parameters.
    This method does not clone array.
    If array is null, a NullPointerException will be thrown.
    
    Parameters:
    
    array - the float array to store certain parameters
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - setCameraLens
```
public void setCameraLens(int cameraLens)
```
    Sets the value for the Camera Lens parameter.
    
    Parameters:
    
    cameraLens - the new value for the Camera Lens parameter
  - setEye
```
public void setEye(float eyeX,
                   float eyeY,
                   float eyeZ)
```
    Sets the values for the Eye X, Eye Y and Eye Z parameters.
    
    Parameters:
    
    eyeX - the new value for the Eye X parameter
    
    eyeY - the new value for the Eye Y parameter
    
    eyeZ - the new value for the Eye Z parameter
  - setFieldOfViewX
```
public void setFieldOfViewX(float fieldOfViewX)
```
    Sets the value for the Field of View X parameter and calculates the value for the Field of View Y parameter.
    
    Parameters:
    
    fieldOfViewX - the new value for the Field of View X parameter
  - setFisheyeCameraLens
```
public void setFisheyeCameraLens(boolean isFisheyeCameraLens)
```
    Sets the value for the Camera Lens parameter.
    If isFisheyeCameraLens is true, the Camera Lens parameter will be set to CAMERA_LENS_FISHEYE, otherwise it will be set to CAMERA_LENS_THIN.
    
    Parameters:
    
    isFisheyeCameraLens - true if, and only if, the Camera Lens parameter should be set to CAMERA_LENS_FISHEYE, false otherwise
  - setFocalDistance
```
public void setFocalDistance(float focalDistance)
```
    Sets the value for the Focal Distance parameter.
    
    Parameters:
    
    focalDistance - the new value for the Focal Distance parameter
  - setPitch
```
public void setPitch(AngleF pitch)
```
    Sets pitch as the current pitch angle.
    If pitch is null, a NullPointerException will be thrown.
    Calling this method will notify all currently added CameraObservers of an updated pitch angle.
    
    Parameters:
    
    pitch - an AngleF with the pitch angle to set
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, pitch is null
  - setResolution
```
public void setResolution(float resolutionX,
                          float resolutionY)
```
    Sets the values for the Resolution X and Resolution Y parameters.
    
    Parameters:
    
    resolutionX - the new value for the Resolution X parameter
    
    resolutionY - the new value for the Resolution Y parameter
  - setThinCameraLens
```
public void setThinCameraLens(boolean isThinCameraLens)
```
    Sets the value for the Camera Lens parameter.
    If isThinCameraLens is true, the Camera Lens parameter will be set to CAMERA_LENS_THIN, otherwise it will be set to CAMERA_LENS_FISHEYE.
    
    Parameters:
    
    isThinCameraLens - true if, and only if, the Camera Lens parameter should be set to CAMERA_LENS_THIN, false otherwise
  - setWalkLockEnabled
```
public void setWalkLockEnabled(boolean isWalkLockEnabled)
```
    Sets the walk lock state.
    
    Parameters:
    
    isWalkLockEnabled - true if, and only if, walk lock is enabled, false otherwise
  - setYaw
```
public void setYaw(AngleF yaw)
```
    Sets yaw as the current yaw angle.
    If yaw is null, a NullPointerException will be thrown.
    Calling this method will notify all currently added CameraObservers of an updated yaw angle.
    
    Parameters:
    
    yaw - an AngleF with the yaw angle to set
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, yaw is null
  - strafe
```
public void strafe(float distance)
```
    Moves this Camera instance to the left or right with distance units.
    If isWalkLockEnabled() returns true, this method will only affect the X- and Z-axes. Otherwise all axes will be affected.
    
    Parameters:
    
    distance - the distance to move
  - update
```
public void update()
```
    Updates the OrthoNormal Basis parameter using the current pitch and yaw angles and clears the update flag.

Class Camera

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ABSOLUTE_OFFSET_APERTURE_RADIUS

ABSOLUTE_OFFSET_CAMERA_LENS

ABSOLUTE_OFFSET_EYE

ABSOLUTE_OFFSET_EYE_X

ABSOLUTE_OFFSET_EYE_Y

ABSOLUTE_OFFSET_EYE_Z

ABSOLUTE_OFFSET_FIELD_OF_VIEW

ABSOLUTE_OFFSET_FIELD_OF_VIEW_X

ABSOLUTE_OFFSET_FIELD_OF_VIEW_Y

ABSOLUTE_OFFSET_FOCAL_DISTANCE

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_X

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Y

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_U_Z

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_X

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Y

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_V_Z

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_X

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Y

ABSOLUTE_OFFSET_ORTHONORMAL_BASIS_W_Z

ABSOLUTE_OFFSET_RESOLUTION

ABSOLUTE_OFFSET_RESOLUTION_X

ABSOLUTE_OFFSET_RESOLUTION_Y

CAMERA_LENS_FISHEYE

CAMERA_LENS_THIN

SIZE

Constructor Detail

Camera

Camera

Method Detail

getPitch

getYaw

hasUpdated

isFisheyeCameraLens

isThinCameraLens

isWalkLockEnabled

getApertureRadius

getEyeX

getEyeY

getEyeZ

getFieldOfViewX

getFieldOfViewY

getFocalDistance

getOrthoNormalBasisUX

getOrthoNormalBasisUY

getOrthoNormalBasisUZ

getOrthoNormalBasisVX

getOrthoNormalBasisVY

getOrthoNormalBasisVZ

getOrthoNormalBasisWX

getOrthoNormalBasisWY

getOrthoNormalBasisWZ

getResolutionX

getResolutionY

getArray

addCameraObserver

changeAltitude

changePitch

changeYaw

forward

removeCameraObserver

setApertureRadius

setArray

setCameraLens

setEye

setFieldOfViewX

setFisheyeCameraLens

setFocalDistance

setPitch

setResolution

setThinCameraLens

setWalkLockEnabled