Class Scene

constructor

• new Scene(engine, options?): Scene

• Parameters

  • engine: Engine
  • options: SceneOptions = {}

  Returns Scene

Readonlyengine

sceneRenderer

activeCameras

• get activeCameras(): readonly Camera[]

• Get active cameras

  Returns readonly Camera[]

  Memberof

  Scene

background

• get background(): Background

• Get scene background

  Returns Background

  Memberof

  Scene

environment

• get environment(): Environment

• Get environment

  Returns Environment

  Memberof

  Scene

isActive

• get isActive(): boolean

• Whether the scene is actived.

  Returns boolean

  Memberof

  Scene

• set isActive(value): void

• Whether to active the scene

  Parameters

  • value: boolean

  Returns void

  Memberof

  Scene

native

• get native(): Scene

• Get three.js native scene

  Returns Scene

  Memberof

  Scene

rootEntity

• get rootEntity(): Entity

• Get the scene root entity

  Returns Entity

  Memberof

  Scene

createOrthographicCamera

• createOrthographicCamera(options): Entity

• Create a orthographic render camera

  Parameters

  • options: OrthographicCameraEntityOptions

    camera options

  Returns Entity

  Memberof

  Scene

createPerspectiveCamera

• createPerspectiveCamera(options): Entity

• Create a perspective render camera

  Parameters

  • options: PerspectiveCameraEntityOptions

  Returns Entity

  Memberof

  Scene

dispose

• dispose(): void

• Dispose the scene

  Returns void

  Memberof

  Scene

emit

• emit(event): void

• Emit event

  Parameters

  • event: {
        type: string;
        [key: string]: any;
    }

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

off

• off(type, callback?): void

• Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

  Parameters

  • type: string
  • Optionalcallback: SubscriberCallbackFn

    subscriber callback

  Returns void

  Memberof

  EventDispatcher

on

• on(type, callback, options?): void

• Subscribe a event

  Parameters

  • type: string

    event type
  • callback: SubscriberCallbackFn

    callback functions
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    } = {}

    options

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

once

• once(type, callback, options?): void

• Subscribe a event, just emit once

  Parameters

  • type: string
  • callback: SubscriberCallbackFn

    subscriber callback
  • options: {
        priority?: Priority;
        target?: any;
    } = {}

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

render

• render(options?): void

• Built-in scene rendering inteface.

  Parameters

  • Optionaloptions: RenderOptions = {}

  Returns void

  Memberof

  Scene

setBackground

• setBackground(mode, options?): void

• Set scene background

  Parameters

  • mode: BackgroundMode
  • Optionaloptions: ColorRepresentation | SkyOptions | TextureBackgroundOptions

  Returns void

  Memberof

  Scene