Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISceneSerializableComponent

This represents a SERIALIZABLE scene component.

This extends Scene Component to add Serialization methods on top.

Hierarchy

Implemented by

Index

Properties

nameSearch playground for name

name: string

The name of the component. Each component must have a unique name.

sceneSearch playground for scene

scene: Scene

The scene the component belongs to.

Methods

addFromContainerSearch playground for addFromContainer

  • Adds all the elements from the container to the scene

    Parameters

    Returns void

disposeSearch playground for dispose

  • dispose(): void
  • Disposes the component and the associated ressources.

    Returns void

rebuildSearch playground for rebuild

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

    Returns void

registerSearch playground for register

  • register(): void
  • Register the component to one instance of a scene.

    Returns void

removeFromContainerSearch playground for removeFromContainer

  • 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

serializeSearch playground for serialize

  • serialize(serializationObject: any): void
  • Serializes the component data to the specified json object

    Parameters

    • serializationObject: any

      The object to serialize to

    Returns void

Legend

  • Property
  • Method
  • Constructor
  • Property
  • Static method