Class default

The Matter.Mouse module contains methods for creating and manipulating mouse inputs.

Hierarchy

default

Index

Constructors

Methods

_getRelativeMousePosition clearSourceEvents create isTouchEvent setElement setOffset setScale

Constructors

constructor

new default(): default
Returns default

Methods

`Static` `Protected` _getRelativeMousePosition

_getRelativeMousePosition(event, element, pixelRatio): IVector
Gets the mouse position relative to an element given a screen pixel ratio.
Parameters
- event: MouseEventType
- element: HTMLElement
- pixelRatio: number
Returns IVector
The mouse position

Method
_getRelativeMousePosition
- Defined in src/core/Mouse.ts:213

`Static` clearSourceEvents

clearSourceEvents(mouse): void
Clears all captured source events.
Parameters
- mouse: IMouse
Returns void

Method
clearSourceEvents
- Defined in src/core/Mouse.ts:171

`Static` create

create(element?): IMouse
Creates a mouse input.
Parameters
- Optional element: HTMLElement
Returns IMouse
A new mouse

Method
create
- Defined in src/core/Mouse.ts:39

`Static` isTouchEvent

isTouchEvent(event): event is TouchEvent
Parameters
- event: MouseEventType
Returns event is TouchEvent
- Defined in src/core/Mouse.ts:142

`Static` setElement

setElement(mouse, element): void
Sets the element the mouse is bound to (and relative to).
Parameters
- mouse: IMouse
- element: HTMLElement
Returns void

Method
setElement
- Defined in src/core/Mouse.ts:152

`Static` setOffset

setOffset(mouse, offset): void
Sets the mouse position offset.
Parameters
- mouse: IMouse
- offset: IVector
Returns void

Method
setOffset
- Defined in src/core/Mouse.ts:185

`Static` setScale

setScale(mouse, scale): void
Sets the mouse position scale.
Parameters
- mouse: IMouse
- scale: IVector
Returns void

Method
setScale
- Defined in src/core/Mouse.ts:198

Generated using TypeDoc