Class ExternalInteractorBase<TContainer, TParticle>`Abstract`

External Interactivity manager, base abstract class

Type Parameters

TContainer extends InteractivityContainer = InteractivityContainer
TParticle extends InteractivityParticle = InteractivityParticle

Implements

IExternalInteractor<TParticle>

Index

Constructors

Properties

container maxDistance type

Methods

clear init interact isEnabled reset

Constructors

`Protected`constructor

new ExternalInteractorBase<
    TContainer extends InteractivityContainer = InteractivityContainer,
    TParticle extends InteractivityParticle = InteractivityParticle,
>(
    container: TContainer,
): ExternalInteractorBase<TContainer, TParticle>
Internal
Constructor of external interactivity manager
Type Parameters
- TContainer extends InteractivityContainer = InteractivityContainer
- TParticle extends InteractivityParticle = InteractivityParticle
Parameters
- container: TContainer
  the parent container
Returns ExternalInteractorBase<TContainer, TParticle>
- Defined in BaseClasses/ExternalInteractorBase.ts:28

Properties

`Protected` `Readonly`container

container: TContainer

`Abstract`maxDistance

maxDistance: number

The maximum distance for this interactor

type

type: InteractorType = InteractorType.external

External Interactivity 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 IExternalInteractor.clear
- Defined in BaseClasses/ExternalInteractorBase.ts:37

`Abstract`init

init(): void
Initializes the interactivity manager

Returns void
Implementation of IExternalInteractor.init
- Defined in BaseClasses/ExternalInteractorBase.ts:42

`Abstract`interact

interact(interactivityData: IInteractivityData, delta: IDelta): void
Interaction handler
Parameters
- 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 IExternalInteractor.interact
- Defined in BaseClasses/ExternalInteractorBase.ts:49

`Abstract`isEnabled

isEnabled(interactivityData: IInteractivityData, particle?: TParticle): boolean
Interaction enabled check
Parameters
- interactivityData: IInteractivityData
  the interactivity data of the event, contains the position of the event, etc
- Optionalparticle: TParticle
  the particle to check, if null, checks the container
Returns boolean
true or false, checking if the options enable this interaction manager
Implementation of IExternalInteractor.isEnabled
- Defined in BaseClasses/ExternalInteractorBase.ts:57

`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 reset
Returns void
Implementation of IExternalInteractor.reset
- Defined in BaseClasses/ExternalInteractorBase.ts:64