Class PolygonMaskInstance

Polygon Mask manager

Implements

IContainerPlugin

Index

Constructors

Properties

dimension offset? paths? raw? redrawTimeout?

Methods

clickPositionValid draw init particleBounce particlePosition particlesInitialization resize stop

Constructors

constructor

new PolygonMaskInstance(
container: PolygonMaskContainer,
engine: Engine,
): PolygonMaskInstance
Parameters
- container: PolygonMaskContainer
- engine: Engine
Returns PolygonMaskInstance
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:47

Properties

dimension

dimension: IDimension

`Optional`offset

offset?: ICoordinates

`Optional`paths

paths?: ISvgPath[]

`Optional`raw

raw?: ICoordinates[]

`Optional`redrawTimeout

redrawTimeout?: number | Timeout

Methods

clickPositionValid

clickPositionValid(position: ICoordinates): boolean
Parameters
- position: ICoordinates
Returns boolean
Implementation of IContainerPlugin.clickPositionValid
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:58

draw

draw(context: CanvasRenderingContext2D): void
Parameters
- context: CanvasRenderingContext2D
Returns void
Implementation of IContainerPlugin.draw
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:69

init

init(): Promise<void>
Returns Promise<void>
Implementation of IContainerPlugin.init
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:99

particleBounce

particleBounce(
    particle: Particle,
    delta: IDelta,
    direction: OutModeDirection,
): boolean
Parameters
- particle: Particle
- delta: IDelta
- direction: OutModeDirection
Returns boolean
Implementation of IContainerPlugin.particleBounce
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:117

particlePosition

particlePosition(position?: ICoordinates): ICoordinates | undefined
Parameters
- Optionalposition: ICoordinates
Returns ICoordinates | undefined
Implementation of IContainerPlugin.particlePosition
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:121

particlesInitialization

particlesInitialization(): boolean
Returns boolean
Implementation of IContainerPlugin.particlesInitialization
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:132

resize

resize(): void
Returns void
Implementation of IContainerPlugin.resize
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:149

stop

stop(): void
Returns void
Implementation of IContainerPlugin.stop
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:172