Interface Transform

Description

Controls the position, rotation, and scale of a SceneObject. Every SceneObject automatically has a Transform attached.

Example

// Move attached Transform 1 unit up
var transform = script.getTransform();
var pos = transform.getWorldPosition();
pos.y += 1;
transform.setWorldPosition(pos);

// Bind to "Frame Updated" to rotate the object every frame
var transform = script.getTransform();
var rotation = transform.getLocalRotation();
var rotateBy = quat.angleAxis(Math.PI*getDeltaTime(), vec3.up());
rotation = rotation.multiply(rotateBy);
transform.setLocalRotation(rotation);
interface Transform {
    back: vec3;
    down: vec3;
    forward: vec3;
    left: vec3;
    right: vec3;
    up: vec3;
    getInvertedWorldTransform(): mat4;
    getLocalPosition(): vec3;
    getLocalRotation(): quat;
    getLocalScale(): vec3;
    getSceneObject(): SceneObject;
    getTypeName(): string;
    getWorldPosition(): vec3;
    getWorldRotation(): quat;
    getWorldScale(): vec3;
    getWorldTransform(): mat4;
    isOfType(type): boolean;
    isSame(other): boolean;
    setLocalPosition(pos): void;
    setLocalRotation(rotation): void;
    setLocalScale(scale): void;
    setLocalTransform(transformMat): void;
    setWorldPosition(pos): void;
    setWorldRotation(rotation): void;
    setWorldScale(scale): void;
    setWorldTransform(transformMat): void;
}

Hierarchy (view full)

Properties

back down forward left right up

Methods

getInvertedWorldTransform getLocalPosition getLocalRotation getLocalScale getSceneObject getTypeName getWorldPosition getWorldRotation getWorldScale getWorldTransform isOfType isSame setLocalPosition setLocalRotation setLocalScale setLocalTransform setWorldPosition setWorldRotation setWorldScale setWorldTransform

Properties

Readonly back

back: vec3

Description

Returns the Transform's back directional vector.

Readonly down

down: vec3

Description

Returns the Transform's down directional vector.

Readonly forward

forward: vec3

Description

Returns the Transform's forward directional vector.

Readonly left

left: vec3

Description

Returns the Transform's left directional vector.

Readonly right

right: vec3

Description

Returns the Transform's right directional vector.

Readonly up

up: vec3

Description

Returns the Transform's up directional vector.

Methods

getInvertedWorldTransform

  • getInvertedWorldTransform(): mat4

  • Returns mat4

    Description

    Returns the Transform's world-to-local transformation matrix.

getLocalPosition

  • getLocalPosition(): vec3

  • Returns vec3

    Description

    Returns the Transform's position relative to its parent.

getLocalRotation

  • getLocalRotation(): quat

  • Returns quat

    Description

    Returns the Transform's rotation relative to its parent.

getLocalScale

  • getLocalScale(): vec3

  • Returns vec3

    Description

    Returns the Transform's scale relative to its parent.

getSceneObject

  • getSceneObject(): SceneObject

  • Returns SceneObject

    Description

    Returns the SceneObject the Transform is attached to.

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

getWorldPosition

  • getWorldPosition(): vec3

  • Returns vec3

    Description

    Returns the Transform's position relative to the world.

getWorldRotation

  • getWorldRotation(): quat

  • Returns quat

    Description

    Returns the Transform's rotation relative to the world.

getWorldScale

  • getWorldScale(): vec3

  • Returns vec3

    Description

    Returns the Transform's scale relative to the world.

getWorldTransform

  • getWorldTransform(): mat4

  • Returns mat4

    Description

    Returns the Transform's local-to-world transformation matrix.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

setLocalPosition

  • setLocalPosition(pos): void

  • Parameters

    Returns void

    Description

    Sets the Transform's position relative to its parent.

setLocalRotation

  • setLocalRotation(rotation): void

  • Parameters

    Returns void

    Description

    Sets the Transform's rotation relative to its parent.

setLocalScale

  • setLocalScale(scale): void

  • Parameters

    Returns void

    Description

    Sets the Transform's scale relative to its parent.

setLocalTransform

  • setLocalTransform(transformMat): void

  • Parameters

    Returns void

    Description

    Sets the Transform's local transformation matrix.

setWorldPosition

  • setWorldPosition(pos): void

  • Parameters

    Returns void

    Description

    Sets the Transform's position relative to the world.

setWorldRotation

  • setWorldRotation(rotation): void

  • Parameters

    Returns void

    Description

    Sets the Transform's rotation relative to the world.

setWorldScale

  • setWorldScale(scale): void

  • Parameters

    Returns void

    Description

    Sets the Transform's scale relative to the world. This may produce lossy results when parent objects are rotated, so use setLocalScale() instead if possible.

setWorldTransform

  • setWorldTransform(transformMat): void

  • Parameters

    Returns void

    Description

    Sets the Transform's transformation matrix.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc