OrillusionClass: ParticleStandardSimulator
Standard particle simulator
Hierarchy
ParticleSimulator↳
ParticleStandardSimulator
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new ParticleStandardSimulator()
Overrides
ParticleSimulator.constructor
Defined in
packages/particle/simulator/ParticleStandardSimulator.ts:14
Properties
maxParticle
• maxParticle: number = 1000
Inherited from
ParticleSimulator.maxParticle
Defined in
packages/particle/simulator/ParticleSimulator.ts:20
needReset
• needReset: boolean = true
Inherited from
ParticleSimulator.needReset
Defined in
packages/particle/simulator/ParticleSimulator.ts:21
preheatTime
• preheatTime: number = 0.0
preheat time
Inherited from
ParticleSimulator.preheatTime
Defined in
packages/particle/simulator/ParticleSimulator.ts:26
particleLocalMemory
• particleLocalMemory: ParticleLocalMemory
particle data for each quad
Inherited from
ParticleSimulator.particleLocalMemory
Defined in
packages/particle/simulator/ParticleSimulator.ts:48
particleGlobalMemory
• particleGlobalMemory: ParticleGlobalMemory
global particle data for all quad
Inherited from
ParticleSimulator.particleGlobalMemory
Defined in
packages/particle/simulator/ParticleSimulator.ts:53
Accessors
simulatorSpace
• get simulatorSpace(): SimulatorSpace
Get particle simulator space.
Returns
Inherited from
ParticleSimulator.simulatorSpace
Defined in
packages/particle/simulator/ParticleSimulator.ts:41
• set simulatorSpace(v): void
Set particle simulator space. see SimulatorSpace
Parameters
| Name | Type |
|---|---|
v | SimulatorSpace |
Returns
void
Inherited from
ParticleSimulator.simulatorSpace
Defined in
packages/particle/simulator/ParticleSimulator.ts:33
looping
• get looping(): boolean
Get need to loop animation
Returns
boolean
Inherited from
ParticleSimulator.looping
Defined in
packages/particle/simulator/ParticleSimulator.ts:76
• set looping(value): void
Set need to loop animation
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
ParticleSimulator.looping
Defined in
packages/particle/simulator/ParticleSimulator.ts:68
maxActiveParticle
• get maxActiveParticle(): number
Get maximum number of active particles(read only)
Returns
number
Defined in
packages/particle/simulator/ParticleStandardSimulator.ts:22
Methods
addModule
▸ addModule<T>(c): T
add a particle module
Type parameters
| Name | Type |
|---|---|
T | extends ParticleModuleBase<T> |
Parameters
| Name | Type | Description |
|---|---|---|
c | Ctor<T> | class of particle module |
Returns
T
Inherited from
ParticleSimulator.addModule
Defined in
packages/particle/simulator/ParticleSimulator.ts:84
getModule
▸ getModule<T>(c): T
Get particle module
Type parameters
| Name | Type |
|---|---|
T | extends ParticleModuleBase<T> |
Parameters
| Name | Type | Description |
|---|---|---|
c | Ctor<T> | class of particle module |
Returns
T
Inherited from
ParticleSimulator.getModule
Defined in
packages/particle/simulator/ParticleSimulator.ts:99
removeModule
▸ removeModule<T>(c): void
Remove particle module
Type parameters
| Name | Type |
|---|---|
T | extends ParticleModuleBase<T> |
Parameters
| Name | Type | Description |
|---|---|---|
c | Ctor<T> | class of particle module |
Returns
void
Inherited from
ParticleSimulator.removeModule
Defined in
packages/particle/simulator/ParticleSimulator.ts:107
build
▸ build(): void
Returns
void
Inherited from
ParticleSimulator.build
Defined in
packages/particle/simulator/ParticleSimulator.ts:121
compute
▸ compute(command): void
Parameters
| Name | Type |
|---|---|
command | GPUCommandEncoder |
Returns
void
Inherited from
ParticleSimulator.compute
Defined in
packages/particle/simulator/ParticleSimulator.ts:140
updateBuffer
▸ updateBuffer(delta): void
Parameters
| Name | Type |
|---|---|
delta | number |
Returns
void
Inherited from
ParticleSimulator.updateBuffer
Defined in
packages/particle/simulator/ParticleSimulator.ts:146
debug
▸ debug(): void
Returns
void
Inherited from
ParticleSimulator.debug