Class SpriteRenderer

Requires

THREE - { Mesh, BoxGeometry, MeshLambertMaterial, Sprite, SpriteMaterial }

Hierarchy (View Summary)

MeshRenderer
- SpriteRenderer

Index

Constructors

Properties

_body _materialPool _targetPool container system type

Methods

destroy? init isThreeSprite onParticleCreated onParticleDead onParticleUpdate onSystemUpdate remove rotate scale

Constructors

constructor

new SpriteRenderer(container: Object3D, THREE: __module): SpriteRenderer
Parameters
- container: Object3D
- THREE: __module
Returns SpriteRenderer
Overrides MeshRenderer.constructor
- Defined in src/renderer/SpriteRenderer.ts:14

Properties

_body

_body: Object3D

_materialPool

_materialPool: Pool

_targetPool

_targetPool: Pool

container

container: Object3D

system

system: System | null

type

type: string

Methods

`Optional` `Abstract`destroy

destroy?(): void
Tears down the renderer. Implemented by renderers that need cleanup (e.g. the GPURenderer).

Returns void
Inherited from MeshRenderer.destroy
- Defined in src/renderer/BaseRenderer.ts:87

init

init(system: System): void
Parameters
- system: System
Returns void
Inherited from MeshRenderer.init
- Defined in src/renderer/BaseRenderer.ts:23

isThreeSprite

isThreeSprite(particle: Particle): boolean
Parameters
- particle: Particle
Returns boolean
Inherited from MeshRenderer.isThreeSprite
- Defined in src/renderer/MeshRenderer.ts:44

`Abstract`onParticleCreated

onParticleCreated(particle: Particle): void
Parameters
- particle: Particle
Returns void
Inherited from MeshRenderer.onParticleCreated
- Defined in src/renderer/MeshRenderer.ts:50

`Abstract`onParticleDead

onParticleDead(particle: Particle): void
Parameters
- particle: Particle
Returns void
Inherited from MeshRenderer.onParticleDead
- Defined in src/renderer/MeshRenderer.ts:121

`Abstract`onParticleUpdate

onParticleUpdate(particle: Particle): void
Parameters
- particle: Particle
Returns void
Inherited from MeshRenderer.onParticleUpdate
- Defined in src/renderer/MeshRenderer.ts:77

`Abstract`onSystemUpdate

onSystemUpdate(): void
Returns void
Inherited from MeshRenderer.onSystemUpdate
- Defined in src/renderer/MeshRenderer.ts:48

remove

remove(_system?: System): void
Parameters
- Optional_system: System
Returns void
Inherited from MeshRenderer.remove
- Defined in src/renderer/BaseRenderer.ts:57

rotate

rotate(particle: Particle): void
Parameters
- particle: Particle
Returns void
Overrides MeshRenderer.rotate
- Defined in src/renderer/SpriteRenderer.ts:26

scale

scale(particle: Particle): void
Parameters
- particle: Particle
Returns void
Overrides MeshRenderer.scale
- Defined in src/renderer/SpriteRenderer.ts:32