Class PostProcessingEffectAbstract

Hierarchy (view full)

Implements

  • IEffectProvider
  • ISerializable
  • IEditorModification

Accessors

activeAndEnabled context destroyed enabled forward hideFlags isComponent layer name right scene static tag typeName up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener apply awake destroy dispatchEvent dispose earlyUpdate? init lateUpdate? onAfterDeserialize onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onCreateEffect? onDestroy onDisable onEditorModification onEnable onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine unapply update?

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

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

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

right

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

Abstract typeName

  • get typeName(): string

  • Returns string

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

Methods

addEventListener

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

  • Type Parameters

    Parameters

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

        • Parameters

          • evt: T

          Returns any

    Returns void

apply

  • apply(): any

  • Apply post settings. Make sure to call super.apply() if you also create an effect

    Returns any

awake

  • awake(): void

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

    Returns void

destroy

dispatchEvent

dispose

  • dispose(): void

  • Returns void

Optional earlyUpdate

init

  • init(): void

  • override to initialize bindings on parameters

    Returns void

Optional lateUpdate

onAfterDeserialize

  • onAfterDeserialize(data, _context): void

  • Parameters

    • data: any
    • _context: SerializationContext

    Returns void

Optional onAfterRender

Optional onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

Optional onCreateEffect

  • onCreateEffect(): any

  • implement to create a effect once to be cached in the base class. Make sure super.apply() is called if you also override apply

    Returns any

onDestroy

onDisable

onEditorModification

  • onEditorModification(modification): boolean | void

  • Parameters

    • modification: EditorModification

    Returns boolean | void

onEnable

  • onEnable(): void

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

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

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

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

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

unapply

  • unapply(): void

  • Reset previously set values (e.g. when adjusting settings on the renderer like Tonemapping)

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

activeAndEnabledcontextdestroyedenabledforwardhideFlagsisComponentlayernamerightscenestatictagtypeNameupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerapplyawakedestroydispatchEventdisposeearlyUpdateinitlateUpdateonAfterDeserializeonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonCreateEffectonDestroyonDisableonEditorModificationonEnableonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineunapplyupdate

Generated using TypeDoc