Class EffectLayerSceneComponent

constructor

• new EffectLayerSceneComponent(scene?: Scene): EffectLayerSceneComponent

  Creates a new instance of the component for the given scene

  Parameters

  • Optionalscene: Scene

    Defines the scene to register the component in

  Returns EffectLayerSceneComponent

Readonlyname

scene

addFromContainer

• addFromContainer(container: IAssetContainer): void

  Adds all the elements from the container to the scene

  Parameters

  • container: IAssetContainer

    the container holding the elements

  Returns void

dispose

• dispose(): void

  Disposes the component and the associated resources.

  Returns void

rebuild

• rebuild(): void

  Rebuilds the elements related to this component in case of context lost for instance.

  Returns void

register

• register(): void

  Registers the component in a given scene

  Returns void

removeFromContainer

• removeFromContainer(container: IAssetContainer, dispose?: boolean): void

  Removes all the elements in the container from the scene

  Parameters

  • container: IAssetContainer

    contains the elements to remove

  • Optionaldispose: boolean

    if the removed element should be disposed (default: false)

  Returns void

serialize

• serialize(serializationObject: any): void

  Serializes the component data to the specified json object

  Parameters

  • serializationObject: any

    The object to serialize to

  Returns void