com.io7m.r2.core

Class R2TransformOT

java.lang.Object

com.io7m.r2.core.R2TransformOT

All Implemented Interfaces:

R2TransformOrthogonalReadableType, R2TransformOTReadableType, R2TransformOTType, R2TransformReadableType, R2TransformType, R2TransformViewReadableType

public final class R2TransformOT
extends Object
implements R2TransformOTType

A transform represented by an orientation, followed by a translation.

The transform does not allow independent scaling on each axis and will therefore produce matrices that are guaranteed to be orthogonal.

Method Summary

Modifier and Type	Method and Description
static R2TransformOT	newTransform() Construct a transform using the default values: The identity quaternion (0, 0, 0, 1) for orientation and the translation (0, 0, 0).
static R2TransformOT	newTransformWithNotifier(Runnable in_changed) Construct a transform using the default values: The identity quaternion (0, 0, 0, 1) for orientation and the translation (0, 0, 0).
static R2TransformOT	newTransformWithValues(com.io7m.jtensors.Quaternion4FType in_orientation, com.io7m.jtensors.parameterized.PVector3FType<R2SpaceWorldType> in_translation) Construct a transform using the given initial values.
com.io7m.jtensors.Quaternion4FType	orientation()
com.io7m.jtensors.QuaternionReadable4FType	orientationReadable()
R2WatchableType<R2TransformReadableType>	transformGetWatchable()
void	transformMakeMatrix4x4F(R2TransformContextType context, com.io7m.jtensors.parameterized.PMatrixWritable4x4FType<R2SpaceObjectType,R2SpaceWorldType> m) Produce a 4x4 matrix for the current transformation, writing the resulting matrix to m.
<T extends R2SpaceType,U extends R2SpaceType> void	transformMakeViewMatrix4x4F(R2TransformContextType context, com.io7m.jtensors.parameterized.PMatrixWritable4x4FType<T,U> m) Produce a view matrix for the transform.
R2WatchableType<R2TransformOrthogonalReadableType>	transformOrthogonalGetWatchable()
com.io7m.jtensors.parameterized.PVector3FType<R2SpaceWorldType>	translation()
com.io7m.jtensors.parameterized.PVectorReadable3FType<R2SpaceWorldType>	translationReadable()

Methods inherited from class java.lang.Object

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

Method Detail

newTransformWithValues

public static R2TransformOT newTransformWithValues(com.io7m.jtensors.Quaternion4FType in_orientation,
                                                   com.io7m.jtensors.parameterized.PVector3FType<R2SpaceWorldType> in_translation)

Construct a transform using the given initial values. The given vectors are not copied; any modifications made to them will be reflected in the transform.

Parameters:

in_orientation - The orientation

in_translation - The translation

Returns:

A new transform

newTransform

public static R2TransformOT newTransform()

Construct a transform using the default values: The identity quaternion (0, 0, 0, 1) for orientation and the translation (0, 0, 0).

Returns:

A new transform

newTransformWithNotifier

public static R2TransformOT newTransformWithNotifier(Runnable in_changed)

Construct a transform using the default values: The identity quaternion (0, 0, 0, 1) for orientation and the translation (0, 0, 0).

Parameters:

in_changed - The procedure that will be executed every time the value of this transform is changed

Returns:

A new transform

orientation

public com.io7m.jtensors.Quaternion4FType orientation()

Specified by:

orientation in interface R2TransformOTType

Returns:

A quaternion representing the current orientation

translation

public com.io7m.jtensors.parameterized.PVector3FType<R2SpaceWorldType> translation()

Specified by:

translation in interface R2TransformOTType

Returns:

A translation in world-space

transformMakeMatrix4x4F

public void transformMakeMatrix4x4F(R2TransformContextType context,
                                    com.io7m.jtensors.parameterized.PMatrixWritable4x4FType<R2SpaceObjectType,R2SpaceWorldType> m)

Description copied from interface: R2TransformReadableType

Produce a 4x4 matrix for the current transformation, writing the resulting matrix to m.

Specified by:

transformMakeMatrix4x4F in interface R2TransformReadableType

Parameters:

context - The current transform context

m - The matrix to which values will be written

transformMakeViewMatrix4x4F

public <T extends R2SpaceType,U extends R2SpaceType> void transformMakeViewMatrix4x4F(R2TransformContextType context,
                                                                                      com.io7m.jtensors.parameterized.PMatrixWritable4x4FType<T,U> m)

Description copied from interface: R2TransformViewReadableType

Produce a view matrix for the transform. In this case, a view matrix is the view matrix required to place the observer at the transform's position, looking in the direction of the transform. In effect, this is the matrix resulting from the inverse of the transform.

Specified by:

transformMakeViewMatrix4x4F in interface R2TransformViewReadableType

Type Parameters:

T - The source coordinate system

U - The target coordinate system

Parameters:

context - A transform context

m - The output matrix

orientationReadable

public com.io7m.jtensors.QuaternionReadable4FType orientationReadable()

Specified by:

orientationReadable in interface R2TransformOTReadableType

Returns:

A quaternion representing the current orientation

translationReadable

public com.io7m.jtensors.parameterized.PVectorReadable3FType<R2SpaceWorldType> translationReadable()

Specified by:

translationReadable in interface R2TransformOTReadableType

Returns:

A translation in world-space

transformGetWatchable

public R2WatchableType<R2TransformReadableType> transformGetWatchable()

Specified by:

transformGetWatchable in interface R2TransformReadableType

Returns:

The watchable value for this transform

transformOrthogonalGetWatchable

public R2WatchableType<R2TransformOrthogonalReadableType> transformOrthogonalGetWatchable()

Specified by:

transformOrthogonalGetWatchable in interface R2TransformOrthogonalReadableType

Returns:

The watchable value for this transform