Class Renderer

Hierarchy (view full)

Implements

  • IRenderer

Accessors

activeAndEnabled context destroyed enabled forward hasLightmap hideFlags isComponent layer lightmap material name right scene sharedMaterial sharedMesh static tag up worldEuler worldPosition worldQuaternion worldRotation shouldSuppressInstancing

Methods

addEventListener applySettings applyStencil awake destroy dispatchEvent earlyUpdate? lateUpdate? loadProgressiveTextures onAfterRender onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? registering removeEventListener resolveGuids? setInstancingEnabled setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stopCoroutine update? useInstanceMatrixWorldAutoUpdate setVisible

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    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

  • Returns Vector3

hasLightmap

  • get hasLightmap(): boolean

  • Returns boolean

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

lightmap

  • get lightmap(): any

  • Returns any

  • set lightmap(tex): void

  • Parameters

    • tex: any

    Returns void

material

  • get material(): Material

  • Returns Material

    Deprecated

    please use sharedMaterial

  • set material(mat): void

  • Parameters

    • mat: Material

    Returns void

    Deprecated

    please use sharedMaterial

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

sharedMaterial

  • get sharedMaterial(): Material

  • Returns Material

  • set sharedMaterial(mat): void

  • Parameters

    • mat: Material

    Returns void

sharedMesh

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

  • 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

Static shouldSuppressInstancing

  • get shouldSuppressInstancing(): string | number | boolean

  • Returns string | number | boolean

Methods

addEventListener

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

  • Type Parameters

    Parameters

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

        • Parameters

          • evt: T

          Returns any

    Returns void

applySettings

  • applySettings(go): void

  • Parameters

    • go: Object3D

    Returns void

applyStencil

  • applyStencil(): void

  • Returns void

awake

  • awake(): void

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

    Returns void

destroy

  • destroy(): void

  • Returns void

dispatchEvent

Optional earlyUpdate

  • earlyUpdate(): void

  • Returns void

Optional lateUpdate

  • lateUpdate(): void

  • Returns void

loadProgressiveTextures

onAfterRender

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 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

registering

  • registering(): void

  • 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

setInstancingEnabled

  • setInstancingEnabled(enabled): boolean

  • Parameters

    • enabled: boolean

    Returns boolean

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

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

useInstanceMatrixWorldAutoUpdate

  • useInstanceMatrixWorldAutoUpdate(): boolean

  • Return true to wrap matrix update events for instanced rendering to update instance matrices automatically when matrixWorld changes This is a separate method to be overrideable from user code

    Returns boolean

Static setVisible

  • setVisible(obj, visible): void

  • Set the rendering state only of an object (makes it visible or invisible) without affecting component state or child hierarchy visibility! You can also just enable/disable the Renderer component on that object for the same effect!

    If you want to activate or deactivate a complete object you can use obj.visible as usual (it acts the same as setActive in Unity)

    Parameters

    • obj: Object3D
    • visible: boolean

    Returns void

Settings

Member Visibility

Theme

On This Page

activeAndEnabledcontextdestroyedenabledforwardhasLightmaphideFlagsisComponentlayerlightmapmaterialnamerightscenesharedMaterialsharedMeshstatictagupworldEulerworldPositionworldQuaternionworldRotationshouldSuppressInstancingaddEventListenerapplySettingsapplyStencilawakedestroydispatchEventearlyUpdatelateUpdateloadProgressiveTexturesonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonTriggerEnteronTriggerExitonTriggerStayonValidateregisteringremoveEventListenerresolveGuidssetInstancingEnabledsetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdateuseInstanceMatrixWorldAutoUpdatesetVisible

Generated using TypeDoc