Class OrbitUpdater

Orbit updater plugin

Implements

IParticleUpdater

Index

Constructors

Methods

afterDraw beforeDraw drawOrbit init isEnabled loadOptions update

Constructors

constructor

new OrbitUpdater(
pluginManager: PluginManager,
container: OrbitContainer,
): OrbitUpdater
OrbitUpdater constructor
Parameters
- pluginManager: PluginManager
  The plugin manager
- container: OrbitContainer
  The container to handle
Returns OrbitUpdater
- Defined in updaters/orbit/src/OrbitUpdater.ts:37

Methods

afterDraw

afterDraw(particle: OrbitParticle): void
Draws the orbit after particle rendering
Parameters
- particle: OrbitParticle
  The particle to process
Returns void
Implementation of IParticleUpdater.afterDraw
- Defined in updaters/orbit/src/OrbitUpdater.ts:46

beforeDraw

beforeDraw(particle: OrbitParticle): void
Draws the orbit before particle rendering
Parameters
- particle: OrbitParticle
  The particle to process
Returns void
Implementation of IParticleUpdater.beforeDraw
- Defined in updaters/orbit/src/OrbitUpdater.ts:58

drawOrbit

drawOrbit(particle: OrbitParticle, type: OrbitType): void
Draws the orbit ellipse
Parameters
- particle: OrbitParticle
  The particle to process
- type: OrbitType
  The type
Returns void
- Defined in updaters/orbit/src/OrbitUpdater.ts:71

init

init(particle: OrbitParticle): void
Initializes the particle orbit
Parameters
- particle: OrbitParticle
  The particle to process
Returns void
Implementation of IParticleUpdater.init
- Defined in updaters/orbit/src/OrbitUpdater.ts:110

isEnabled

isEnabled(particle: OrbitParticle): boolean
Checks if orbit is enabled for the particle
Parameters
- particle: OrbitParticle
  The particle to process
Returns boolean
The boolean value
Implementation of IParticleUpdater.isEnabled
- Defined in updaters/orbit/src/OrbitUpdater.ts:137

loadOptions

loadOptions(
options: OrbitParticlesOptions,
...sources: (RecursivePartial<IOrbitParticlesOptions> | undefined)[],
): void
Loads the orbit options
Parameters
- options: OrbitParticlesOptions
  The options to handle
- ...sources: (RecursivePartial<IOrbitParticlesOptions> | undefined)[]
  The sources
Returns void
Implementation of IParticleUpdater.loadOptions
- Defined in updaters/orbit/src/OrbitUpdater.ts:148

update

update(particle: OrbitParticle, delta: IDelta): void
Updates the particle orbit rotation
Parameters
- particle: OrbitParticle
  The particle to process
- delta: IDelta
  The delta time
Returns void
Implementation of IParticleUpdater.update
- Defined in updaters/orbit/src/OrbitUpdater.ts:160