Class SpiralPathGenerator

Spiral path generator plugin

Implements

IMovePathGenerator

Index

Constructors

Properties

Methods

generate init reset update

Constructors

constructor

new SpiralPathGenerator(container: Container): SpiralPathGenerator
SpiralPathGenerator constructor
Parameters
- container: Container
Returns SpiralPathGenerator
- Defined in paths/spiral/src/SpiralPathGenerator.ts:37

Properties

`Readonly`options

options: ISpiralOptions

Spiral path options

Methods

generate

generate(particle: SpiralParticle, delta: IDelta): Vector
Generates the next movement vector with spiral oscillation
Parameters
- particle: SpiralParticle
- delta: IDelta
Returns Vector
Implementation of IMovePathGenerator.generate
- Defined in paths/spiral/src/SpiralPathGenerator.ts:48

init

init(): void
Initializes the path generator options

Returns void
Implementation of IMovePathGenerator.init
- Defined in paths/spiral/src/SpiralPathGenerator.ts:91

reset

reset(particle: SpiralParticle): void
Resets the particle spiral state
Parameters
- particle: SpiralParticle
Returns void
Implementation of IMovePathGenerator.reset
- Defined in paths/spiral/src/SpiralPathGenerator.ts:103

update

update(): void
Updates the path generator (no-op)

Returns void
Implementation of IMovePathGenerator.update
- Defined in paths/spiral/src/SpiralPathGenerator.ts:108