com.bonzaiengine.math

Class Transform

java.lang.Object

com.bonzaiengine.math.Transform

All Implemented Interfaces:

IInterpolable<Transform>, ITransformable, IData<Transform>, IValueCopy<Transform>, java.lang.Cloneable

public final class Transform
extends java.lang.Object
implements IData<Transform>, ITransformable

Transformation for animation, contains transformation matrix.

Constructor Summary

Constructors

Constructor and Description
Transform()

Method Summary

Modifier and Type	Method and Description
Transform	add(Transform t1, Transform t2) Axis inversion and scale rotate are ignored
Transform	clone()
boolean	equals(java.lang.Object obj)
Vec3	getLookAtForward(Vec3 dst)
Vec3	getLookAtLeft(Vec3 dst)
Mat4x4	getLookAtMatrix(Mat4x4 dst)
Vec3	getLookAtUp(Vec3 dst)
Mat4x4	getMatrix(Mat4x4 dst)
Vec3	getPosition(Vec3 dst) If modified, call the appropriate setter to synchronize internal data
Quat	getRotation(Quat dst) If modified, call the appropriate setter to synchronize internal data
Vec3	getScale(Vec3 dst) If modified, call the appropriate setter to synchronize internal data
Quat	getScaleRotate(Quat dst)
Transform	getTransform(Transform t)
boolean	hasPosition()
boolean	hasRotation()
boolean	hasScale()
Transform	interpolate(Transform current, Transform next, float t) Create the interpolation frame between two frame
Transform	inverseMultiply(Transform t1, Transform t2)
boolean	isIdentity()
boolean	isInverseAxis()
static Mat4x4	multiply(Mat4x4 dst, Mat4x4 src, Transform t) dst = src * t
Transform	multiply(Mat4x4 m1, Transform t2)
Transform	multiply(Transform t1, Mat4x4 m2)
Transform	multiply(Transform t1, Transform t2)
Vec3	multiply(Vec3 dst, Vec3 src)
Transform	multiplyInverse(Transform t1, Transform t2)
static Transform	read(ByteInputStream in)
Vec3	rotate(Vec3 dst, Vec3 src)
Transform	set(Transform t)
Transform	setIdentity() set the identity transformation
Transform	setInverseAxis(boolean inverseAxis)
Transform	setLookAtMatrix(Mat4x4 matrix) Set this Transform to be identical to the look at matrix
Transform	setMatrix(Mat4x4 matrix) Set this Transform to be identical to the matrix.
Transform	setMatrixTRS(Mat4x4 matrix) WARNING: This method is only valid for matrix created from a combination of a Translation, a Rotation and a Scale matrix.
Transform	setPosition(Vec3 position)
Transform	setRotation(Quat rotation)
Transform	setRotationAroundPivot(Mat4x4 m, Vec3 pivot, Vec3 axis, float angleInRadians) Deprecated.
Transform	setRotationAroundPivot(Quat q, Vec3 pivot, Vec3 axis, float angleInRadians) Deprecated.
Transform	setRotationAroundPivot(Vec3 pivot, Vec3 axis, float angleInRadians) Deprecated.
Transform	setScale(Vec3 scale)
Transform	setScaleRotate(Quat scaleRotate)
void	setTransform(Transform src)
static void	slerp(Transform[] ts1, Transform[] ts2, float t) ts1 = slerp(ts1, ts2, t)
java.lang.String	toString()
void	transform(Transform t)
void	write(ByteOutputStream out)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Transform

public Transform()

Method Detail

slerp

public static final void slerp(Transform[] ts1,
                               Transform[] ts2,
                               float t)

ts1 = slerp(ts1, ts2, t)

Parameters:

ts1 -

ts2 -

t - a value between [0;1]

read

public static final Transform read(ByteInputStream in)
                            throws java.io.IOException

Throws:

java.io.IOException

write

public final void write(ByteOutputStream out)
                 throws java.io.IOException

Throws:

java.io.IOException

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public final Transform clone()

Specified by:

clone in interface IData<Transform>

Specified by:

clone in interface IValueCopy<Transform>

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

setIdentity

public final Transform setIdentity()

set the identity transformation

set

public final Transform set(Transform t)

Specified by:

set in interface IValueCopy<Transform>

Parameters:

t - transform to copy to this

Returns:

this

setMatrix

public final Transform setMatrix(Mat4x4 matrix)

Set this Transform to be identical to the matrix.
Note: Projection matrices are not representable by a Transform object.

Returns:

this

setMatrixTRS

public final Transform setMatrixTRS(Mat4x4 matrix)

WARNING:

This method is only valid for matrix created from a combination of a Translation, a Rotation and a Scale matrix.

Use #setMatrix(Mat4x4) for general use.

Note: This method is faster than the general method: #setMatrix(Mat4x4).

Parameters:

matrix - a TRS matrix

Returns:

this

See Also:

setMatrix(Mat4x4)

setLookAtMatrix

public final Transform setLookAtMatrix(Mat4x4 matrix)

Set this Transform to be identical to the look at matrix

Returns:

this

setRotationAroundPivot

@Deprecated
public final Transform setRotationAroundPivot(Vec3 pivot,
                                                           Vec3 axis,
                                                           float angleInRadians)

Deprecated.

Set the Transform to represent a rotation around the pivot point

setRotationAroundPivot

@Deprecated
public final Transform setRotationAroundPivot(Quat q,
                                                           Vec3 pivot,
                                                           Vec3 axis,
                                                           float angleInRadians)

Deprecated.

Parameters:

q - a rotation representing a reference axis system

setRotationAroundPivot

@Deprecated
public final Transform setRotationAroundPivot(Mat4x4 m,
                                                           Vec3 pivot,
                                                           Vec3 axis,
                                                           float angleInRadians)

Deprecated.

Parameters:

m - a 3x3 matrix (4th row/col are ignored) representing a reference axis system

interpolate

public final Transform interpolate(Transform current,
                                   Transform next,
                                   float t)

Create the interpolation frame between two frame

Specified by:

interpolate in interface IInterpolable<Transform>

Specified by:

interpolate in interface IData<Transform>

Parameters:

next - next frame

t - tells how far we are from next frame

current - current value

Returns:

interpolated frame

multiply

public final Vec3 multiply(Vec3 dst,
                           Vec3 src)

rotate

public final Vec3 rotate(Vec3 dst,
                         Vec3 src)

add

public final Transform add(Transform t1,
                           Transform t2)

Axis inversion and scale rotate are ignored

multiply

public final Transform multiply(Transform t1,
                                Transform t2)

Parameters:

t1 -

t2 -

Returns:

this = t1 * t2

multiply

public final Transform multiply(Transform t1,
                                Mat4x4 m2)

Parameters:

t1 -

m2 -

Returns:

this = t1 * m2

multiply

public final Transform multiply(Mat4x4 m1,
                                Transform t2)

Parameters:

t1 -

m2 -

Returns:

this = m1 * t2

multiplyInverse

public final Transform multiplyInverse(Transform t1,
                                       Transform t2)

Parameters:

t1 -

t2 -

Returns:

this = t1 * t2^(-1)

inverseMultiply

public final Transform inverseMultiply(Transform t1,
                                       Transform t2)

Parameters:

t1 -

t2 -

Returns:

this = t1^(-1) * t2

multiply

public static final Mat4x4 multiply(Mat4x4 dst,
                                    Mat4x4 src,
                                    Transform t)

dst = src * t

Parameters:

dst - a destination Mat4x4, can be src

src -

t -

Returns:

dst or null if src and t are both null or identity

isIdentity

public final boolean isIdentity()

Returns:

true if not identity

getMatrix

public final Mat4x4 getMatrix(Mat4x4 dst)

Parameters:

dst - destination matrix to store the matrix represented by this quaternion

Returns:

dst

Throws:

java.lang.IllegalArgumentException - if this transform has scaling or axis inversion

getLookAtMatrix

public final Mat4x4 getLookAtMatrix(Mat4x4 dst)

Parameters:

dst - destination matrix to store the look at matrix

Returns:

dst

Throws:

java.lang.IllegalArgumentException - if this transform has scaling or axis inversion

getLookAtLeft

public final Vec3 getLookAtLeft(Vec3 dst)

Parameters:

dst - destination vector to store the left vector of the look at matrix of this Transform

Returns:

dst

getLookAtUp

public final Vec3 getLookAtUp(Vec3 dst)

Parameters:

dst - destination vector to store the up vector of the look at matrix of this Transform

Returns:

dst

getLookAtForward

public final Vec3 getLookAtForward(Vec3 dst)

Parameters:

dst - destination vector to store the forward vector of the look at matrix of this Transform

Returns:

dst

setPosition

public final Transform setPosition(Vec3 position)

Parameters:

position - the position, or null for no translation (position (0, 0, 0))

Returns:

this

setInverseAxis

public final Transform setInverseAxis(boolean inverseAxis)

Parameters:

inverseAxis - true to invert axis before applying rotation (default is false)

Returns:

this

setRotation

public final Transform setRotation(Quat rotation)

Parameters:

rotation - the quaternion defining the rotation, or null for no rotation (ie identity rotation)

Returns:

this

setScaleRotate

public final Transform setScaleRotate(Quat scaleRotate)

Parameters:

scaleRotate - the quaternion defining the orientation of the scale vectors, or null for default scale vector orientation.

Returns:

this

setScale

public final Transform setScale(Vec3 scale)

Parameters:

scale - the scaling values, or null for no scaling

Returns:

this

getPosition

public final Vec3 getPosition(Vec3 dst)

If modified, call the appropriate setter to synchronize internal data

isInverseAxis

public final boolean isInverseAxis()

getRotation

public final Quat getRotation(Quat dst)

If modified, call the appropriate setter to synchronize internal data

getScaleRotate

public final Quat getScaleRotate(Quat dst)

getScale

public final Vec3 getScale(Vec3 dst)

If modified, call the appropriate setter to synchronize internal data

hasPosition

public final boolean hasPosition()

Returns:

true if a position is not (0,0,0)

hasRotation

public final boolean hasRotation()

Returns:

true if a quaternion is not identity (0,0,0,1)

hasScale

public final boolean hasScale()

Returns:

true if a scale is not (1,1,1)

getTransform

public final Transform getTransform(Transform t)

Specified by:

getTransform in interface ITransformable

Parameters:

t - storage of the Transform value (or the identity if the value is null)

Returns:

dst (or null if the value is null)

setTransform

public void setTransform(Transform src)

Specified by:

setTransform in interface ITransformable

transform

public final void transform(Transform t)

Specified by:

transform in interface ITransformable