@orillusion/particle

---

Class: ParticleStandardSimulator

Defined in: packages/particle/simulator/ParticleStandardSimulator.ts:10

Standard particle simulator

Constructors

Constructor

new ParticleStandardSimulator(): ParticleStandardSimulator

Defined in: packages/particle/simulator/ParticleStandardSimulator.ts:14

Returns

ParticleStandardSimulator

Overrides

ParticleSimulator.constructor

Properties

maxParticle

maxParticle: number = 1000

Defined in: packages/particle/simulator/ParticleSimulator.ts:20

Inherited from

ParticleSimulator.maxParticle

---

needReset

needReset: boolean = true

Defined in: packages/particle/simulator/ParticleSimulator.ts:21

Inherited from

ParticleSimulator.needReset

---

preheatTime

preheatTime: number = 0.0

Defined in: packages/particle/simulator/ParticleSimulator.ts:26

preheat time

Inherited from

ParticleSimulator.preheatTime

---

particleLocalMemory

particleLocalMemory: ParticleLocalMemory

Defined in: packages/particle/simulator/ParticleSimulator.ts:48

particle data for each quad

Inherited from

ParticleSimulator.particleLocalMemory

---

particleGlobalMemory

particleGlobalMemory: ParticleGlobalMemory

Defined in: packages/particle/simulator/ParticleSimulator.ts:53

global particle data for all quad

Inherited from

ParticleSimulator.particleGlobalMemory

Accessors

simulatorSpace

Get Signature

get simulatorSpace(): SimulatorSpace

Defined in: packages/particle/simulator/ParticleSimulator.ts:41

Get particle simulator space.

Returns

SimulatorSpace

Set Signature

set simulatorSpace(v): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:33

Set particle simulator space. see SimulatorSpace

Parameters

v

SimulatorSpace

Returns

void

Inherited from

ParticleSimulator.simulatorSpace

---

looping

Get Signature

get looping(): boolean

Defined in: packages/particle/simulator/ParticleSimulator.ts:76

Get need to loop animation

Returns

boolean

Set Signature

set looping(value): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:68

Set need to loop animation

Parameters

value

boolean

Returns

void

Inherited from

ParticleSimulator.looping

---

maxActiveParticle

Get Signature

get maxActiveParticle(): number

Defined in: packages/particle/simulator/ParticleStandardSimulator.ts:22

Get maximum number of active particles(read only)

Returns

number

Methods

addModule()

addModule<T>(c): T

Defined in: packages/particle/simulator/ParticleSimulator.ts:84

add a particle module

Type Parameters

T

T extends ParticleModuleBase

Parameters

c

Ctor<T>

class of particle module

Returns

T

Inherited from

ParticleSimulator.addModule

---

getModule()

getModule<T>(c): T

Defined in: packages/particle/simulator/ParticleSimulator.ts:99

Get particle module

Type Parameters

T

T extends ParticleModuleBase

Parameters

c

Ctor<T>

class of particle module

Returns

T

Inherited from

ParticleSimulator.getModule

---

removeModule()

removeModule<T>(c): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:107

Remove particle module

Type Parameters

T

T extends ParticleModuleBase

Parameters

c

Ctor<T>

class of particle module

Returns

void

Inherited from

ParticleSimulator.removeModule

---

build()

build(): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:121

Returns

void

Inherited from

ParticleSimulator.build

---

compute()

compute(view, command): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:140

Parameters

view

View3D

command

GPUCommandEncoder

Returns

void

Inherited from

ParticleSimulator.compute

---

updateBuffer()

updateBuffer(delta): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:146

Parameters

delta

number

Returns

void

Inherited from

ParticleSimulator.updateBuffer

---

debug()

debug(): void

Defined in: packages/particle/simulator/ParticleSimulator.ts:173

Returns

void

Inherited from

ParticleSimulator.debug