Class PolygonMaskInstance

Polygon Mask manager

Implements

IContainerPlugin

Constructors

constructor

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

Properties

`Private` `Readonly` _checkInsidePolygon

_checkInsidePolygon: ((position?) => boolean) = ...

Type declaration

- (position?): boolean
- Parameters
  - Optional position: ICoordinates
  Returns boolean

`Private` `Readonly` _container

_container: PolygonMaskContainer

`Private` `Readonly` _createPath2D

_createPath2D: (() => void) = ...

Type declaration

- (): void
- Returns void

`Private` `Readonly` _downloadSvgPath

_downloadSvgPath: ((svgUrl?, force?) => Promise<undefined | ICoordinates[]>) = ...

Deprecate SVGPathElement.getPathSegAtLength removed in: Chrome for desktop release 62 Chrome for Android release 62 Android WebView release 62 Opera release 49 Opera for Android release 49

Type declaration

- (svgUrl?, force?): Promise<undefined | ICoordinates[]>
- Parameters
  - Optional svgUrl: string
  - Optional force: boolean
  Returns Promise<undefined | ICoordinates[]>

Returns

the coordinates of the polygon

`Private` `Readonly` _drawPoints

_drawPoints: (() => void) = ...

Type declaration

- (): void
- Returns void

`Private` `Readonly` _engine

_engine: Engine

`Private` `Readonly` _getEquidistantPointByIndex

_getEquidistantPointByIndex: ((index) => undefined | ICoordinates) = ...

Type declaration

- (index): undefined | ICoordinates
- Parameters
  - index: number
  Returns undefined | ICoordinates

`Private` `Readonly` _getPointByIndex

_getPointByIndex: ((index) => ICoordinates) = ...

Type declaration

- (index): ICoordinates
- Parameters
  - index: number
  Returns ICoordinates

`Private` `Readonly` _getRandomPoint

_getRandomPoint: (() => ICoordinates) = ...

Type declaration

- (): ICoordinates
- Returns ICoordinates

`Private` `Readonly` _getRandomPointByLength

_getRandomPointByLength: (() => undefined | ICoordinates) = ...

Type declaration

- (): undefined | ICoordinates
- Returns undefined | ICoordinates

`Private` _moveRadius

_moveRadius: number

`Private` `Readonly` _randomPoint

_randomPoint: (() => undefined | ICoordinates) = ...

Type declaration

- (): undefined | ICoordinates
- Returns undefined | ICoordinates

`Private` _scale

_scale: number

dimension

dimension: IDimension

`Optional` offset

offset?: ICoordinates

`Optional` paths

paths?: ISvgPath[]

`Optional` raw

raw?: ICoordinates[]

`Optional` redrawTimeout

redrawTimeout?: number

Methods

`Private` `Readonly` _initRawData

_initRawData(force?): Promise<void>
Parameters
- Optional force: boolean
Returns Promise<void>
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:414

`Private` `Readonly` _parseSvgPath

_parseSvgPath(xml, force?): undefined | ICoordinates[]
Parameters
- xml: string
- Optional force: boolean
Returns undefined | ICoordinates[]
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:449

`Private` `Readonly` _polygonBounce

_polygonBounce(particle, delta, direction): boolean
Parameters
- particle: Particle
- delta: IDelta
- direction: OutModeDirection
Returns boolean
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/PolygonMaskInstance.ts:507

clickPositionValid

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

draw

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

init

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

particleBounce

particleBounce(particle, delta, direction): 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:123

Class PolygonMaskInstance

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PolygonMaskInstance

Properties

Private Readonly _checkInsidePolygon

Type declaration

Parameters

Returns boolean

Private Readonly _container

Private Readonly _createPath2D

Type declaration

Returns void

Private Readonly _downloadSvgPath

Type declaration

Parameters

Returns Promise<undefined | ICoordinates[]>

Returns

Private Readonly _drawPoints

Type declaration

Returns void

Private Readonly _engine

Private Readonly _getEquidistantPointByIndex

Type declaration

Parameters

Returns undefined | ICoordinates

Private Readonly _getPointByIndex

Type declaration

Parameters

Returns ICoordinates

Private Readonly _getRandomPoint

Type declaration

Returns ICoordinates

Private Readonly _getRandomPointByLength

Type declaration

Returns undefined | ICoordinates

Private _moveRadius

Private Readonly _randomPoint

Type declaration

Returns undefined | ICoordinates

Private _scale

dimension

Optional offset

Optional paths

Optional raw

Optional redrawTimeout

Methods

Private Readonly _initRawData

Parameters

Returns Promise<void>

Private Readonly _parseSvgPath

Parameters

Returns undefined | ICoordinates[]

Private Readonly _polygonBounce

Parameters

Returns boolean

clickPositionValid

Parameters

Returns boolean

draw

Parameters

Returns void

init

Returns Promise<void>

particleBounce

Parameters

Returns boolean

particlePosition

Parameters

Returns undefined | ICoordinates

particlesInitialization

Returns boolean

resize

Returns void

`Private` `Readonly` _checkInsidePolygon

`Private` `Readonly` _container

`Private` `Readonly` _createPath2D

`Private` `Readonly` _downloadSvgPath

`Private` `Readonly` _drawPoints

`Private` `Readonly` _engine

`Private` `Readonly` _getEquidistantPointByIndex

`Private` `Readonly` _getPointByIndex

`Private` `Readonly` _getRandomPoint

`Private` `Readonly` _getRandomPointByLength

`Private` _moveRadius

`Private` `Readonly` _randomPoint

`Private` _scale

`Optional` offset

`Optional` paths

`Optional` raw

`Optional` redrawTimeout

`Private` `Readonly` _initRawData

`Private` `Readonly` _parseSvgPath

`Private` `Readonly` _polygonBounce