Class Connector

Particle connection manager

Hierarchy

ExternalInteractorBase<ConnectContainer>
- Connector

Index

Constructors

Properties

Accessors

Methods

clear init interact isEnabled loadModeOptions reset

Constructors

constructor

new Connector(container: ConnectContainer): Connector
Parameters
- container: ConnectContainer
Returns Connector
Overrides ExternalInteractorBase<ConnectContainer>.constructor
- Defined in interactions/external/connect/src/Connector.ts:22

Properties

`Protected` `Readonly`container

container: ConnectContainer

type

type: InteractorType

Accessors

maxDistance

get maxDistance(): number
Returns number
Overrides ExternalInteractorBase.maxDistance
- Defined in interactions/external/connect/src/Connector.ts:28

Methods

clear

clear(): void
Returns void
Overrides ExternalInteractorBase.clear
- Defined in interactions/external/connect/src/Connector.ts:32

init

init(): void
Returns void
Overrides ExternalInteractorBase.init
- Defined in interactions/external/connect/src/Connector.ts:36

interact

interact(interactivityData: IInteractivityData): void
Connecting particles on hover interactivity
Parameters
- interactivityData: IInteractivityData
  The interactivity data
Returns void
Overrides ExternalInteractorBase.interact
- Defined in interactions/external/connect/src/Connector.ts:54

isEnabled

isEnabled(
interactivityData: IInteractivityData,
particle?: InteractivityParticle,
): boolean
Parameters
- interactivityData: IInteractivityData
- Optionalparticle: InteractivityParticle
Returns boolean
Overrides ExternalInteractorBase.isEnabled
- Defined in interactions/external/connect/src/Connector.ts:93

loadModeOptions

loadModeOptions(
options: Modes & ConnectMode,
...sources: RecursivePartial<IModes & IConnectMode | undefined>[],
): void
Parameters
- options: Modes & ConnectMode
- ...sources: RecursivePartial<IModes & IConnectMode | undefined>[]
Returns void
- Defined in interactions/external/connect/src/Connector.ts:105

reset

reset(): void
Returns void
Overrides ExternalInteractorBase.reset
- Defined in interactions/external/connect/src/Connector.ts:112