Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReadonlyTransform

Defines the position, scale and rotation of an item.

Every Transform can be assigned to a BaseItem.parent which allows hierarchical editing of their position, scale and rotation. Created hierarchies are displayed in the Item Hierarchy tab.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly axisX

axisX: Vector3

Red axis of this Transform.

Readonly axisY

axisY: Vector3

Green axis of this Transform.

Readonly axisZ

axisZ: Vector3

Blue axis of this Transform.

Readonly forward

forward: Vector3

Shorthand for Y - axis.

Note: By default, DX Engine uses the green Y axis as forward vector.

Readonly position

position: Vector3

Position of this Transform using X, Y, and Z coordinates.

Note: By default, DX engine uses Z for "up".

Readonly right

right: Vector3

Shorthand for X - axis.

Note: By default, DX Engine uses the red X axis as right vector.

Readonly rotation

rotation: Quat

Rotation of this Transform stored as Quat.

Readonly scale

scale: number

Scale of this Transform.

Default value is 1.

Readonly up

up: Vector3

Shorthand for Z - axis.

Note: By default, DX Engine uses the Z axis as up vector.

Methods

copy

  • Returns a copy of this Transform.

    Returns Transform

    copy of this Transform.

localToWorldPoint

  • Converts local position to world position of this Transform.

    Parameters

    • position: Vector3

      local space point.`

    Returns Vector3

    world space point.

localToWorldVector

  • Converts local direction to world direction of this Transform.

    Parameters

    • direction: Vector3

      local space direction.

    Returns Vector3

    world space direction.

worldToLocalPoint

  • Converts world position to local position of this Transform.

    Parameters

    • position: Vector3

      world space point.

    Returns Vector3

    local space point.

worldToLocalVector

  • Converts world direction to local direction of this Transform.

    Parameters

    • direction: Vector3

      world space direction.

    Returns Vector3

    local space direction.