Skip to content

Class: ParticleEmitterModule

Particle module of emit

Hierarchy

  • ParticleModuleBase

    ParticleEmitterModule

Constructors

Accessors

Methods

Constructors

constructor

new ParticleEmitterModule(): ParticleEmitterModule

Returns

ParticleEmitterModule

Inherited from

ParticleModuleBase.constructor

Accessors

shapeType

get shapeType(): ShapeType

Get shape type of emitter

Returns

ShapeType

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:82

set shapeType(v): void

Set shape type of emitter

Parameters

NameType
vShapeType

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:74


emitLocation

get emitLocation(): EmitLocation

Get emit location of emitter

Returns

EmitLocation

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:99

set emitLocation(v): void

Set emit location of emitter

Parameters

NameType
vEmitLocation

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:91


angle

get angle(): number

Get particle emitter angle

Returns

number

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:116

set angle(v): void

Set particle emitter angle When shapeType is cone, this value is the size of the cylindrical opening

Parameters

NameType
vnumber

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:109


radius

get radius(): number

Get particle emitter radus

Returns

number

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:133

set radius(v): void

Set particle emitter radus

Parameters

NameType
vnumber

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:125


boxSize

get boxSize(): Vector3

Get box size

Returns

Vector3

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:150

set boxSize(v): void

Set box size, only when the shape is box

Parameters

NameType
vVector3

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:142


randSeed

get randSeed(): number

Get random seed

Returns

number

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:167

set randSeed(v): void

Set random seed

Parameters

NameType
vnumber

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:159


maxParticle

get maxParticle(): number

Get max number of quad in this particle

Returns

number

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:187

set maxParticle(value): void

Set max number of quad in this particle

Parameters

NameType
valuenumber

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:176


emissionRate

get emissionRate(): number

Get emit rate.

Returns

number

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:204

set emissionRate(v): void

Set emit rate. How many quad are allowed to be emitted per second

Parameters

NameType
vnumber

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:196


duration

get duration(): number

Get duration of emitted particles

Returns

number

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:221

set duration(v): void

Set duration of emitted particles

Parameters

NameType
vnumber

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:213


startLifecycle

get startLifecycle(): MinMaxCurve

Get life cycle of each quad

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:238

set startLifecycle(v): void

Set life cycle of each quad

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:230


startVelocityX

get startVelocityX(): MinMaxCurve

Get velocity speed of X-axis component

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:255

set startVelocityX(value): void

Set velocity speed of X-axis component

Parameters

NameType
valueMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:247


startVelocityY

get startVelocityY(): MinMaxCurve

Get velocity speed of Y-axis component

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:270

set startVelocityY(value): void

Set velocity speed of Y-axis component

Parameters

NameType
valueMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:262


startVelocityZ

get startVelocityZ(): MinMaxCurve

Get velocity speed of Z-axis component

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:285

set startVelocityZ(value): void

Set velocity speed of Z-axis component

Parameters

NameType
valueMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:277


startScale

get startScale(): MinMaxCurve

Get init scale of each quad

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:302

set startScale(v): void

Set init scale of each quad

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:294


startScaleX

get startScaleX(): MinMaxCurve

Get the scaling value of each quad on the x-axis

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:317

set startScaleX(v): void

Set the scaling value of each quad on the x-axis

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:309


startScaleY

get startScaleY(): MinMaxCurve

Get the scaling value of each quad on the y-axis

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:332

set startScaleY(v): void

Set the scaling value of each quad on the y-axis

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:324


startScaleZ

get startScaleZ(): MinMaxCurve

Get the scaling value of each quad on the z-axis

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:347

set startScaleZ(v): void

Set the scaling value of each quad on the z-axis

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:339


startRotation

get startRotation(): MinMaxCurve

Get init rotation of each quad

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:372

set startRotation(v): void

Set init rotation of each quad

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:364


startRotationX

get startRotationX(): MinMaxCurve

Get the rotation of each quad on the x-axis

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:387

set startRotationX(v): void

Set the rotation of each quad on the x-axis

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:379


startRotationY

get startRotationY(): MinMaxCurve

Get the rotation of each quad on the y-axis

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:402

set startRotationY(v): void

Set the rotation of each quad on the y-axis

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:394


startRotationZ

get startRotationZ(): MinMaxCurve

Get the rotation of each quad on the z-axis

Returns

MinMaxCurve

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:417

set startRotationZ(v): void

Set the rotation of each quad on the z-axis

Parameters

NameType
vMinMaxCurve

Returns

void

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:409


needReset

get needReset(): boolean

Returns

boolean

Inherited from

ParticleModuleBase.needReset

Defined in

packages/particle/module/stand/ParticleModuleBase.ts:21

set needReset(v): void

Parameters

NameType
vboolean

Returns

void

Inherited from

ParticleModuleBase.needReset

Defined in

packages/particle/module/stand/ParticleModuleBase.ts:17

Methods

isUseStartScaleXYZ

isUseStartScaleXYZ(): boolean

Is the scaling of quads different on each axis

Returns

boolean

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:357


isUseStartRotationXYZ

isUseStartRotationXYZ(): boolean

Is the rotation of quads different on each axis

Returns

boolean

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:426


generateParticleModuleData

generateParticleModuleData(globalMemory, localMemory): void

Genarate particle emit module

Parameters

NameType
globalMemoryParticleGlobalMemory
localMemoryParticleLocalMemory

Returns

void

Overrides

ParticleModuleBase.generateParticleModuleData

Defined in

packages/particle/module/stand/ParticleEmitterModule.ts:443


setSimulator

setSimulator(simulator): void

Parameters

NameType
simulatorParticleSimulator

Returns

void

Inherited from

ParticleModuleBase.setSimulator

Defined in

packages/particle/module/stand/ParticleModuleBase.ts:25


calculateParticle

calculateParticle(globalMemory, localMemory): void

Parameters

NameType
globalMemoryParticleGlobalMemory
localMemoryParticleLocalMemory

Returns

void

Inherited from

ParticleModuleBase.calculateParticle

Defined in

packages/particle/module/stand/ParticleModuleBase.ts:29