Transform (jMonkeyEngine3)

java.lang.Object
- com.jme3.math.Transform

All Implemented Interfaces:

Savable, java.io.Serializable, java.lang.Cloneable
```
public final class Transform
extends java.lang.Object
implements Savable, java.lang.Cloneable, java.io.Serializable
```
Started Date: Jul 16, 2004

Represents a translation, rotation and scale in one object.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Transform IDENTITY

Fields
Modifier and Type	Field and Description
`static Transform`	`IDENTITY`

Constructor Summary

Constructors
Constructor and Description
`Transform()`
`Transform(Quaternion rot)`
`Transform(Vector3f translation)`
`Transform(Vector3f translation, Quaternion rot)`
`Transform(Vector3f translation, Quaternion rot, Vector3f scale)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Transform`	`clone()` Create a copy of this transform.
`Transform`	`combineWithParent(Transform parent)` Changes the values of this Transform according to its parent.
`boolean`	`equals(java.lang.Object obj)`
`void`	`fromTransformMatrix(Matrix4f mat)`
`Quaternion`	`getRotation()` Return the rotation quaternion in this Transform.
`Quaternion`	`getRotation(Quaternion quat)` Stores this rotation value into the given Quaternion.
`Vector3f`	`getScale()` Return the scale vector in this Transform.
`Vector3f`	`getScale(Vector3f scale)` Stores this scale value into the given vector3f.
`Vector3f`	`getTranslation()` Return the translation vector in this Transform.
`Vector3f`	`getTranslation(Vector3f trans)` Stores this translation value into the given vector3f.
`int`	`hashCode()`
`void`	`interpolateTransforms(Transform t1, Transform t2, float delta)` Sets this transform to the interpolation between the first transform and the second by delta amount.
`Transform`	`invert()`
`boolean`	`isIdentity()` Test for exact identity.
`void`	`loadIdentity()` Loads the identity.
`void`	`read(JmeImporter e)` De-serialize this transform from the specified importer, for example when loading from a J3O file.
`Transform`	`set(Transform matrixQuat)` Sets this Transform to be equal to the given Transform.
`Transform`	`setRotation(Quaternion rot)` Sets this rotation to the given Quaternion value.
`Transform`	`setScale(float scale)` Sets this scale to the given value.
`Transform`	`setScale(float x, float y, float z)` Sets this transform's scale to the given x,y,z values.
`Transform`	`setScale(Vector3f scale)` Sets this scale to the given value.
`Transform`	`setTranslation(float x, float y, float z)` Sets this transform's translation to the given x,y,z values.
`Transform`	`setTranslation(Vector3f trans)` Sets this translation to the given value.
`java.lang.String`	`toString()`
`Matrix4f`	`toTransformMatrix()`
`Matrix4f`	`toTransformMatrix(Matrix4f store)`
`Vector3f`	`transformInverseVector(Vector3f in, Vector3f store)`
`Vector3f`	`transformVector(Vector3f in, Vector3f store)`
`void`	`write(JmeExporter e)` Serialize this transform to the specified exporter, for example when saving to a J3O file.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - IDENTITY
```
public static final Transform IDENTITY
```
- Constructor Detail
  - Transform
```
public Transform(Vector3f translation,
                 Quaternion rot)
```
  - Transform
```
public Transform(Vector3f translation,
                 Quaternion rot,
                 Vector3f scale)
```
  - Transform
```
public Transform(Vector3f translation)
```
  - Transform
```
public Transform(Quaternion rot)
```
  - Transform
```
public Transform()
```
- Method Detail
  - setRotation
```
public Transform setRotation(Quaternion rot)
```
    Sets this rotation to the given Quaternion value.
    
    Parameters:
    
    rot - The new rotation for this Transform.
    
    Returns:
    
    this
  - setTranslation
```
public Transform setTranslation(Vector3f trans)
```
    Sets this translation to the given value.
    
    Parameters:
    
    trans - The new translation for this Transform.
    
    Returns:
    
    this
  - getTranslation
```
public Vector3f getTranslation()
```
    Return the translation vector in this Transform.
    
    Returns:
    
    translation vector.
  - setScale
```
public Transform setScale(Vector3f scale)
```
    Sets this scale to the given value.
    
    Parameters:
    
    scale - The new scale for this Transform.
    
    Returns:
    
    this
  - setScale
```
public Transform setScale(float scale)
```
    Sets this scale to the given value.
    
    Parameters:
    
    scale - The new scale for this Transform.
    
    Returns:
    
    this
  - getScale
```
public Vector3f getScale()
```
    Return the scale vector in this Transform.
    
    Returns:
    
    scale vector.
  - getTranslation
```
public Vector3f getTranslation(Vector3f trans)
```
    Stores this translation value into the given vector3f. If trans is null, a new vector3f is created to hold the value. The value, once stored, is returned.
    
    Parameters:
    
    trans - The store location for this transform's translation.
    
    Returns:
    
    The value of this transform's translation.
  - getRotation
```
public Quaternion getRotation(Quaternion quat)
```
    Stores this rotation value into the given Quaternion. If quat is null, a new Quaternion is created to hold the value. The value, once stored, is returned.
    
    Parameters:
    
    quat - The store location for this transform's rotation.
    
    Returns:
    
    The value of this transform's rotation.
  - getRotation
```
public Quaternion getRotation()
```
    Return the rotation quaternion in this Transform.
    
    Returns:
    
    rotation quaternion.
  - getScale
```
public Vector3f getScale(Vector3f scale)
```
    Stores this scale value into the given vector3f. If scale is null, a new vector3f is created to hold the value. The value, once stored, is returned.
    
    Parameters:
    
    scale - The store location for this transform's scale.
    
    Returns:
    
    The value of this transform's scale.
  - interpolateTransforms
```
public void interpolateTransforms(Transform t1,
                                  Transform t2,
                                  float delta)
```
    Sets this transform to the interpolation between the first transform and the second by delta amount.
    
    Parameters:
    
    t1 - The beginning transform.
    
    t2 - The ending transform.
    
    delta - An amount between 0 and 1 representing how far to interpolate from t1 to t2.
  - combineWithParent
```
public Transform combineWithParent(Transform parent)
```
    Changes the values of this Transform according to its parent. Very similar to the concept of Node/Spatial transforms.
    
    Parameters:
    
    parent - The parent Transform.
    
    Returns:
    
    This Transform, after combining.
  - setTranslation
```
public Transform setTranslation(float x,
                                float y,
                                float z)
```
    Sets this transform's translation to the given x,y,z values.
    
    Parameters:
    
    x - This transform's new x translation.
    
    y - This transform's new y translation.
    
    z - This transform's new z translation.
    
    Returns:
    
    this
  - setScale
```
public Transform setScale(float x,
                          float y,
                          float z)
```
    Sets this transform's scale to the given x,y,z values.
    
    Parameters:
    
    x - This transform's new x scale.
    
    y - This transform's new y scale.
    
    z - This transform's new z scale.
    
    Returns:
    
    this
  - transformVector
```
public Vector3f transformVector(Vector3f in,
                                Vector3f store)
```
  - transformInverseVector
```
public Vector3f transformInverseVector(Vector3f in,
                                       Vector3f store)
```
  - toTransformMatrix
```
public Matrix4f toTransformMatrix()
```
  - toTransformMatrix
```
public Matrix4f toTransformMatrix(Matrix4f store)
```
  - fromTransformMatrix
```
public void fromTransformMatrix(Matrix4f mat)
```
  - invert
```
public Transform invert()
```
  - loadIdentity
```
public void loadIdentity()
```
    Loads the identity. Equal to translation=0,0,0 scale=1,1,1 rot=0,0,0,1.
  - isIdentity
```
public boolean isIdentity()
```
    Test for exact identity.
    
    Returns:
    
    true if exactly equal to IDENTITY, otherwise false
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - set
```
public Transform set(Transform matrixQuat)
```
    Sets this Transform to be equal to the given Transform.
    
    Parameters:
    
    matrixQuat - The Transform to be equal to.
    
    Returns:
    
    this
  - write
```
public void write(JmeExporter e)
           throws java.io.IOException
```
    Serialize this transform to the specified exporter, for example when saving to a J3O file.
    
    Specified by:
    
    write in interface Savable
    
    Parameters:
    
    e - (not null)
    
    Throws:
    
    java.io.IOException - from the exporter
  - read
```
public void read(JmeImporter e)
          throws java.io.IOException
```
    De-serialize this transform from the specified importer, for example when loading from a J3O file.
    
    Specified by:
    
    read in interface Savable
    
    Parameters:
    
    e - (not null)
    
    Throws:
    
    java.io.IOException - from the importer
  - clone
```
public Transform clone()
```
    Create a copy of this transform.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a new instance, equivalent to this one

Class Transform

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IDENTITY

Constructor Detail

Transform

Transform

Transform

Transform

Transform

Method Detail

setRotation

setTranslation

getTranslation

setScale

setScale

getScale

getTranslation

getRotation

getRotation

getScale

interpolateTransforms

combineWithParent

setTranslation

setScale

transformVector

transformInverseVector

toTransformMatrix

toTransformMatrix

fromTransformMatrix

invert

loadIdentity

isIdentity

hashCode

equals

toString

set

write

read

clone