Class Camera

Hierarchy (view full)

Implements

  • ICamera

Accessors

activeAndEnabled aspect backgroundBlurriness backgroundColor backgroundIntensity cam clearFlags context cullingLayer cullingMask destroyed enabled environmentIntensity farClipPlane fieldOfView forward hideFlags isCamera isComponent layer name nearClipPlane right scene static tag targetTexture up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener applyClearFlags applyClearFlagsIfIsActiveCamera awake buildCamera destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? screenPointToRay setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine update? backgroundShouldBeTransparent

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

aspect

  • get aspect(): number

  • Returns number

backgroundBlurriness

  • get backgroundBlurriness(): number

  • Returns number

  • set backgroundBlurriness(val): void

  • Parameters

    • val: number

    Returns void

backgroundColor

  • get backgroundColor(): RGBAColor

  • Returns RGBAColor

  • set backgroundColor(val): void

  • Parameters

    Returns void

backgroundIntensity

  • get backgroundIntensity(): number

  • Returns number

  • set backgroundIntensity(val): void

  • Parameters

    • val: number

    Returns void

cam

  • get cam(): any

  • Returns any

clearFlags

  • get clearFlags(): ClearFlags

  • Returns ClearFlags

  • set clearFlags(val): void

  • Parameters

    • val: ClearFlags

    Returns void

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

cullingLayer

  • set cullingLayer(val): void

  • Set only a specific layer active to be rendered by the camera. This is equivalent to calling layers.set(val)

    Parameters

    • val: number

    Returns void

cullingMask

  • get cullingMask(): number

  • Returns number

  • set cullingMask(val): void

  • The mask value of the three camera object layers If you want to just see objects on one layer (e.g. layer 2) then you can use cullingLayer = 2 on this camera component instead

    Parameters

    • val: number

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

environmentIntensity

  • get environmentIntensity(): number

  • Returns number

  • set environmentIntensity(val): void

  • Parameters

    • val: number

    Returns void

farClipPlane

  • get farClipPlane(): number

  • Returns number

  • set farClipPlane(val): void

  • Parameters

    • val: number

    Returns void

fieldOfView

  • get fieldOfView(): number

  • Returns number

  • set fieldOfView(val): void

  • Parameters

    • val: number

    Returns void

forward

  • get forward(): Vector3

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

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isCamera

  • get isCamera(): 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

nearClipPlane

  • get nearClipPlane(): number

  • Returns number

  • set nearClipPlane(val): void

  • Parameters

    • val: number

    Returns void

right

  • get right(): Vector3

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

    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

targetTexture

  • get targetTexture(): RenderTexture

  • Returns RenderTexture

  • set targetTexture(rt): void

  • Parameters

    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

addEventListener

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

  • Type Parameters

    Parameters

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

        • Parameters

          • evt: T

          Returns any

    Returns void

applyClearFlags

  • applyClearFlags(): void

  • Returns void

applyClearFlagsIfIsActiveCamera

  • applyClearFlagsIfIsActiveCamera(): void

  • Returns void

awake

  • awake(): void

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

    Returns void

buildCamera

  • buildCamera(): void

  • Returns void

destroy

  • destroy(): void

  • Returns void

dispatchEvent

Optional earlyUpdate

  • earlyUpdate(): void

  • Returns void

Optional lateUpdate

  • lateUpdate(): void

  • Returns void

Optional onAfterRender

  • onAfterRender(): void

  • Returns void

onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

  • onDestroy(): void

  • Returns void

onDisable

  • onDisable(): void

  • Returns void

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

  • 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

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

screenPointToRay

  • screenPointToRay(x, y, ray?): Ray

  • Parameters

    • x: number
    • y: number
    • Optional ray: Ray

    Returns Ray

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

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

  • Parameters

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

    Returns void

Optional start

  • start(): void

  • Returns void

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

Optional update

  • update(): void

  • Returns void

Static backgroundShouldBeTransparent

  • backgroundShouldBeTransparent(context): any

  • Returns true when in XR on a pass through device where the background shouldbe invisible

    Parameters

    Returns any

Settings

Member Visibility

Theme

On This Page

activeAndEnabledaspectbackgroundBlurrinessbackgroundColorbackgroundIntensitycamclearFlagscontextcullingLayercullingMaskdestroyedenabledenvironmentIntensityfarClipPlanefieldOfViewforwardhideFlagsisCameraisComponentlayernamenearClipPlanerightscenestatictagtargetTextureupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerapplyClearFlagsapplyClearFlagsIfIsActiveCameraawakebuildCameradestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidsscreenPointToRaysetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdatebackgroundShouldBeTransparent

Generated using TypeDoc