Class Body

Sets the body property on initialized particles.

Hierarchy

default
- Body

Index

Constructors

Properties

body h? isEnabled type w?

Methods

init initialize reset fromJSON requiresWebGlApi

Constructors

constructor

new Body(body: unknown, w?: number, h?: number, isEnabled?: boolean): Body
Constructs a Body initalizer instance.
Parameters
- body: unknown
  The content for the particle body, can be a color or an object (mesh)
- Optionalw: number
  The width of the particle body
- Optionalh: number
  The height of the particle body
- isEnabled: boolean = true
Returns Body
Overrides Initializer.constructor
- Defined in src/initializer/Body.ts:30

Properties

body

body: ArraySpan<unknown> | null

`Optional`h

h?: number

isEnabled

isEnabled: boolean

type

type: string

`Optional`w

w?: number

Methods

init

init(emitter: Emitter, particle?: Particle): void
Initializes the property on the emitter or particle.
Parameters
- emitter: Emitter
- Optionalparticle: Particle
Returns void
Inherited from Initializer.init
- Defined in src/initializer/Initializer.ts:25

initialize

initialize(particle: Particle): void
Sets the particle's initial body.
Parameters
- particle: Particle
  the particle to initialize the property on
Returns void
Overrides Initializer.initialize
- Defined in src/initializer/Body.ts:59

`Abstract`reset

reset(): void
Returns void
Inherited from Initializer.reset
- Defined in src/initializer/Initializer.ts:42

`Static`fromJSON

fromJSON(json: BodyJSON): Body
Creates a Body initializer from JSON.
Parameters
- json: BodyJSON
  The JSON to construct the instance from.
Returns Body
Overrides Initializer.fromJSON
- Defined in src/initializer/Body.ts:80

`Static`requiresWebGlApi

requiresWebGlApi(): boolean
Determines if the initializer requires a WebGL API to be provided to its constructor.

Returns boolean
Inherited from Initializer.requiresWebGlApi
- Defined in src/initializer/Initializer.ts:55