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(
pluginManager: PluginManager,
container: PolygonMaskContainer,
): PolygonMaskInstance
Creates a new PolygonMaskInstance
Parameters
- pluginManager: PluginManager
  the plugin manager
- container: PolygonMaskContainer
  the polygon mask container
Returns PolygonMaskInstance
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:62

Properties

dimension

dimension: IDimension

The polygon mask dimensions

`Optional`offset

offset?: ICoordinates

The polygon mask offset

`Optional`paths

paths?: ISvgPath[]

The parsed SVG paths

`Optional`raw

raw?: ICoordinates[]

The raw polygon coordinates

`Optional`redrawTimeout

redrawTimeout?: number

The redraw timeout handle

Methods

clickPositionValid

clickPositionValid(position: ICoordinates): boolean
Checks if a click position is valid inside the polygon
Parameters
- position: ICoordinates
  the click position
Returns boolean
true if the position is valid
Implementation of IContainerPlugin.clickPositionValid
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:78

draw

draw(context: CanvasContextType): void
Parameters
- context: CanvasContextType
Returns void
Inherit Doc
Implementation of IContainerPlugin.draw
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:90

init

init(): Promise<void>
Returns Promise<void>
Inherit Doc
Implementation of IContainerPlugin.init
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:121

particleBounce

particleBounce(
    particle: Particle,
    delta: IDelta,
    direction: OutModeDirection,
): boolean
Parameters
- particle: Particle
- delta: IDelta
- direction: OutModeDirection
Returns boolean
Inherit Doc
Implementation of IContainerPlugin.particleBounce
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:140

particlePosition

particlePosition(position?: ICoordinates): ICoordinates | undefined
Parameters
- Optionalposition: ICoordinates
Returns ICoordinates | undefined
Inherit Doc
Implementation of IContainerPlugin.particlePosition
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:145

particlesInitialization

particlesInitialization(): boolean
Returns boolean
Inherit Doc
Implementation of IContainerPlugin.particlesInitialization
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:157

resize

resize(): void
Returns void
Inherit Doc
Implementation of IContainerPlugin.resize
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:175

stop

stop(): void
Returns void
Inherit Doc
Implementation of IContainerPlugin.stop
- Defined in plugins/polygonMask/src/PolygonMaskInstance.ts:199