Class SceneModule

EntityBase.

Hierarchy (view full)

AppModuleBase
- SceneModule

Implements

IAppModuleBase

Constructors

constructor

new SceneModule(app?, options?): SceneModule
Parameters
- Optional app: App
- Optional options: SceneModuleOptions
Returns SceneModule
Overrides AppModuleBase.constructor

Properties

`Optional` _app

_app?: App

_axesHelper

_axesHelper: AxesHelper

_config

_config: EnvConfigOption & {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Protected` _destroyed

_destroyed: boolean = false

_loadedResources

_loadedResources: RosourceItemsReturnType

allCameras

allCameras: Camera[] = []

allControlStates

allControlStates: CameraState[] = []

allScenes

allScenes: Scene[] = []

appRenderIndex

appRenderIndex: number = 0

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

options

options: SceneModuleOptions

`Static` moduleName

moduleName: string = "SceneModule"

Accessors

app

get app(): App
Returns App
Inherited from AppModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from AppModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from AppModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from AppModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase.enabled

envConfig

get envConfig(): EnvConfigOption & {
[key: string]: any;
}
Returns EnvConfigOption & {
[key: string]: any;
}

sceneEntity

get sceneEntity(): any
Returns any

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from AppModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from AppModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from AppModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from AppModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from AppModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase._setActive

activeScene

activeScene(_scene, opts?): Promise<void>
Parameters
- _scene: Scene
- Optional opts: {
      camera?: Camera;
      cameraState?: CameraState;
      enableTransition?: boolean;
      exitBlurTime?: number;
      oldCamera?: Camera;
      oldScene?: Scene;
  }
  - Optional camera?: Camera
  - Optional cameraState?: CameraState
  - Optional enableTransition?: boolean
  - Optional exitBlurTime?: number
  - Optional oldCamera?: Camera
  - Optional oldScene?: Scene
Returns Promise<void>

addDefaultLights

addDefaultLights(scene?): void
Parameters
- Optional scene: Scene
Returns void

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.addDispose

addScene

addScene(scene?, camera?): Scene
Parameters
- Optional scene: Scene
- Optional camera: CameraOptions
Returns Scene

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from AppModuleBase.applyMixinsTo

clearScenes

clearScenes(): void
Returns void

destroy

destroy(): void
Destroy self.

Returns void
Inherited from AppModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from AppModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from AppModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from AppModuleBase.eventNames

getLoadedResources

getLoadedResources(): RosourceItemsReturnType
Returns RosourceItemsReturnType

getSceneStatData

getSceneStatData(): {
    objects: number;
    triangles: number;
    vertices: number;
}
Returns {
    objects: number;
    triangles: number;
    vertices: number;
}
- objects: number
- triangles: number
- vertices: number

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from AppModuleBase.hasEvent

initScene

initScene(scene, opts?): void
初始化场景对象
Parameters
- scene: Scene
- Optional opts: {
  defaultLights?: boolean;
  gridHelper?: GridHelperModuleOptions;
  }
  - Optional defaultLights?: boolean
  - Optional gridHelper?: GridHelperModuleOptions
Returns void

isAxesHelperVisible

isAxesHelperVisible(): boolean
Returns boolean

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from AppModuleBase.listenerCount

loadResources

loadResources(_resources, options?): Promise<RosourceItemsReturnType>
加载资源数组
Parameters
- _resources: ResourceItem[]
- Optional options: loadResourcesOptions
Returns Promise<RosourceItemsReturnType>

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from AppModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.on

onAwake

onAwake(): void
Returns void
Implementation of IAppModuleBase.onAwake

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.once

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from AppModuleBase.removeAllEventListeners

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.removeDispose

removeScene

removeScene(_scene): boolean
Parameters
- _scene: Scene
Returns boolean

setAxesHelperVisible

setAxesHelperVisible(visible?, size?): void
Parameters
- Optional visible: boolean
- Optional size: number
Returns void

setBackgroundEnvironment

setBackgroundEnvironment(options?): Promise<void>
Parameters
- Optional options: BackgroundEnvironmentOptions
Returns Promise<void>

setEnvConfig

setEnvConfig(key, value): void
Parameters
- key: string
- value: any
Returns void

setFocus

setFocus(): void
Returns void

setupUiConfig

setupUiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>

updateSceneMatixWorld

updateSceneMatixWorld(): void
Returns void