Class MouseMapper

The MouseMapper will map the current position of the mouse to corresponding locations on the canvas.

Constructors

constructor

Accessors

mouseX mouseXRatio mouseY mouseYRatio

Methods

mapMouseXToCanvas mapMouseXToRatio mapMouseYToCanvas mapMouseYToRatio

Constructors

constructor

Accessors

StaticmouseX

  • get mouseX(): number

  • The current mouseX position.

    Returns number

StaticmouseXRatio

  • get mouseXRatio(): number

  • The current ratio value of the mouseX position, where the left edge of the canvas maps to 0, and the right edge of the canvas maps to 1.

    Returns number

StaticmouseY

  • get mouseY(): number

  • The current mouseY position.

    Returns number

StaticmouseYRatio

  • get mouseYRatio(): number

  • The current ratio value of the mouseY position, where the top edge of the canvas maps to 0, and the bottom edge of the canvas maps to 1.

    Returns number

Methods

StaticmapMouseXToCanvas

  • mapMouseXToCanvas(mouseX): number

  • Map the provided x-axis mouse position to the corresponding value on the scale of CoordinateMapper.minX to CoordinateMapper.maxX.

    Parameters

    • mouseX: number

    Returns number

StaticmapMouseXToRatio

  • mapMouseXToRatio(mouseX): number

  • Parameters

    • mouseX: number

    Returns number

StaticmapMouseYToCanvas

  • mapMouseYToCanvas(mouseY): number

  • Parameters

    • mouseY: number

    Returns number

StaticmapMouseYToRatio

  • mapMouseYToRatio(mouseY): number

  • Parameters

    • mouseY: number

    Returns number

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods