import Particles from 'oxygen-core/components/Particles.js'

public class | source

Particles

Extends:

Component → VerticesRenderer → Particles

Particles renderer.

Example:

const component = new Particles();
component.deserialize({ shader: 'shaders/particles.json', processor: 'particles/fire.ps' });

Static Member Summary

Static Public Members
public static get	propsTypes: *

Static Method Summary

Static Public Methods
public static	factory(): Particles Component factory.
public static	registerProcessor(id: string, contents: string) Register new particles processor.
public static	unregisterProcessor(id: string) Unregister existing processor.

Constructor Summary

Public Constructor
public	constructor() Constructor.

Member Summary

Public Members
public get	activeCount: number
public get	burstGenerator: Function \| null
public set	burstGenerator: Function \| null
public get	capacity: number
public set	capacity: number
public get	constantBurst: boolean
public set	constantBurst: boolean
public get	constantBurstCount: number
public set	constantBurstCount: number
public get	constantBurstDelay: number
public set	constantBurstDelay: number
public	indices: *
public get	overrideParams: *
public set	overrideParams: *
public get	processor: string \| null
public set	processor: string \| null
public	verticesUsage: *

Method Summary

Public Methods
public	dispose()
public	emitBurst(count: number, args: *) Emit burst of particles using burst generator function.
public	emitParticle(life: number, timeScale: number, size: number, args: *): boolean Emit single particle.
public	onAction(name: , args: ...): *
public	onUpdate(deltaTime: *)
public	setParam(id: string, value: number) Set particles parameter.

Inherited Summary

From class Component
public static get	propsTypes: *
public static	factory(): Component Component factory.
public get	entity: Entity \| null
public	[name]: *
public	deserialize(json: *) Deserialize JSON properties into this component.
public	dispose() Destructor (dispose internal resources and detach from entity).
public	onAction(name: string, args: *) Called when action arrived.
public	onAlterActionArguments(name: string, args: *): array \| undefined Called when asked to alter arrived action parameters.
public	onAttach() Called after attached to entity.
public	onDetach() Called before detached from entity.
public	onPropertySerialize(name: string, value: ): Called when property is serialized.
public	onPropertySetup(name: string, value: *) Called when given property is deserialized.
public	serialize(): * Serialize component into JSON data.

From class VerticesRenderer
public static get	BufferUsage: *
public static get	RenderMode: *
public static get	propsTypes: {"visible": string, "shader": string, "vertices": string, "indices": string, "verticesUsage": string, "indicesUsage": string, "overrideUniforms": string, "overrideSamplers": string, "renderMode": string, "layers": string}
public static	factory(): *
public get	indices: *
public set	indices
public get	indicesUsage: *
public set	indicesUsage
public get	layers: undefined[]
public set	layers
public get	overrideSamplers: *
public set	overrideSamplers
public get	overrideUniforms: *
public set	overrideUniforms
public get	renderMode: *
public set	renderMode
public get	shader: *
public set	shader
public get	vertices: *
public set	vertices
public get	verticesUsage: *
public set	verticesUsage
public get	visible: *
public set	visible
public	dispose()
public	onAction(name: , args: ...): *
public	onPreview(gl: , renderer: , deltaTime: *)
public	onPropertySerialize(name: , value: ): *
public	onRender(gl: , renderer: , deltaTime: , layer: )
public	onRenderLayer(gl: , renderer: , deltaTime: , layer: )
public	reuploadData()
public	updateIndicesChunk(data: , offset: , size: number)
public	updateVerticesChunk(data: , offset: , size: number)

Static Public Members

public static get propsTypes: * source

Override:

VerticesRenderer#propsTypes

Static Public Methods

public static factory(): Particles source

Component factory.

Override:

VerticesRenderer#factory

Return:

Particles

Component instance.

public static registerProcessor(id: string, contents: string) source

Params:

Name	Type	Attribute	Description
id	string		Processor id.
contents	string		Processor code.

Example:

const code = 'attribute x: 0;\nattribute y: 1;\nprogram:\ny -= deltaTime * life;';
Particles.registerProcessor('fire', code);

public static unregisterProcessor(id: string) source

Unregister existing processor.

Params:

Name	Type	Attribute	Description
id	string		processor id

Example:

Particles.unregisterProcessor('fire');

Public Constructors

public constructor() source

Constructor.

Override:

VerticesRenderer#constructor

Public Members

public get activeCount: number source

public get burstGenerator: Function | null source

public set burstGenerator: Function | null source

public get capacity: number source

public set capacity: number source

public get constantBurst: boolean source

public set constantBurst: boolean source

public get constantBurstCount: number source

public set constantBurstCount: number source

public get constantBurstDelay: number source

public set constantBurstDelay: number source

public indices: * source

Override:

VerticesRenderer#indices

public get overrideParams: * source

public set overrideParams: * source

public get processor: string | null source

public set processor: string | null source

public verticesUsage: * source

Override:

VerticesRenderer#verticesUsage

Public Methods

public dispose() source

Destructor (dispose internal resources and detach from entity).

Override:

VerticesRenderer#dispose

public emitBurst(count: number, args: *) source

Emit burst of particles using burst generator function.

Params:

Name	Type	Attribute	Description
count	number		Number of particles to emit.
args	*		Particles attributes.

Example:

component.emitBurst(100);

public emitParticle(life: number, timeScale: number, size: number, args: *): boolean source

Emit single particle.

Params:

Name	Type	Attribute	Description
life	number		Initial life value.
timeScale	number		Particle life-cycle time scale.
size	number		Particle size.
args	*		Particle attributes.

Return:

boolean

True if emitted, false otherwise.

Example:

component.emitParticle(1, 0.5, 10);

public onAction(name: , args: ...): * source

Called when action arrived.

Override:

VerticesRenderer#onAction

Params:

Name	Type	Attribute	Description
name	*
args	...*

Return:

public onUpdate(deltaTime: *) source

Params:

Name	Type	Attribute	Description
deltaTime	*

public setParam(id: string, value: number) source

Set particles parameter.

Params:

Name	Type	Attribute	Description
id	string		Parameter id.
value	number		Parameter value.

Example:

component.setParam('alpha', 0.5);

Particles

Extends:

Example:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Members

public static get propsTypes: * source

Override:

Static Public Methods

public static factory(): Particles source

Override:

Return:

public static registerProcessor(id: string, contents: string) source

Params:

Example:

public static unregisterProcessor(id: string) source

Params:

Example:

Public Constructors

public constructor() source

Override:

Public Members

public get activeCount: number source

public get burstGenerator: Function | null source

public set burstGenerator: Function | null source

public get capacity: number source

public set capacity: number source

public get constantBurst: boolean source

public set constantBurst: boolean source

public get constantBurstCount: number source

public set constantBurstCount: number source

public get constantBurstDelay: number source

public set constantBurstDelay: number source

public indices: * source

Override:

public get overrideParams: * source

public set overrideParams: * source

public get processor: string | null source

public set processor: string | null source

public verticesUsage: * source

Override:

Public Methods

public dispose() source

Override:

public emitBurst(count: number, args: *) source

Params:

Example:

public emitParticle(life: number, timeScale: number, size: number, args: *): boolean source

Params:

Return:

Example:

public onAction(name: *, args: ...*): * source

Override:

Params:

Return:

public onUpdate(deltaTime: *) source

Params:

public setParam(id: string, value: number) source

Params:

Example:

public onAction(name: , args: ...): * source