Class ArrowPing

A type of ping that produces an arrow pointing in a given direction.

Hierarchy (View Summary)

PulsePing
- ArrowPing

Index

Constructors

Properties

Methods

_animateFrame _drawShape animate destroy

Constructors

constructor

new ArrowPing(
origin: Point,
options?: PingOptions & _PulsePingOptions & { rotation?: number },
): ArrowPing
Parameters
- origin: Point
  The canvas coordinates of the origin of the ping. This becomes the arrow's tip.
- Optionaloptions: PingOptions & _PulsePingOptions & { rotation?: number } = {}
  Additional options to configure the ping animation.
Returns ArrowPing
Overrides PulsePing.constructor

Properties

`Protected`_color

_color: Color

The color of the ping.

Methods

_animateFrame

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

_drawShape

_drawShape(g: any, color: any, alpha: any, size: any): void
Draw the shape for this ping.
Parameters
- g: any
  The graphics object to draw to.
- color: any
  The color of the shape.
- alpha: any
  The alpha of the shape.
- size: any
  The size of the shape to draw.
Returns void
Overrides PulsePing._drawShape

animate

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

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

Inherited from PulsePing.animate

destroy

destroy(options?: {}): void
Parameters
- options: {} = {}
Returns void
Inherit Doc
Inherited from PulsePing.destroy