Class Canvas

Hierarchy (view full)

Implements

  • ICanvas

Accessors

Canvas Root activeAndEnabled canvas castShadows context controlsChildLayout depthWrite destroyed doubleSided enabled forward hideFlags isCanvas isComponent layer name receiveShadows renderMode renderOnTop right rootCanvas scaleFactor scene screenspace static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

__internalNewInstanceCreated addEventListener addShadowComponent applyRenderSettings awake destroy dispatchEvent earlyUpdate? isRoot lateUpdate? markDirty onAfterAddedToScene onAfterRender? onAfterRenderRoutine onBeforeRender? onBeforeRenderRoutine onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? registerEventReceiver registerLayoutGroup registerTransform removeEventListener removeShadowComponent resolveGuids? set setInteractable setShadowComponentOwner setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stopCoroutine unregisterEventReceiver unregisterLayoutGroup unregisterTransform update?

Accessors

Protected Canvas

  • get Canvas(): ICanvas

  • Returns ICanvas

Protected Root

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

canvas

  • get canvas(): ICanvas

  • Returns ICanvas

castShadows

  • get castShadows(): boolean

  • Returns boolean

  • set castShadows(val): void

  • Parameters

    • val: boolean

    Returns void

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

controlsChildLayout

  • get controlsChildLayout(): boolean

  • Returns boolean

  • set controlsChildLayout(val): void

  • Parameters

    • val: boolean

    Returns void

depthWrite

  • get depthWrite(): boolean

  • Returns boolean

  • set depthWrite(val): void

  • Parameters

    • val: boolean

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

doubleSided

  • get doubleSided(): boolean

  • Returns boolean

  • set doubleSided(val): void

  • Parameters

    • val: boolean

    Returns void

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Forward (0,0,-1) vector in world space

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isCanvas

  • get isCanvas(): boolean

  • Returns boolean

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

receiveShadows

  • get receiveShadows(): boolean

  • Returns boolean

  • set receiveShadows(val): void

  • Parameters

    • val: boolean

    Returns void

renderMode

  • get renderMode(): RenderMode

  • Returns RenderMode

  • set renderMode(val): void

  • Parameters

    • val: RenderMode

    Returns void

renderOnTop

  • get renderOnTop(): boolean

  • Returns boolean

  • set renderOnTop(val): void

  • Parameters

    • val: boolean

    Returns void

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

rootCanvas

  • get rootCanvas(): Canvas

  • Returns Canvas

  • set rootCanvas(val): void

  • Parameters

    Returns void

scaleFactor

  • get scaleFactor(): number

  • Returns number

  • set scaleFactor(val): void

  • Parameters

    • val: number

    Returns void

scene

  • get scene(): Scene

  • Returns Scene

screenspace

  • get screenspace(): any

  • Returns any

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

up

  • get up(): Vector3

  • Up (0,1,0) vector in world space

    Returns Vector3

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    • val: Euler

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    • val: Quaternion

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

Methods

__internalNewInstanceCreated

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

Protected addShadowComponent

applyRenderSettings

  • applyRenderSettings(): void

  • Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

destroy

dispatchEvent

Optional earlyUpdate

isRoot

Optional lateUpdate

markDirty

Protected onAfterAddedToScene

Optional onAfterRender

onAfterRenderRoutine

  • onAfterRenderRoutine(): void

  • Returns void

Optional onBeforeRender

onBeforeRenderRoutine

  • onBeforeRenderRoutine(): void

  • Returns void

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

  • onTriggerExit(col): any

  • Parameters

    • col: ICollider

    Returns any

Optional onTriggerStay

  • onTriggerStay(col): any

  • Parameters

    • col: ICollider

    Returns any

Optional onValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optional prop: string

    Returns void

registerEventReceiver

  • registerEventReceiver(receiver): void

  • Parameters

    • receiver: ICanvasEventReceiver

    Returns void

registerLayoutGroup

  • registerLayoutGroup(group): void

  • Parameters

    • group: ILayoutGroup

    Returns void

registerTransform

  • registerTransform(rt): void

  • Parameters

    • rt: IRectTransform

    Returns void

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

Protected removeShadowComponent

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

set

setInteractable

Protected setShadowComponentOwner

setWorldPosition

setWorldQuaternion

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

start

startCoroutine

stopCoroutine

unregisterEventReceiver

  • unregisterEventReceiver(receiver): void

  • Parameters

    • receiver: ICanvasEventReceiver

    Returns void

unregisterLayoutGroup

  • unregisterLayoutGroup(group): void

  • Parameters

    • group: ILayoutGroup

    Returns void

unregisterTransform

  • unregisterTransform(rt): void

  • Parameters

    • rt: IRectTransform

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

CanvasRootactiveAndEnabledcanvascastShadowscontextcontrolsChildLayoutdepthWritedestroyeddoubleSidedenabledforwardhideFlagsisCanvasisComponentlayernamereceiveShadowsrenderModerenderOnToprightrootCanvasscaleFactorscenescreenspacestatictagupworldEulerworldPositionworldQuaternionworldRotation__internalNewInstanceCreatedaddEventListeneraddShadowComponentapplyRenderSettingsawakedestroydispatchEventearlyUpdateisRootlateUpdatemarkDirtyonAfterAddedToSceneonAfterRenderonAfterRenderRoutineonBeforeRenderonBeforeRenderRoutineonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateregisterEventReceiverregisterLayoutGroupregisterTransformremoveEventListenerremoveShadowComponentresolveGuidssetsetInteractablesetShadowComponentOwnersetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineunregisterEventReceiverunregisterLayoutGroupunregisterTransformupdate

Generated using TypeDoc