Class ParticlesInteractorBase<TContainer, TParticle>`Abstract`

Particles interactions manager, base abstract class

Type Parameters

TContainer extends InteractivityContainer = InteractivityContainer
TParticle extends InteractivityParticle = InteractivityParticle

Implements

IParticlesInteractor<TParticle>

Index

Constructors

Properties

Methods

clear init interact isEnabled reset

Constructors

`Protected`constructor

new ParticlesInteractorBase<
    TContainer extends InteractivityContainer = InteractivityContainer,
    TParticle extends InteractivityParticle = InteractivityParticle,
>(
    container: TContainer,
): ParticlesInteractorBase<TContainer, TParticle>
Internal
The particles interactions manager constructor
Type Parameters
- TContainer extends InteractivityContainer = InteractivityContainer
- TParticle extends InteractivityParticle = InteractivityParticle
Parameters
- container: TContainer
  the parent container
Returns ParticlesInteractorBase<TContainer, TParticle>
- Defined in ParticlesInteractorBase.ts:26

Properties

`Protected` `Readonly`container

container: TContainer

type

type: InteractorType = InteractorType.particles

Particles interactions type

Methods

`Abstract`clear

clear(particle: TParticle, delta: IDelta): 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 ParticlesInteractorBase.ts:35

`Abstract`init

init(): void
Initializes the interactivity manager

Returns void
Implementation of IParticlesInteractor.init
- Defined in ParticlesInteractorBase.ts:40

`Abstract`interact

interact(
    particle: TParticle,
    interactivityData: IInteractivityData,
    delta: IDelta,
): void
Interaction handler
Parameters
- particle: TParticle
  the particle responsible for interactions
- interactivityData: IInteractivityData
  the interactivity data of the event, contains the position of the event, etc
- delta: IDelta
  this variable contains the delta between the current frame and the previous frame
Returns void
Implementation of IParticlesInteractor.interact
- Defined in ParticlesInteractorBase.ts:48

`Abstract`isEnabled

isEnabled(particle: TParticle, interactivityData: IInteractivityData): boolean
Interaction enable check
Parameters
- particle: TParticle
  the particle responsible for interactions
- interactivityData: IInteractivityData
  the interactivity data of the event, contains the position of the event, etc
Returns boolean
true or false, checking if the options enable this interaction manager
Implementation of IParticlesInteractor.isEnabled
- Defined in ParticlesInteractorBase.ts:56

`Abstract`reset

reset(interactivityData: IInteractivityData, particle: TParticle): void
Before interaction reset
Parameters
- interactivityData: IInteractivityData
  the interactivity data of the event, contains the position of the event, etc
- particle: TParticle
  the particle to be reset
Returns void
Implementation of IParticlesInteractor.reset
- Defined in ParticlesInteractorBase.ts:63