Class Ping

A class to manage a user ping on the canvas.

Param: origin

The canvas coordinates of the origin of the ping.

Param: options

Additional options to configure the ping animation.

Hierarchy (view full)

any
- Ping
  - ChevronPing
  - PulsePing

Index

Methods

destroy animate _animateFrame

Methods

destroy

destroy(options?): void
Parameters
- options: {} = {}
Returns void
Inherit Doc

animate

animate(): Promise<boolean>
Start the ping animation.

Returns Promise<boolean>
Returns true if the animation ran to completion, false otherwise.

`Protected` _animateFrame

_animateFrame(dt, animation): void
Protected
On each tick, advance the animation.
Parameters
- dt: number
  The number of ms that elapsed since the previous frame.
- animation: CanvasAnimationData
  The animation state.
Returns void