Transform (SpongeAPI 7.4.0 API)

java.lang.Object
- org.spongepowered.api.entity.Transform<E>

Type Parameters:

E - The extent containing the transform
```
public final class Transform<E extends Extent>
extends Object
```
Represents the immutable world attributes of an Entity. Comprised of a Location and two Vector3d representing the rotation and the scale. The implementation may internally use a location or a separate extent and position. Be wary that calling getLocation() could result in object creation.
A transform might not have an extent if it is invalid. In this case all methods which return a reference to it will throw IllegalStateException.

This is an entity transform, not a model one. These values are subject to interpretation by the implementation and may trigger animations depending on the target model.

Even though Minecraft doesn't currently support entity scales it is part of the transform in case it gets added later. For now this return Vector3d.ONE.

Constructor Summary

Constructors
Constructor and Description
`Transform(E extent)` Creates a new `Transform` with the provided `extent`.
`Transform(E extent, com.flowpowered.math.vector.Vector3d position)` Creates a new `Transform` with the provided `extent` and `position`.
`Transform(E extent, com.flowpowered.math.vector.Vector3d position, com.flowpowered.math.vector.Vector3d rotation)` Creates a new `Transform` with the provided `extent`, `position`, and `rotation`.
`Transform(E extent, com.flowpowered.math.vector.Vector3d position, com.flowpowered.math.vector.Vector3d rotation, com.flowpowered.math.vector.Vector3d scale)` Creates a new `Transform`.
`Transform(Location<E> location)` Creates a new `Transform` based on the provided `Location`.
`Transform(Location<E> location, com.flowpowered.math.vector.Vector3d rotation, com.flowpowered.math.vector.Vector3d scale)` Creates a new `Transform` with the provided `Location`, `rotation`, and `scale`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Transform<E>`	`add(Transform<E> other)` "Adds" another transform to this one.
`Transform<E>`	`addRotation(com.flowpowered.math.imaginary.Quaterniond rotation)` Adds a rotation to this transform.
`Transform<E>`	`addRotation(com.flowpowered.math.vector.Vector3d rotation)` Adds a rotation to this transform.
`Transform<E>`	`addScale(com.flowpowered.math.vector.Vector3d scale)` "Adds" a scale to this transform.
`Transform<E>`	`addTranslation(com.flowpowered.math.vector.Vector3d translation)` Adds a translation to this transform.
`boolean`	`equals(Object other)`
`E`	`getExtent()` Gets the `Extent` this transform contains.
`Location<E>`	`getLocation()` Gets the `Location` this transform contains.
`double`	`getPitch()` Gets the pitch component of this transform rotation.
`com.flowpowered.math.vector.Vector3d`	`getPosition()` Gets the coordinates of this transform.
`double`	`getRoll()` Gets the roll component of this transform rotation.
`com.flowpowered.math.vector.Vector3d`	`getRotation()` Gets the rotation of this transform, as a `Vector3d`.
`com.flowpowered.math.imaginary.Quaterniond`	`getRotationAsQuaternion()` Returns the rotation as a quaternion.
`com.flowpowered.math.vector.Vector3d`	`getScale()` Gets the scale of the transform for each axis.
`double`	`getYaw()` Gets the yaw component of this transform rotation.
`int`	`hashCode()`
`boolean`	`isValid()` Returns if this `Transform` is still valid.
`Transform<E>`	`setExtent(E extent)` Creates a copy of this transform and sets the `Extent`.
`Transform<E>`	`setLocation(Location<E> location)` Creates a copy of this transform and sets the `Location`.
`Transform<E>`	`setPosition(com.flowpowered.math.vector.Vector3d position)` Creates a copy of this transform while setting the position of the new one.
`Transform<E>`	`setRotation(com.flowpowered.math.imaginary.Quaterniond rotation)` Creates a copy of this transform and sets the rotation.
`Transform<E>`	`setRotation(com.flowpowered.math.vector.Vector3d rotation)` Creates a copy of this transform and sets the rotation as a quaternion.
`Transform<E>`	`setScale(com.flowpowered.math.vector.Vector3d scale)` Creates a copy of this transform and sets the scale for each axis.
`com.flowpowered.math.matrix.Matrix4d`	`toMatrix()` Returns a matrix representation of this transform.
`String`	`toString()`

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

- Constructor Detail
  - Transform
```
public Transform(Location<E> location)
```
    Creates a new Transform based on the provided Location.
    
    Parameters:
    
    location - The provided location that provides the extent, and position
  - Transform
```
public Transform(E extent)
```
    Creates a new Transform with the provided extent. The default position is Vector3d.ZERO.
    
    Parameters:
    
    extent - The extent to use
  - Transform
```
public Transform(E extent,
                 com.flowpowered.math.vector.Vector3d position)
```
    Creates a new Transform with the provided extent and position.
    
    Parameters:
    
    extent - The extent to use
    
    position - The position to use
  - Transform
```
public Transform(E extent,
                 com.flowpowered.math.vector.Vector3d position,
                 com.flowpowered.math.vector.Vector3d rotation)
```
    Creates a new Transform with the provided extent, position, and rotation.
    
    Parameters:
    
    extent - The extent to use
    
    position - The position to use
    
    rotation - The rotation to use
  - Transform
```
public Transform(Location<E> location,
                 com.flowpowered.math.vector.Vector3d rotation,
                 com.flowpowered.math.vector.Vector3d scale)
```
    Creates a new Transform with the provided Location, rotation, and scale.
    
    Parameters:
    
    location - The location to use, providing the extent and position
    
    rotation - The rotation to use
    
    scale - The scale to use
  - Transform
```
public Transform(E extent,
                 com.flowpowered.math.vector.Vector3d position,
                 com.flowpowered.math.vector.Vector3d rotation,
                 com.flowpowered.math.vector.Vector3d scale)
```
    Creates a new Transform.
    
    Parameters:
    
    extent - The extent to use
    
    position - The position to use
    
    rotation - The rotation to use
    
    scale - The scale to use
- Method Detail
  - getLocation
```
public Location<E> getLocation()
```
    Gets the Location this transform contains. This is the position and the extent.
    
    Returns:
    
    The location
    
    Throws:
    
    IllegalStateException - If the transform doesn't have an extent
  - setLocation
```
public Transform<E> setLocation(Location<E> location)
```
    Creates a copy of this transform and sets the Location. This sets both the position and the extent.
    
    Parameters:
    
    location - The new location
    
    Returns:
    
    A new transform
  - getExtent
```
public E getExtent()
```
    Gets the Extent this transform contains.
    Note: This can be null if the Extent is unloaded and garbage collected.
    
    Returns:
    
    The extent
    
    Throws:
    
    IllegalStateException - If the transform doesn't have an extent
  - setExtent
```
public Transform<E> setExtent(E extent)
```
    Creates a copy of this transform and sets the Extent.
    
    Parameters:
    
    extent - The new extent
    
    Returns:
    
    A new transform
  - getPosition
```
public com.flowpowered.math.vector.Vector3d getPosition()
```
    Gets the coordinates of this transform.
    
    Returns:
    
    The coordinates
  - setPosition
```
public Transform<E> setPosition(com.flowpowered.math.vector.Vector3d position)
```
    Creates a copy of this transform while setting the position of the new one.
    
    Parameters:
    
    position - The position
    
    Returns:
    
    A new transform
  - getRotation
```
public com.flowpowered.math.vector.Vector3d getRotation()
```
    Gets the rotation of this transform, as a Vector3d.
    The format of the rotation is represented by:
    - x -> pitch
    - y -> yaw
    - z -> roll
    Returns:
    
    The rotation vector
  - setRotation
```
public Transform<E> setRotation(com.flowpowered.math.imaginary.Quaterniond rotation)
```
    Creates a copy of this transform and sets the rotation.
    The format of the rotation is represented by:
    - x -> pitch
    - y -> yaw
    - z -> roll
    Parameters:
    
    rotation - The new rotation
    
    Returns:
    
    A new transform
  - setRotation
```
public Transform<E> setRotation(com.flowpowered.math.vector.Vector3d rotation)
```
    Creates a copy of this transform and sets the rotation as a quaternion.
    Quaternions are objectively better than the Euler angles preferred by Minecraft. This is for compatibility with the flow-math library.
    
    Parameters:
    
    rotation - The new rotation
    
    Returns:
    
    A new transform
  - getRotationAsQuaternion
```
public com.flowpowered.math.imaginary.Quaterniond getRotationAsQuaternion()
```
    Returns the rotation as a quaternion.
    Quaternions are objectively better than the Euler angles preferred by Minecraft. This is for compatibility with the flow-math library.
    
    Returns:
    
    The rotation
  - getPitch
```
public double getPitch()
```
    Gets the pitch component of this transform rotation.
    
    Returns:
    
    The pitch
  - getYaw
```
public double getYaw()
```
    Gets the yaw component of this transform rotation.
    
    Returns:
    
    The yaw
  - getRoll
```
public double getRoll()
```
    Gets the roll component of this transform rotation.
    
    Returns:
    
    The roll
  - getScale
```
public com.flowpowered.math.vector.Vector3d getScale()
```
    Gets the scale of the transform for each axis.
    
    Returns:
    
    The scale
  - setScale
```
public Transform<E> setScale(com.flowpowered.math.vector.Vector3d scale)
```
    Creates a copy of this transform and sets the scale for each axis.
    
    Parameters:
    
    scale - The scale
    
    Returns:
    
    A new transform
  - add
```
public Transform<E> add(Transform<E> other)
```
    "Adds" another transform to this one. This is equivalent to adding the translation, rotation and scale individually.
    Returns the results as a new copy.
    
    Parameters:
    
    other - The transform to add
    
    Returns:
    
    A new transform
  - addTranslation
```
public Transform<E> addTranslation(com.flowpowered.math.vector.Vector3d translation)
```
    Adds a translation to this transform.
    Returns the results as a new copy.
    
    Parameters:
    
    translation - The translation to add
    
    Returns:
    
    A new transform
  - addRotation
```
public Transform<E> addRotation(com.flowpowered.math.vector.Vector3d rotation)
```
    Adds a rotation to this transform. Returns the results as a new copy.
    
    Parameters:
    
    rotation - The rotation to add
    
    Returns:
    
    A new transform
  - addRotation
```
public Transform<E> addRotation(com.flowpowered.math.imaginary.Quaterniond rotation)
```
    Adds a rotation to this transform.
    Quaternions are objectively better than the Euler angles preferred by Minecraft. This is the preferred method when dealing with rotation additions. This is for compatibility with the flow-math library.
    
    Returns the results as a new copy.
    
    Parameters:
    
    rotation - The rotation to add
    
    Returns:
    
    A new transform
  - addScale
```
public Transform<E> addScale(com.flowpowered.math.vector.Vector3d scale)
```
    "Adds" a scale to this transform. Scales are multiplicative, so this actually multiplies the current scale.
    Returns the results as a new copy.
    
    Parameters:
    
    scale - The scale to add
    
    Returns:
    
    A new transform
  - toMatrix
```
public com.flowpowered.math.matrix.Matrix4d toMatrix()
```
    Returns a matrix representation of this transform.
    This includes the position, rotation and scale. To apply the transform to a vector, use the following:
    
    Vector3d original = ...; Transform transform = ...; Vector3d transformed = transform.toMatrix().transform(original.toVector4(1)).toVector3(); }
    
    This converts the original 3D vector to 4D by appending 1 as the w coordinate, applies the transformation, then converts it back to 3D by dropping the w coordinate.
    
    Using a 4D matrix and a w coordinate with value 1 is what allows for the position to be included in the transformation applied by the matrix.
    
    Returns:
    
    The transform as a matrix
  - isValid
```
public boolean isValid()
```
    Returns if this Transform is still valid.
    Examples of invalid Transforms are:
    - A Transform without an Extent
    - A Transform whose Extent object is no longer present
    - A Transform whose coordinates are illegal (defined by the implementation)
    Returns:
    
    True if valid, false if not
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Transform<E extends Extent>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Transform

Transform

Transform

Transform

Transform

Transform

Method Detail

getLocation

setLocation

getExtent

setExtent

getPosition

setPosition

getRotation

setRotation

setRotation

getRotationAsQuaternion

getPitch

getYaw

getRoll

getScale

setScale

add

addTranslation

addRotation

addRotation

addScale

toMatrix

isValid

hashCode

equals

toString