Class ParticlesInteractorBase<TContainer>`Abstract`

Particles interactions manager, base abstract class

Type Parameters

TContainer extends Container = Container

Hierarchy

ParticlesInteractorBase

Implements

IParticlesInteractor

Index

Constructors

Properties

Methods

clear init interact isEnabled reset

Constructors

`Protected` constructor

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

Properties

`Protected` `Readonly` container

container: TContainer

the parent container

type

type: InteractorType = InteractorType.particles

Particles interactions type

Methods

`Abstract` clear

clear(particle, delta): void
Before interaction clear
Parameters
- particle: Particle
  
  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:30

`Abstract` init

init(): void
Initializes the interactivity manager

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

`Abstract` interact

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

`Abstract` isEnabled

isEnabled(particle): boolean
Interaction enable check
Parameters
- particle: Particle
  
  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:49

`Abstract` reset

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