@orillusion/particle

---

Class: ParticleEmitterModule

Defined in: packages/particle/module/stand/ParticleEmitterModule.ts:69

Particle module of emit

Constructors

Constructor

new ParticleEmitterModule(): ParticleEmitterModule

Returns

ParticleEmitterModule

Inherited from

ParticleModuleBase.constructor

Accessors

shapeType

Get Signature

get shapeType(): ShapeType

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

Get shape type of emitter

Returns

ShapeType

Set Signature

set shapeType(v): void

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

Set shape type of emitter

Parameters

v

ShapeType

Returns

void

---

emitLocation

Get Signature

get emitLocation(): EmitLocation

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

Get emit location of emitter

Returns

EmitLocation

Set Signature

set emitLocation(v): void

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

Set emit location of emitter

Parameters

v

EmitLocation

Returns

void

---

angle

Get Signature

get angle(): number

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

Get particle emitter angle

Returns

number

Set Signature

set angle(v): void

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

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

Parameters

v

number

Returns

void

---

radius

Get Signature

get radius(): number

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

Get particle emitter radus

Returns

number

Set Signature

set radius(v): void

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

Set particle emitter radus

Parameters

v

number

Returns

void

---

boxSize

Get Signature

get boxSize(): Vector3

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

Get box size

Returns

Vector3

Set Signature

set boxSize(v): void

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

Set box size, only when the shape is box

Parameters

v

Vector3

Returns

void

---

randSeed

Get Signature

get randSeed(): number

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

Get random seed

Returns

number

Set Signature

set randSeed(v): void

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

Set random seed

Parameters

v

number

Returns

void

---

maxParticle

Get Signature

get maxParticle(): number

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

Get max number of quad in this particle

Returns

number

Set Signature

set maxParticle(value): void

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

Set max number of quad in this particle

Parameters

value

number

Returns

void

---

emissionRate

Get Signature

get emissionRate(): number

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

Get emit rate.

Returns

number

Set Signature

set emissionRate(v): void

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

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

Parameters

v

number

Returns

void

---

duration

Get Signature

get duration(): number

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

Get duration of emitted particles

Returns

number

Set Signature

set duration(v): void

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

Set duration of emitted particles

Parameters

v

number

Returns

void

---

startLifecycle

Get Signature

get startLifecycle(): MinMaxCurve

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

Get life cycle of each quad

Returns

MinMaxCurve

Set Signature

set startLifecycle(v): void

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

Set life cycle of each quad

Parameters

v

MinMaxCurve

Returns

void

---

startVelocityX

Get Signature

get startVelocityX(): MinMaxCurve

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

Get velocity speed of X-axis component

Returns

MinMaxCurve

Set Signature

set startVelocityX(value): void

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

Set velocity speed of X-axis component

Parameters

value

MinMaxCurve

Returns

void

---

startVelocityY

Get Signature

get startVelocityY(): MinMaxCurve

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

Get velocity speed of Y-axis component

Returns

MinMaxCurve

Set Signature

set startVelocityY(value): void

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

Set velocity speed of Y-axis component

Parameters

value

MinMaxCurve

Returns

void

---

startVelocityZ

Get Signature

get startVelocityZ(): MinMaxCurve

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

Get velocity speed of Z-axis component

Returns

MinMaxCurve

Set Signature

set startVelocityZ(value): void

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

Set velocity speed of Z-axis component

Parameters

value

MinMaxCurve

Returns

void

---

startScale

Get Signature

get startScale(): MinMaxCurve

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

Get init scale of each quad

Returns

MinMaxCurve

Set Signature

set startScale(v): void

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

Set init scale of each quad

Parameters

v

MinMaxCurve

Returns

void

---

startScaleX

Get Signature

get startScaleX(): MinMaxCurve

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

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

Returns

MinMaxCurve

Set Signature

set startScaleX(v): void

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

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

Parameters

v

MinMaxCurve

Returns

void

---

startScaleY

Get Signature

get startScaleY(): MinMaxCurve

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

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

Returns

MinMaxCurve

Set Signature

set startScaleY(v): void

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

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

Parameters

v

MinMaxCurve

Returns

void

---

startScaleZ

Get Signature

get startScaleZ(): MinMaxCurve

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

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

Returns

MinMaxCurve

Set Signature

set startScaleZ(v): void

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

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

Parameters

v

MinMaxCurve

Returns

void

---

startRotation

Get Signature

get startRotation(): MinMaxCurve

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

Get init rotation of each quad

Returns

MinMaxCurve

Set Signature

set startRotation(v): void

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

Set init rotation of each quad

Parameters

v

MinMaxCurve

Returns

void

---

startRotationX

Get Signature

get startRotationX(): MinMaxCurve

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

Get the rotation of each quad on the x-axis

Returns

MinMaxCurve

Set Signature

set startRotationX(v): void

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

Set the rotation of each quad on the x-axis

Parameters

v

MinMaxCurve

Returns

void

---

startRotationY

Get Signature

get startRotationY(): MinMaxCurve

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

Get the rotation of each quad on the y-axis

Returns

MinMaxCurve

Set Signature

set startRotationY(v): void

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

Set the rotation of each quad on the y-axis

Parameters

v

MinMaxCurve

Returns

void

---

startRotationZ

Get Signature

get startRotationZ(): MinMaxCurve

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

Get the rotation of each quad on the z-axis

Returns

MinMaxCurve

Set Signature

set startRotationZ(v): void

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

Set the rotation of each quad on the z-axis

Parameters

v

MinMaxCurve

Returns

void

---

needReset

Get Signature

get needReset(): boolean

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

Returns

boolean

Set Signature

set needReset(v): void

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

Parameters

v

boolean

Returns

void

Inherited from

ParticleTextureSheetModule.needReset

Methods

isUseStartScaleXYZ()

isUseStartScaleXYZ(): boolean

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

Is the scaling of quads different on each axis

Returns

boolean

---

isUseStartRotationXYZ()

isUseStartRotationXYZ(): boolean

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

Is the rotation of quads different on each axis

Returns

boolean

---

generateParticleModuleData()

generateParticleModuleData(globalMemory, localMemory): void

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

Genarate particle emit module

Parameters

globalMemory

ParticleGlobalMemory

localMemory

ParticleLocalMemory

Returns

void

Overrides

ParticleModuleBase.generateParticleModuleData

---

setSimulator()

setSimulator(simulator): void

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

Parameters

simulator

ParticleSimulator

Returns

void

Inherited from

ParticleModuleBase.setSimulator

---

calculateParticle()

calculateParticle(globalMemory, localMemory): void

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

Parameters

globalMemory

ParticleGlobalMemory

localMemory

ParticleLocalMemory

Returns

void

Inherited from

ParticleModuleBase.calculateParticle