Class Canvas

A root of the 2D ScreenTransform hierarchy in 3D space. Also used to configure unit settings of Orthographic Camera.

Remarks

SceneObjects with ScreenTransform can be placed on the Canvas, and the Canvas can be sized and placed anywhere in 3D space. It is like a painter’s canvas for ScreenTransforms.

See

Canvas guide. Screen Transform Overview guide.

Example

var canvas = script.getSceneObject().getComponent("Component.Canvas");
print(canvas.pivot); // Outputs: {x: 0, y: 0}

// Note: this variable will be a COPY of canvas.pivot, not reference 
var pivotCopy = canvas.pivot;  

// Can mutate the copy then set it again 
pivotCopy.x = 1; 
pivotCopy.y = 1;  

canvas.pivot = pivotCopy;

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled pivot sceneObject sortingType uniqueIdentifier unitType worldSpaceRect

Methods

destroy getSceneObject getSize getTransform getTypeName isOfType isSame setSize

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

pivot

pivot: vec2

The point about which the Canvas Rectangle will rotate. Defined as fractional coordinates of the Canvas's dimensions. e.g. (1 , 1) brings the pivot to the top right corner of the canvas. Or (0.5, 0) moves the pivot to the right by half the canvas width.

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

sortingType

sortingType: SortingType

The rendering sort order for the objects underneath this canvas.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

unitType

unitType: UnitType

The unit for the objects underneath this canvas.

worldSpaceRect

worldSpaceRect: Rect

World Space Rectangle that defines the Canvas as offsets in world units from the SceneObject's position

Methods

destroy

  • destroy(): void

    Destroys the component.

    Returns void

getSceneObject

getSize

  • getSize(): vec2

    Get size of rectangle as (width, height)

    Returns vec2

getTransform

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

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

    Parameters

    Returns boolean

setSize

  • setSize(value: vec2): void

    Set size of rectangle as (width, height)

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR