Class Parallaxer

Particle parallax manager

Hierarchy

ExternalInteractorBase<ParallaxContainer>
- Parallaxer

Index

Constructors

Properties

container maxDistance type

Methods

clear init interact isEnabled loadModeOptions reset

Constructors

constructor

new Parallaxer(container: ParallaxContainer): Parallaxer
Parameters
- container: ParallaxContainer
Returns Parallaxer
Overrides ExternalInteractorBase<ParallaxContainer>.constructor
- Defined in interactions/external/parallax/src/Parallaxer.ts:21

Properties

`Protected` `Readonly`container

container: ParallaxContainer

`Readonly`maxDistance

maxDistance: 0

type

type: InteractorType

Methods

clear

clear(): void
Returns void
Overrides ExternalInteractorBase.clear
- Defined in interactions/external/parallax/src/Parallaxer.ts:25

init

init(): void
Returns void
Overrides ExternalInteractorBase.init
- Defined in interactions/external/parallax/src/Parallaxer.ts:29

interact

interact(interactivityData: IInteractivityData): void
Parameters
- interactivityData: IInteractivityData
Returns void
Overrides ExternalInteractorBase.interact
- Defined in interactions/external/parallax/src/Parallaxer.ts:33

isEnabled

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

loadModeOptions

loadModeOptions(
options: Modes & ParallaxMode,
...sources: RecursivePartial<IModes & IParallaxMode | undefined>[],
): void
Parameters
- options: Modes & ParallaxMode
- ...sources: RecursivePartial<IModes & IParallaxMode | undefined>[]
Returns void
- Defined in interactions/external/parallax/src/Parallaxer.ts:47

reset

reset(): void
Returns void
Overrides ExternalInteractorBase.reset
- Defined in interactions/external/parallax/src/Parallaxer.ts:54