Class ParticleSystem

Particle system

Export

ParticleSystem

Date

2024.3.18

Author

yisky

Hierarchy

Renderer
- ParticleSystem

Index

Constructors

constructor

Properties

_awoken _bounds _boundsUpdateFlag _enabled _object3D _onAfterRender _onBeforeRender _renderOrder entity isRenderer queryMask useAutoRandomSeed userData

Constructors

constructor

new ParticleSystem(entity, options?): ParticleSystem
Parameters
- entity: Entity
- options: ParticleSystemOptions = {}
Returns ParticleSystem
Overrides Renderer.constructor

Properties

`Protected`_awoken

_awoken: boolean

`Protected`_bounds

_bounds: Box3

`Protected`_boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

`Protected`_enabled

_enabled: boolean

`Protected`_object3D

_object3D: Object3D<Object3DEventMap>

`Protected`_onAfterRender

_onAfterRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

`Protected`_onBeforeRender

_onBeforeRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

`Protected`_renderOrder

_renderOrder: RenderOrder

`Readonly`entity

entity: Entity

`Readonly`isRenderer

isRenderer: boolean

Renderer flag

Memberof

Renderer

queryMask

queryMask: QueryMask

Query mask

Memberof

Renderer

useAutoRandomSeed

useAutoRandomSeed: boolean = true

Controls whether the Particle System uses an automatically-generated random number to seed the random number generator.

Memberof

ParticleSystem

userData

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

Component user data

Memberof

Component

Accessors

collision

get collision(): CollisionModule
Get collision module.

Returns CollisionModule
Memberof
ParticleSystem

colorBySpeed

get colorBySpeed(): ColorBySpeedModule
Get color by speed module.

Returns ColorBySpeedModule
Memberof
ParticleSystem

colorOverLifetime

get colorOverLifetime(): ColorOverLifetimeModule
Get color over lifetime module.

Returns ColorOverLifetimeModule
Memberof
ParticleSystem

delayTime

get delayTime(): number
Get the emit delay time.

Returns number
Memberof
ParticleSystem

emission

get emission(): EmissionModule
Get emission module.

Returns EmissionModule
Memberof
ParticleSystem

enabled

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

Returns boolean
Memberof
Component

Inherited from Renderer.enabled
set enabled(value): void
Set whether the component is enabled.
Parameters
- value: boolean
Returns void
Memberof
Component

Inherited from Renderer.enabled

forceOverLifetime

get forceOverLifetime(): ForceOverLifetimeModule
Get force over lifetime module.

Returns ForceOverLifetimeModule
Memberof
ParticleSystem

inheritVelocity

get inheritVelocity(): InheritVelocityModule
Get inherit velocity module.

Returns InheritVelocityModule
Memberof
ParticleSystem

lastTime

get lastTime(): number
Get last playback position in seconds.

Returns number
Memberof
ParticleSystem

lights

get lights(): LightsModule
Get lights module.

Returns LightsModule
Memberof
ParticleSystem

limitVelocityOverLifetime

get limitVelocityOverLifetime(): LimitVelocityOverLifetimeModule
Get limit velocity over lifetime module.

Returns LimitVelocityOverLifetimeModule
Memberof
ParticleSystem

main

get main(): MainModule
Get main module.

Returns MainModule
Memberof
ParticleSystem

noise

get noise(): NoiseModule
Get noise module

Returns NoiseModule
Memberof
ParticleSystem

object3D

get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Get three.js native object3D

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

Inherited from Renderer.object3D

position

get position(): Vector3
Get local position

Returns Vector3
Memberof
Renderer

Inherited from Renderer.position
set position(position): void
Set local position
Parameters
- position: Vector3
Returns void
Memberof
Renderer

Inherited from Renderer.position

quaternion

get quaternion(): Quaternion
Get local quaternion

Returns Quaternion
Memberof
Renderer

Inherited from Renderer.quaternion
set quaternion(quaternion): void
Set local quaternion
Parameters
- quaternion: Quaternion
Returns void
Memberof
Renderer

Inherited from Renderer.quaternion

randomSeed

get randomSeed(): number
Get random seed

Returns number
Memberof
ParticleSystem

Remarks
If useAutoRandomSeed is true, this value will be random changed when play. If you set this value custom, useAutoRandomSeed will be false.
set randomSeed(value): void
Set random Seed.
Parameters
- value: number
Returns void
Memberof
ParticleSystem

renderer

get renderer(): ParticleRenderer
Get particle renderer.

Returns ParticleRenderer
Memberof
ParticleSystem

renderMode

get renderMode(): ParticleSystemRenderMode
Get render mode.

Returns ParticleSystemRenderMode
Memberof
ParticleSystem
set renderMode(value): void
Set render mode.
Parameters
- value: ParticleSystemRenderMode
Returns void
Memberof
ParticleSystem

renderOrder

get renderOrder(): RenderOrder
Get render order

Returns RenderOrder
Memberof
Renderer

Inherited from Renderer.renderOrder
set renderOrder(value): void
Set render order
Parameters
- value: RenderOrder
Returns void
Memberof
Renderer

Inherited from Renderer.renderOrder

rotation

get rotation(): Euler
Get local rotation

Returns Euler
Memberof
Renderer

Inherited from Renderer.rotation
set rotation(rotation): void
Set local rotation
Parameters
- rotation: Euler
Returns void
Memberof
Renderer

Inherited from Renderer.rotation

rotationBySpeed

get rotationBySpeed(): RotationBySpeedModule
Get rotation by speed module.

Returns RotationBySpeedModule
Memberof
ParticleSystem

rotationOverLifetime

get rotationOverLifetime(): RotationOverLifetimeModule
Get rotation over lifetime module.

Returns RotationOverLifetimeModule
Memberof
ParticleSystem

scale

get scale(): Vector3
Get local scale

Returns Vector3
Memberof
Renderer

Inherited from Renderer.scale
set scale(scale): void
Set local scale
Parameters
- scale: Vector3
Returns void
Memberof
Renderer

Inherited from Renderer.scale

scene

get scene(): Scene
Scene own the component

Returns Scene
Memberof
Component

Inherited from Renderer.scene

shape

get shape(): ShapeModule
Get shape module.

Returns ShapeModule
Memberof
ParticleSystem

sizeBySpeed

get sizeBySpeed(): SizeBySpeedModule
Get size by speed module.

Returns SizeBySpeedModule
Memberof
ParticleSystem

sizeOverLifetime

get sizeOverLifetime(): SizeOverLifetimeModule
Get size over lifetime module.

Returns SizeOverLifetimeModule
Memberof
ParticleSystem

subEmitters

get subEmitters(): SubEmittersModule
Get sub-emitters module.

Returns SubEmittersModule
Memberof
ParticleSystem

textureSheetAnimation

get textureSheetAnimation(): TextureSheetAnimationModule
Get texture sheet animation module.

Returns TextureSheetAnimationModule
Memberof
ParticleSystem

time

get time(): number
Get playback position in seconds.

Returns number
Memberof
ParticleSystem

totalTime

get totalTime(): number
Get total playback time in seconds, including the Start Delay setting.

Returns number
Memberof
ParticleSystem

velocityOverLifetime

get velocityOverLifetime(): VelocityOverLifetimeModule
Get velocity over lifetime module.

Returns VelocityOverLifetimeModule
Memberof
ParticleSystem

visible

set visible(value): void
Set whether visible
Parameters
- value: boolean
Returns void
Memberof
Renderer

Inherited from Renderer.visible

worldBounds

get worldBounds(): Readonly<Box3>
Get particle system world bounds

Returns Readonly<Box3>
Memberof
ParticleSystem

Overrides Renderer.worldBounds

Methods

`Protected`_attachToScene

_attachToScene(): void
Protected
Attach renderer to scene

Returns void
Memberof
Renderer

Inherited from Renderer._attachToScene

`Protected`_destroy

_destroy(): void
Protected
Destroy

Returns void
Memberof
ParticleSystem

Overrides Renderer._destroy

`Protected`_detachFromScene

_detachFromScene(): void
Protected
Detach renderer from scene

Returns void
Memberof
Renderer

Inherited from Renderer._detachFromScene

`Protected`_onAwake

_onAwake(): void
Protected
Awake component callback

Returns void
Memberof
Component

Inherited from Renderer._onAwake

`Protected`_onDestroy

_onDestroy(): void
Protected
Destroy callback

Returns void
Memberof
Renderer

Inherited from Renderer._onDestroy

`Protected`_onDisable

_onDisable(): void
Protected
Disable callback

Returns void
Memberof
Renderer

Inherited from Renderer._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
OnEnable

Returns void
Memberof
ParticleSystem

Overrides Renderer._onEnable

`Protected`_updateRenderOrder

_updateRenderOrder(): void
Protected
Update renderer component render order

Returns void
Memberof
Renderer

Inherited from Renderer._updateRenderOrder

`Protected`_updateWorldBounds

_updateWorldBounds(): void
Protected
Not support

Returns void
Memberof
ParticleSystem

Overrides Renderer._updateWorldBounds

`Protected`_updateWorldMatrix

_updateWorldMatrix(): void
Protected
Update renderer component world matrix

Returns void
Memberof
Renderer

Inherited from Renderer._updateWorldMatrix

addParticleModule

addParticleModule(module): void
Add a custom module.
Parameters
- module: ParticleModule
Returns void
Memberof
ParticleSystem

afterCameraRender

afterCameraRender(camera): void
After camera render
Parameters
- camera: Camera
Returns void
Memberof
Renderer

Inherited from Renderer.afterCameraRender

beforeCameraRender

beforeCameraRender(camera): void
Before camera render
Parameters
- camera: Camera
Returns void
Memberof
ParticleSystem

Overrides Renderer.beforeCameraRender

desrtoy

desrtoy(): void
Destroy component

Returns void
Memberof
Component

Inherited from Renderer.desrtoy

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

Inherited from Renderer.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from Renderer.emit

getWorldDirection

getWorldDirection(target): Vector3
Returns a vector representing the direction of transform's positive z-axis in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3.
Returns Vector3
Memberof
Renderer

Inherited from Renderer.getWorldDirection

getWorldPosition

getWorldPosition(target): Vector3
Returns a vector representing the position of the transforms in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3
Returns Vector3
Memberof
Renderer

Inherited from Renderer.getWorldPosition

getWorldQuaternion

getWorldQuaternion(target): Quaternion
Returns a quaternion representing the rotation of the transform in world space.
Parameters
- target: Quaternion
  The result will be copied into this Quaternion.
Returns Quaternion
Memberof
Renderer

Inherited from Renderer.getWorldQuaternion

getWorldScale

getWorldScale(target): Vector3
Returns a vector of the scaling factors applied to the transform for each axis in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3
Returns Vector3
Memberof
Renderer

Inherited from Renderer.getWorldScale

localToWorld

localToWorld(vector): Vector3
Converts the vector from this object's local space to world space.
Parameters
- vector: Vector3
  A vector representing a position in this object's local space.
Returns Vector3
Memberof
Renderer

Inherited from Renderer.localToWorld

lookAt

lookAt(target): void
Rotates the object to face a point in world space.
Parameters
- target: Vector3
  A vector representing a position in world space to look at.
Returns void
Memberof
Renderer

Inherited from Renderer.lookAt

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

Inherited from Renderer.off

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

Inherited from Renderer.on

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  }
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from Renderer.once

play

play(): void
Play

Returns void
Memberof
ParticleSystem

raycast

raycast(raycaster): Intersection<Object3D<Object3DEventMap>>
Raycast
Parameters
- raycaster: Raycaster
Returns Intersection<Object3D<Object3DEventMap>>
Memberof
ParticleSystem

Overrides Renderer.raycast

removeParticleModule

removeParticleModule(module): void
Remove a custom module.
Parameters
- module: ParticleModule
Returns void
Memberof
ParticleSystem

setTransformation

setTransformation(transformation): void
Set transformation
Parameters
- transformation: Transformation
Returns void
Memberof
ParticleSystem

Overrides Renderer.setTransformation

stop

stop(): void
Stop

Returns void
Memberof
ParticleSystem

toJSON

toJSON(): {
[key: string]: any;
}
Serialize

Returns {
[key: string]: any;
}
- [key: string]: any
Memberof
ParticleSystem

triggerSubEmitter

triggerSubEmitter(subEmitterIndex, particles?): void
Triggers the specified sub emitter on the specified particle(s) of the Particle System.
Parameters
- subEmitterIndex: number
- Optionalparticles: Particle[]
Returns void
Memberof
ParticleSystem

update

update(timeSinceLastFrame, totalTime): void
Update
Parameters
- timeSinceLastFrame: number
- totalTime: number
Returns void
Memberof
ParticleSystem

Overrides Renderer.update

updateWorldMatrix

updateWorldMatrix(): void
Update world matrix

Returns void
Memberof
Renderer

Inherited from Renderer.updateWorldMatrix

worldToLocal

worldToLocal(vector): Vector3
Converts the vector from world space to this object's local space.
Parameters
- vector: Vector3
  A vector representing a position in world space.
Returns Vector3
Memberof
Renderer

Inherited from Renderer.worldToLocal

Class ParticleSystem

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ParticleSystem

Properties

Protected_awoken

Protected_bounds

Protected_boundsUpdateFlag

Protected_enabled

Protected_object3D

Protected_onAfterRender

Protected_onBeforeRender

Protected_renderOrder

Readonlyentity

ReadonlyisRenderer

Memberof

queryMask

Memberof

useAutoRandomSeed

Memberof

userData

Memberof

Accessors

collision

Returns CollisionModule

Memberof

colorBySpeed

Returns ColorBySpeedModule

Memberof

colorOverLifetime

Returns ColorOverLifetimeModule

Memberof

delayTime

Returns number

Memberof

emission

Returns EmissionModule

Memberof

enabled

Returns boolean

Memberof

Parameters

Returns void

Memberof

forceOverLifetime

Returns ForceOverLifetimeModule

Memberof

inheritVelocity

Returns InheritVelocityModule

Memberof

lastTime

Returns number

Memberof

lights

Returns LightsModule

Memberof

limitVelocityOverLifetime

Returns LimitVelocityOverLifetimeModule

Memberof

main

Returns MainModule

Memberof

noise

Returns NoiseModule

Memberof

object3D

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

Memberof

position

Returns Vector3

`Protected`_awoken

`Protected`_bounds

`Protected`_boundsUpdateFlag

`Protected`_enabled

`Protected`_object3D

`Protected`_onAfterRender

`Protected`_onBeforeRender

`Protected`_renderOrder

`Readonly`entity

`Readonly`isRenderer