Class ParticlesInteractorBase<TContainer, TParticle>`Abstract`

Particles interactions manager, base abstract class

Type Parameters

TContainer extends Container = Container
TParticle extends Particle = Particle

Implements

IParticlesInteractor<TParticle>

Index

Constructors

Properties

Methods

clear init interact isEnabled reset

Constructors

`Protected`constructor

new ParticlesInteractorBase<TContainer, TParticle>(container): ParticlesInteractorBase<TContainer, TParticle>
Internal
The particles interactions manager constructor
Type Parameters
- TContainer extends Container = Container
- TParticle extends Particle = Particle
Parameters
- container: TContainer
  the parent container
Returns ParticlesInteractorBase<TContainer, TParticle>
- Defined in Core/Utils/ParticlesInteractorBase.ts:27

Properties

`Protected` `Readonly`container

container: TContainer

type

type: InteractorType = InteractorType.particles

Particles interactions type

Methods

`Abstract`clear

clear(particle, delta): void
Before interaction clear
Parameters
- particle: TParticle
  the particle to clear
- delta: IDelta
  this variable contains the delta between the current frame and the previous frame
Returns void
Implementation of IParticlesInteractor.clear
- Defined in Core/Utils/ParticlesInteractorBase.ts:36

`Abstract`init

init(): void
Initializes the interactivity manager

Returns void
Implementation of IParticlesInteractor.init
- Defined in Core/Utils/ParticlesInteractorBase.ts:41

`Abstract`interact

interact(particle, delta): void
Interaction handler
Parameters
- particle: TParticle
  the particle responsible for interactions
- delta: IDelta
  this variable contains the delta between the current frame and the previous frame
Returns void
Implementation of IParticlesInteractor.interact
- Defined in Core/Utils/ParticlesInteractorBase.ts:48

`Abstract`isEnabled

isEnabled(particle): boolean
Interaction enable check
Parameters
- particle: TParticle
  the particle responsible for interactions
Returns boolean
true or false, checking if the options enable this interaction manager
Implementation of IParticlesInteractor.isEnabled
- Defined in Core/Utils/ParticlesInteractorBase.ts:55

`Abstract`reset

reset(particle): void
Before interaction reset
Parameters
- particle: TParticle
  the particle to be reset
Returns void
Implementation of IParticlesInteractor.reset
- Defined in Core/Utils/ParticlesInteractorBase.ts:61