LayerSceneComponent

Defines the layer scene component responsible to manage any layers in a given scene.

Hierarchy

  • LayerSceneComponent

Implements

Index

Constructors

constructor

Find examples in Playground
  • Creates a new instance of the component for the given scene

    Parameters

    • scene: Scene

      Defines the scene to register the component in

    Returns LayerSceneComponent

Properties

name

Find examples in Playground
name: string

The component name helpfull to identify the component in the list of scene components.

scene

Find examples in Playground
scene: Scene

The scene the component belongs to.

Methods

addFromContainer

Find examples in Playground
  • Adds all the elements from the container to the scene

    Parameters

    Returns void

dispose

Find examples in Playground
  • dispose(): void
  • Disposes the component and the associated ressources.

    Returns void

rebuild

Find examples in Playground
  • rebuild(): void
  • Rebuilds the elements related to this component in case of context lost for instance.

    Returns void

register

Find examples in Playground
  • register(): void

removeFromContainer

Find examples in Playground
  • removeFromContainer(container: AbstractScene, dispose?: boolean): void
  • Removes all the elements in the container from the scene

    Parameters

    • container: AbstractScene

      contains the elements to remove

    • Optional dispose: boolean

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

    Returns void

Generated using TypeDoc