Class RectTransform

Hierarchy (view full)

Implements

  • IRectTransform
  • IRectTransformChangedReceiver

Properties

minHeight? minWidth?

Accessors

Canvas Root activeAndEnabled anchoredPosition canvas context controlsChildLayout destroyed enabled forward height hideFlags isComponent isDirty layer name parent right rotation scale scene static tag translation up width worldEuler worldPosition worldQuaternion worldRotation

Methods

__internalNewInstanceCreated addEventListener addShadowComponent awake createNewBlock createNewText destroy dispatchEvent earlyUpdate? getBasicOptions isRoot lateUpdate? markDirty onAfterAddedToScene onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onParentRectTransformChanged onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener removeShadowComponent resolveGuids? set setInteractable setShadowComponentOwner setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine update? updateTransform

Properties

Optional minHeight

minHeight?: number

Optional min height in pixel, set to undefined to disable it

Optional minWidth

minWidth?: number

Optional min width in pixel, set to undefined to disable it

Accessors

Protected Canvas

  • get Canvas(): ICanvas

  • Returns ICanvas

Protected Root

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

anchoredPosition

  • get anchoredPosition(): Vector2

  • Returns Vector2

  • set anchoredPosition(value): void

  • Parameters

    • value: Vector2

    Returns void

canvas

  • get canvas(): ICanvas

  • Returns ICanvas

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

destroyed

  • get destroyed(): boolean

  • Returns boolean

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

height

  • get height(): any

  • Returns any

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isDirty

  • get isDirty(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

parent

right

  • get right(): Vector3

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

    Returns Vector3

rotation

  • get rotation(): any

  • Returns any

scale

  • get scale(): Vector3

  • Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

translation

  • get translation(): any

  • Returns any

up

  • get up(): Vector3

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

    Returns Vector3

width

  • get width(): any

  • Returns any

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

awake

  • awake(): void

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

    Returns void

createNewBlock

  • createNewBlock(opts?): Block

  • Parameters

    • Optional opts: any

    Returns Block

createNewText

  • createNewText(opts?): Block

  • Parameters

    • Optional opts: any

    Returns Block

destroy

dispatchEvent

Optional earlyUpdate

getBasicOptions

  • getBasicOptions(): ThreeMeshUIEveryOptions

  • Returns ThreeMeshUIEveryOptions

isRoot

Optional lateUpdate

markDirty

Protected onAfterAddedToScene

Optional onAfterRender

Optional onBeforeRender

  • onBeforeRender(frame): void

  • Parameters

    • frame: any

    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

onParentRectTransformChanged

  • onParentRectTransformChanged(comp): void

  • Parameters

    • comp: IRectTransform

    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

  • onTriggerEnter(col): any

  • Parameters

    • col: ICollider

    Returns any

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

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

Optional start

startCoroutine

stopCoroutine

Optional update

updateTransform

  • updateTransform(): void

  • Will update the transforms if it changed or is dirty

    Returns void

Settings

Member Visibility

Theme

On This Page

minHeightminWidthCanvasRootactiveAndEnabledanchoredPositioncanvascontextcontrolsChildLayoutdestroyedenabledforwardheighthideFlagsisComponentisDirtylayernameparentrightrotationscalescenestatictagtranslationupwidthworldEulerworldPositionworldQuaternionworldRotation__internalNewInstanceCreatedaddEventListeneraddShadowComponentawakecreateNewBlockcreateNewTextdestroydispatchEventearlyUpdategetBasicOptionsisRootlateUpdatemarkDirtyonAfterAddedToSceneonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonParentRectTransformChangedonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerremoveShadowComponentresolveGuidssetsetInteractablesetShadowComponentOwnersetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdateupdateTransform

Generated using TypeDoc