com.io7m.r2.core

Class R2ProjectionFOV

java.lang.Object

com.io7m.r2.core.R2ProjectionFOV

All Implemented Interfaces:

R2ProjectionReadableType, R2ProjectionType, R2ProjectionWritableType

public final class R2ProjectionFOV
extends Object
implements R2ProjectionType

A perspective projection based on a given field of view and aspect ratio.

Method Summary

Modifier and Type	Method and Description
float	getAspectRatio()
float	getHorizontalFOV()
static R2ProjectionFOV	newFrustumWith(com.io7m.jcanephora.core.JCGLProjectionMatricesType c, float in_fov, float in_aspect, float in_z_near, float in_z_far) Construct a new FOV projection.
float	projectionGetFarXMaximum()
float	projectionGetFarXMinimum()
float	projectionGetFarYMaximum()
float	projectionGetFarYMinimum()
float	projectionGetNearXMaximum()
float	projectionGetNearXMinimum()
float	projectionGetNearYMaximum()
float	projectionGetNearYMinimum()
R2WatchableType<R2ProjectionReadableType>	projectionGetWatchable()
float	projectionGetZFar()
float	projectionGetZNear()
void	projectionMakeMatrix(com.io7m.jtensors.parameterized.PMatrixWritable4x4FType<R2SpaceEyeType,R2SpaceClipType> m) Write the projection to the given matrix.
void	projectionMakeMatrixUntyped(com.io7m.jtensors.MatrixWritable4x4FType m) Write the projection to the given matrix.
void	projectionSetZFar(float z) Set the distance to the far plane.
void	projectionSetZNear(float z) Set the distance to the near plane.
void	setAspectRatio(float r) Set the aspect ratio.
void	setHorizontalFOV(float f) Set the horizontal field of view.

Methods inherited from class java.lang.Object

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

Method Detail

newFrustumWith

public static R2ProjectionFOV newFrustumWith(com.io7m.jcanephora.core.JCGLProjectionMatricesType c,
                                             float in_fov,
                                             float in_aspect,
                                             float in_z_near,
                                             float in_z_far)

Construct a new FOV projection.

Parameters:

in_fov - The full horizontal field of view (the angle at the base of the triangle formed by the frustum on the x/z plane, in radians).

in_aspect - The non-zero aspect ratio

in_z_near - The distance to the near plane

in_z_far - The distance to the far plane

c - A matrices interface

Returns:

A new projection.

getAspectRatio

public float getAspectRatio()

Returns:

The aspect ratio.

setAspectRatio

public void setAspectRatio(float r)

Set the aspect ratio. The given value must be > 0.0.

Parameters:

r - The new ratio

getHorizontalFOV

public float getHorizontalFOV()

Returns:

The horizontal field of view.

setHorizontalFOV

public void setHorizontalFOV(float f)

Set the horizontal field of view.

Parameters:

f - The full horizontal field of view (the angle at the base of the triangle formed by the frustum on the x/z plane, in radians).

projectionSetZFar

public void projectionSetZFar(float z)

Set the distance to the far plane.

Parameters:

z - The Z distance

projectionSetZNear

public void projectionSetZNear(float z)

Set the distance to the near plane.

Parameters:

z - The Z distance

projectionMakeMatrix

public void projectionMakeMatrix(com.io7m.jtensors.parameterized.PMatrixWritable4x4FType<R2SpaceEyeType,R2SpaceClipType> m)

Description copied from interface: R2ProjectionReadableType

Write the projection to the given matrix.

Specified by:

projectionMakeMatrix in interface R2ProjectionReadableType

Parameters:

m - The output matrix

projectionMakeMatrixUntyped

public void projectionMakeMatrixUntyped(com.io7m.jtensors.MatrixWritable4x4FType m)

Description copied from interface: R2ProjectionReadableType

Write the projection to the given matrix.

Specified by:

projectionMakeMatrixUntyped in interface R2ProjectionReadableType

Parameters:

m - The output matrix

projectionGetNearXMaximum

public float projectionGetNearXMaximum()

Specified by:

projectionGetNearXMaximum in interface R2ProjectionReadableType

Returns:

The rightmost edge of the frustum's near plane.

projectionGetNearXMinimum

public float projectionGetNearXMinimum()

Specified by:

projectionGetNearXMinimum in interface R2ProjectionReadableType

Returns:

The leftmost edge of the frustum's near plane.

projectionGetNearYMaximum

public float projectionGetNearYMaximum()

Specified by:

projectionGetNearYMaximum in interface R2ProjectionReadableType

Returns:

The topmost edge of the frustum's near plane.

projectionGetNearYMinimum

public float projectionGetNearYMinimum()

Specified by:

projectionGetNearYMinimum in interface R2ProjectionReadableType

Returns:

The bottommost edge of the frustum's near plane.

projectionGetZFar

public float projectionGetZFar()

Specified by:

projectionGetZFar in interface R2ProjectionReadableType

Returns:

The value of the projection's far plane.

projectionGetZNear

public float projectionGetZNear()

Specified by:

projectionGetZNear in interface R2ProjectionReadableType

Returns:

The value of the projection's near plane.

projectionGetFarXMaximum

public float projectionGetFarXMaximum()

Specified by:

projectionGetFarXMaximum in interface R2ProjectionReadableType

Returns:

The rightmost edge of the frustum's far plane.

projectionGetFarXMinimum

public float projectionGetFarXMinimum()

Specified by:

projectionGetFarXMinimum in interface R2ProjectionReadableType

Returns:

The leftmost edge of the frustum's far plane.

projectionGetFarYMaximum

public float projectionGetFarYMaximum()

Specified by:

projectionGetFarYMaximum in interface R2ProjectionReadableType

Returns:

The topmost edge of the frustum's far plane.

projectionGetFarYMinimum

public float projectionGetFarYMinimum()

Specified by:

projectionGetFarYMinimum in interface R2ProjectionReadableType

Returns:

The bottommost edge of the frustum's far plane.

projectionGetWatchable

public R2WatchableType<R2ProjectionReadableType> projectionGetWatchable()

Specified by:

projectionGetWatchable in interface R2ProjectionReadableType

Returns:

The watchable value for this projection