Class ParticleSystem

粒子系统组件

Export

Date

2022.4.8

Author

lyx

Hierarchy

  • Renderable
    • ParticleSystem

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder isRenderable queryMask userData

Accessors

bounds enabled engine entity object3D pool position quaternion renderOrder rotation scale visible worldPosition worldQuaternion worldScale

Methods

_destroy _onAwake _onDestroy _onDisable _onEnable _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener addRenderer destroy dispatchEvent dispose getRenderer localToWorld raycast recoverMaterial removeAllEventListeners removeAllRenderers removeEventListener removeEventListenerByEventId removeRenderer replaceMaterial setActive setClipping setHighlight setStencil setTransform toJSON updateProperties worldToLocal

Constructors

constructor

  • Parameters

    • entity: Entity
    • parameters: RenderableParameters = {}

    Returns ParticleSystem

Properties

Protected _bounds

_bounds: Box3

Protected _boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Protected _object3D

_object3D: Object3D<Object3DEventMap>

Protected _renderOrder

_renderOrder: RenderOrder

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

queryMask

queryMask: number

查询遮罩值

Memberof

Renderable

userData

userData: {
    [key: string]: any;
}

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

bounds

  • get bounds(): Readonly<Box3>

  • 获取外包范围

    Returns Readonly<Box3>

    Memberof

    ParticleSystem

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

object3D

  • get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

  • 获取渲染组件对应的Object3D（three.js）对象

    Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

    Memberof

    ParticleSystem

pool

  • get pool(): ParticlePool

  • 获取粒子缓冲池

    Returns ParticlePool

    Memberof

    ParticleSystem

position

  • get position(): Vector3

  • 获取本地位置

    Returns Vector3

    Memberof

    ParticleSystem

quaternion

  • get quaternion(): Quaternion

  • 获取本地旋转四元数

    Returns Quaternion

    Memberof

    ParticleSystem

renderOrder

  • get renderOrder(): RenderOrder

  • 获取渲染队列

    Returns RenderOrder

    Memberof

    ParticleSystem

rotation

  • get rotation(): Euler

  • 获取本地旋转角（单位：弧度）

    Returns Euler

    Memberof

    ParticleSystem

scale

  • get scale(): Vector3

  • 获取本地缩放

    Returns Vector3

    Memberof

    ParticleSystem

visible

  • get visible(): boolean

  • 获取粒子系统是否可见

    Returns boolean

    Memberof

    ParticleSystem

  • set visible(value): void

  • 设置粒子系统是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    ParticleSystem

worldPosition

  • get worldPosition(): Vector3

  • 获取世界位置

    Returns Vector3

    Memberof

    ParticleSystem

worldQuaternion

  • get worldQuaternion(): Quaternion

  • 获取世界旋转四元数

    Returns Quaternion

    Memberof

    ParticleSystem

worldScale

  • get worldScale(): Vector3

  • 获取世界缩放

    Returns Vector3

    Memberof

    ParticleSystem

Methods

Protected _destroy

  • _destroy(): void
  • Protected

    销毁粒子系统

    Returns void

    Memberof

    ParticleSystem

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁渲染组件

    Returns void

    Memberof

    Renderable

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用粒子系统组件

    Returns void

    Memberof

    ParticleSystem

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用粒子系统组件

    Returns void

    Memberof

    ParticleSystem

Protected _updateBounds

  • _updateBounds(): void
  • Protected

    更新粒子系统外包盒

    Returns void

    Memberof

    ParticleSystem

Protected _updateMatrixWorld

  • _updateMatrixWorld(): void
  • Protected

    更新粒子系统世界矩阵

    Returns void

    Memberof

    ParticleSystem

Protected _updateRenderOrder

  • _updateRenderOrder(): void
  • Protected

    更新渲染顺序

    Returns void

    Memberof

    ParticleSystem

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

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

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      }

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

addRenderer

  • 添加一个粒子渲染器

    Parameters

    Returns void

    Memberof

    ParticleSystem

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

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

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

getRenderer

localToWorld

  • 本地坐标转世界坐标

    Parameters

    • vector: number[] | Vector3

    Returns Vector3

    Memberof

    ParticleSystem

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    ParticleSystem

recoverMaterial

  • 恢复材质

    Returns void

    Memberof

    Renderable

removeAllEventListeners

  • 移除所有事件监听器

    Returns void

    Memberof

    EventDispatcher

removeAllRenderers

  • 移除所有粒子渲染器

    Parameters

    • Optional destroy: boolean = true

      是否销毁粒子渲染器

    Returns void

    Memberof

    ParticleSystem

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

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

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

removeRenderer

  • 移除一个粒子渲染器

    Parameters

    • renderer: ParticleRenderer

      粒子渲染器

    • Optional destroy: boolean = true

      是否销毁粒子渲染器

    Returns void

    Memberof

    ParticleSystem

replaceMaterial

  • 替换材质

    Parameters

    • material: any

      材质对象

    Returns void

    Memberof

    Renderable

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setClipping

  • 设置裁剪

    Parameters

    • Optional parameters: ClippingParameters

      裁剪参数

    Returns void

    Memberof

    Renderable

setHighlight

  • 设置是否高亮

    Parameters

    • highlight: boolean

      是否高亮

    • Optional parameters: HighlightParameters

      高亮参数

    Returns void

    Memberof

    Renderable

setStencil

  • 设置模板参数

    Parameters

    • Optional parameters: StencilParameters

      模板参数

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    • transformation: Transformation

    Returns void

    Memberof

    ParticleSystem

toJSON

  • 属性转JSON

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

    Memberof

    ParticleSystem

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

worldToLocal

  • 世界坐标转本地坐标

    Parameters

    • vector: number[] | Vector3

    Returns Vector3

    Memberof

    ParticleSystem

Settings

Member Visibility

Theme

On This Page