Class BodySprite

Sets the body property to be a THREE.Sprite on initialized particles.

NOTE The texture map MUST be set on the SpriteMaterial in the TextureLoader.load callback. Not doing so will cause WebGL buffer errors.

Hierarchy

default
- BodySprite

Index

Constructors

Properties

isEnabled material materialProperties sprite texture type

Methods

init initialize reset fromJSON requiresWebGlApi

Constructors

constructor

new BodySprite(
    THREE: __module,
    texture?: string,
    materialProperties?: Record<string, unknown>,
    isEnabled?: boolean,
): BodySprite
Constructs a BodySprite initializer.
Parameters
- THREE: __module
  The Web GL API we are using eg., THREE
- Optionaltexture: string
  The sprite texture
- materialProperties: Record<string, unknown> = DEFAULT_MATERIAL_PROPERTIES
  The sprite material properties
- isEnabled: boolean = true
Returns BodySprite

Throws
If the TextureLoader fails to load the supplied texture
Overrides Initializer.constructor
- Defined in src/initializer/BodySprite.ts:39

Properties

isEnabled

isEnabled: boolean

material

material: SpriteMaterial

materialProperties

materialProperties: Record<string, unknown>

sprite

sprite: Sprite

texture

texture: Texture

type

type: string

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 body to the sprite.
Parameters
- particle: Particle
  The particle to set the body of
Returns void
Overrides Initializer.initialize
- Defined in src/initializer/BodySprite.ts:94

`Abstract`reset

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

`Static`fromJSON

fromJSON(json: BodySpriteJSON, THREE: __module): BodySprite
Creates a BodySprite initializer from JSON.
Parameters
- json: BodySpriteJSON
  The JSON to construct the instance from
- THREE: __module
  The Web GL API we are using eg., THREE
Returns BodySprite
Overrides Initializer.fromJSON
- Defined in src/initializer/BodySprite.ts:104

`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