core/com.pico.spatial.core.ecs/TransformComponent

TransformComponent

@MainThread

class TransformComponent : Component

A Component that manipulates the scale, rotation, and position of the entity.

Constructors

TransformComponent

constructor()

The default constructor.

constructor(transform: Transform)

Creates a TransformComponent initialized with the values from the given Transform.

constructor(position: Vector3, rotation: EulerAngles, scale: Vector3)

Creates a TransformComponent with the specified position, rotation, and scale.

constructor(position: Vector3, rotation: Quat, scale: Vector3)

Creates a TransformComponent with the specified position, rotation, and scale.

Properties

eulerAngles

var eulerAngles: EulerAngles

Euler angles in local space used to control the transform. Default is EulerAngles(0f, 0f, 0f).

position

var position: Vector3

The position in the local coordinate which is used to control the transform. The default value is Vector3(0F, 0F, 0F), measured in meters (m).

quaternion

var quaternion: Quat

Quaternion in local space used to control the transform. Default is Quat.identity().

scaleVector

var scaleVector: Vector3

The scale vector in the local coordinate which is used to control the transform. The default value is Vector3(1F, 1F, 1F).

Functions

clone

open override fun clone(): Component

Creates and returns a copy of this Component instance.

equals

open operator override fun equals(other: Any?): Boolean

getLocalMatrix

fun getLocalMatrix(): Matrix4

Gets the local matrix of the TransformComponent.

hashCode

open override fun hashCode(): Int

scaleBy

fun scaleBy(factor: Float): TransformComponent

Scales the current TransformComponent by the given factor.

setEulerAngles

fun setEulerAngles(eulerAngles: EulerAngles): TransformComponent

Sets the eulerAngles of the TransformComponent.

setPosition

fun setPosition(position: Vector3): TransformComponent

Sets the location of the TransformComponent.

setQuaternion

fun setQuaternion(quaternion: Quat): TransformComponent

Sets the quaternion for the TransformComponent.

setScaleVector

fun setScaleVector(scaleVector: Vector3): TransformComponent

Sets the scale vector of the TransformComponent.

toString

open override fun toString(): String