Skip to content
Henryk Wollik edited this page Jul 28, 2014 · 1 revision

Class: Mouse

Mouse

new Mouse()

Representation of mouse input.

Source:

Members

<static> __instance

Return the singleton.

Source:

Methods

didEnter() → {Boolean}

Returns true if the mouse did enter the window (canvas).

Source:
Returns:
Type
Boolean

didLeave() → {Boolean}

Returns true if the mouse did leave the window (canvas).

Source:
Returns:
Type
Boolean

didMove() → {Boolean}

Returns true if the mouse did move.

Source:
Returns:
Type
Boolean

getPosition(v) → {Vec2}

Return current mouse position.

Parameters:
Name Type Argument Description
v Vec2 <optional>

Out position

Source:
Returns:
Type
Vec2

getPositionLast(v) → {Vec2}

Return previous mouse position.

Parameters:
Name Type Argument Description
v Vec2 <optional>

Out position

Source:
Returns:
Type
Vec2

getPositionLastNormalized(v) → {Vec2}

Return previous mouse position normaliized.

Parameters:
Name Type Argument Description
v Vec2 <optional>

Out position

Source:
Returns:
Type
Vec2

getPositionNormalized(v) → {Vec2}

Return current mouse position normaliized.

Parameters:
Name Type Argument Description
v Vec2 <optional>

Out position

Source:
Returns:
Type
Vec2

getWheelDelta() → {Number}

Return mouse wheel delta.

Source:
Returns:
Type
Number

getX() → {Number}

Return current mouse position x.

Source:
Returns:
Type
Number

getXLast() → {Number}

Return previous mouse position x.

Source:
Returns:
Type
Number

getXLastNormalized() → {Number}

Return previous mouse position x normalized.

Source:
Returns:
Type
Number

getXNormalized() → {Number}

Return current mouse position x normalized.

Source:
Returns:
Type
Number

getY() → {Number}

Return current mouse position y.

Source:
Returns:
Type
Number

getYLast() → {Number}

Return previous mouse position y.

Source:
Returns:
Type
Number

getYLastNormalized() → {Number}

Return previous mouse position x normalized.

Source:
Returns:
Type
Number

getYNormalized() → {Number}

Return current mouse position y normalized.

Source:
Returns:
Type
Number

isDown() → {Boolean}

Returns true if the mouse is down.

Source:
Returns:
Type
Boolean

isDragged() → {Boolean}

Returns true if the mouse is dragged.

Source:
Returns:
Type
Boolean

isPressed() → {Boolean}

Returns true if the mouse is pressed (hold).

Source:
Returns:
Type
Boolean

Generated with wicked.

Clone this wiki locally