Class ParticleRenderModule

粒子系统模块

Hierarchy (view full)

AppModuleBase
- ParticleRenderModule

Implements

IAppModuleBase

Constructors

constructor

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

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

batchRendererSet

batchRendererSet: Map<string, BatchedRenderer> = ...

data

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

Type declaration

[key: string]: any

`Optional` enable

enable?: boolean

extData

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

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

options

options: ParticleRenderModuleOptions

`Static` moduleName

moduleName: string = "ParticleRenderModule"

Accessors

app

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

batchRenderer

get batchRenderer(): BatchedRenderer
Returns BatchedRenderer

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

particleRenderer

get particleRenderer(): BatchedRenderer
Returns BatchedRenderer

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

addDispose

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

addParticle

addParticle(opts): ParticleEmitter<Object3DEventMap>
Parameters
- opts: {
      disposeWhenEnd?: boolean;
      name?: string;
      parent?: Object3D<Object3DEventMap>;
      position?: [number, number, number] | Vector3;
      rotation?: [number, number, number] | Vector3;
      scale?: number | [number, number, number] | Vector3;
      simulations?: Simulation | Simulation[];
      system: ParticleSystemParameters;
  }
  - Optional disposeWhenEnd?: boolean
  - Optional name?: string
  - Optional parent?: Object3D<Object3DEventMap>
  - Optional position?: [number, number, number] | Vector3
  - Optional rotation?: [number, number, number] | Vector3
  - Optional scale?: number | [number, number, number] | Vector3
  - Optional simulations?: Simulation | Simulation[]
  - system: ParticleSystemParameters
Returns ParticleEmitter<Object3DEventMap>

addParticleSystem

addParticleSystem(system, parent?, disposeWhenEnd?): void
Parameters
- system: IParticleSystem
- Optional parent: Object3D<Object3DEventMap>
- Optional disposeWhenEnd: boolean
Returns void

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

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

hasEvent

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

Inherited from AppModuleBase.hasEvent

listenerCount

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

Inherited from AppModuleBase.listenerCount

loadParticle

loadParticle(url, opts?): Promise<unknown>
Parameters
- url: string
- Optional opts: {
      crossOrigin?: string;
      disposeWhenEnd?: boolean;
      name?: string;
      onAddSystem?: ((object, system) => any);
      onData?: ((data) => any);
      parent?: Object3D<Object3DEventMap>;
      position?: [number, number, number] | Vector3;
      requestHeader?: {
          [header: string]: string;
      };
      resourcePath?: string;
      rotation?: [number, number, number] | Vector3;
      scale?: number | [number, number, number] | Vector3;
      simulations?: Simulation | Simulation[];
      system?: ParticleSystemParameters;
      urlPath?: string;
      withCredentials?: boolean;
  }
  - Optional crossOrigin?: string
  - Optional disposeWhenEnd?: boolean
  - Optional name?: string
  - Optional onAddSystem?: ((object, system) => any)
    - (object, system): any
      Parameters
      object: Object3D<Object3DEventMap>
      system: IParticleSystem
      Returns any
  - Optional onData?: ((data) => any)
    - (data): any
      Parameters
      data: any
      Returns any
  - Optional parent?: Object3D<Object3DEventMap>
  - Optional position?: [number, number, number] | Vector3
  - Optional requestHeader?: {
    [header: string]: string;
    }
    - [header: string]: string
  - Optional resourcePath?: string
  - Optional rotation?: [number, number, number] | Vector3
  - Optional scale?: number | [number, number, number] | Vector3
  - Optional simulations?: Simulation | Simulation[]
  - Optional system?: ParticleSystemParameters
  - Optional urlPath?: string
  - Optional withCredentials?: boolean
Returns Promise<unknown>

loadParticleFromRes

loadParticleFromRes(obj, opts?): Object3D<Object3DEventMap>
Parameters
- obj: Object3D<Object3DEventMap>
- Optional opts: {
      disposeWhenEnd?: boolean;
      name?: string;
      onAddSystem?: ((object, system) => any);
      parent?: Object3D<Object3DEventMap>;
      position?: [number, number, number] | Vector3;
      rotation?: [number, number, number] | Vector3;
      scale?: number | [number, number, number] | Vector3;
      simulations?: Simulation | Simulation[];
      system?: ParticleSystemParameters;
  }
  - Optional disposeWhenEnd?: boolean
  - Optional name?: string
  - Optional onAddSystem?: ((object, system) => any)
    - (object, system): any
      Parameters
      object: Object3D<Object3DEventMap>
      system: IParticleSystem
      Returns any
  - Optional parent?: Object3D<Object3DEventMap>
  - Optional position?: [number, number, number] | Vector3
  - Optional rotation?: [number, number, number] | Vector3
  - Optional scale?: number | [number, number, number] | Vector3
  - Optional simulations?: Simulation | Simulation[]
  - Optional system?: ParticleSystemParameters
Returns Object3D<Object3DEventMap>

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

onAppRender

onAppRender(time): void
Parameters
- time: Time
Returns void
Implementation of IAppModuleBase.onAppRender

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

removeParticle

removeParticle(obj): void
Parameters
- obj: ParticleEmitter<Object3DEventMap>
Returns void

setupUiConfig

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

Class ParticleRenderModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional app: App

Optional options: ParticleRenderModuleOptions

Returns ParticleRenderModule

Properties

Optional _app

Protected _destroyed

appRenderIndex

batchRendererSet

data

Type declaration

[key: string]: any

Optional enable

extData

Type declaration

[key: string]: any

Readonly instanceId

onSetApp

options

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

batchRenderer

Returns BatchedRenderer

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

particleRenderer

Returns BatchedRenderer

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

value: boolean

Returns void

addDispose

Parameters

cb: Function

Returns void

addParticle

Parameters

Optional disposeWhenEnd?: boolean

Optional name?: string

Optional parent?: Object3D<Object3DEventMap>

Optional position?: [number, number, number] | Vector3

Optional rotation?: [number, number, number] | Vector3

Optional scale?: number | [number, number, number] | Vector3

Optional simulations?: Simulation | Simulation[]

system: ParticleSystemParameters

Returns ParticleEmitter<Object3DEventMap>

addParticleSystem

Parameters

system: IParticleSystem

`Optional` app: App

`Optional` options: ParticleRenderModuleOptions

`Optional` _app

`Protected` _destroyed

`Optional` enable

`Readonly` instanceId

`Static` moduleName

`Optional` disposeWhenEnd?: boolean

`Optional` name?: string

`Optional` parent?: Object3D<Object3DEventMap>

`Optional` position?: [number, number, number] | Vector3

`Optional` rotation?: [number, number, number] | Vector3

`Optional` scale?: number | [number, number, number] | Vector3

`Optional` simulations?: Simulation | Simulation[]

`Optional` parent: Object3D<Object3DEventMap>

`Optional` disposeWhenEnd: boolean

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any

`Optional` crossOrigin?: string

`Optional` disposeWhenEnd?: boolean

`Optional` name?: string

`Optional` onAddSystem?: ((object, system) => any)

`Optional` onData?: ((data) => any)

`Optional` parent?: Object3D<Object3DEventMap>

`Optional` position?: [number, number, number] | Vector3

`Optional` requestHeader?: {
[header: string]: string;
}

`Optional` resourcePath?: string

`Optional` rotation?: [number, number, number] | Vector3

`Optional` scale?: number | [number, number, number] | Vector3

`Optional` simulations?: Simulation | Simulation[]

`Optional` system?: ParticleSystemParameters

`Optional` urlPath?: string

`Optional` withCredentials?: boolean

`Optional` disposeWhenEnd?: boolean

`Optional` name?: string

`Optional` onAddSystem?: ((object, system) => any)