import MouseObserver from 'ngl/src/stage/mouse-observer.js'

public class | source

MouseObserver

Mouse observer

Example:

// listen to mouse moving (and touch-moving) events
mouseObserver.moved.moved.add( function( deltaX, deltaY ){ ... } );

// listen to scrolling (and pinching) events
mouseObserver.signals.scrolled.add( function( delta ){ ... } );

// listen to dragging (and touch-dragging) events
mouseObserver.signals.dragged.add( function( deltaX, deltaY ){ ... } );

// listen to clicking (and tapping) events
mouseObserver.signals.clicked.add( function(){ ... } );

// listen to double clicking (and double tapping) events
mouseObserver.signals.doubleClicked.add( function(){ ... } );

// listen to hovering events
mouseObserver.signals.hovered.add( function(){ ... } );

Constructor Summary

Public Constructor
public	constructor(domElement: Element, params: Object)

Member Summary

Public Members
public	altKey: Boolean Flag indicating if the alt key is pressed
public	buttons: Integer Indicates which mouse buttons were pressed: 0: No button; 1: Left button; 2: Right button; 4: Middle button
public	canvasPosition: Vector2 Position on dom element
public	ctrlKey: Boolean Flag indicating if the ctrl key is pressed
public	domElement
public	doubleClickPending
public	doubleClickSpeed
public	down: Vector2 Position on page when clicked
public	handleScroll
public	hoverTimeout
public	hovering: Boolean Flag indicating if the mouse is hovering
public get	key
public	lastClicked
public	lastMoved: Number Timestamp of last mouse move
public	lastTouchDistance
public	metaKey: Boolean Flag indicating if the meta key is pressed
public	moving: Boolean Flag indicating if the mouse is moving
public	overElement
public	position: Vector2 Position on page
public	pressed: Boolean Flag indicating if the mouse is pressed down
public	prevClickCP
public	prevPosition: Vector2 Previous position on page
public	scrolled: Boolean Flag indicating if there was a scolling event since the last mouse move
public	shiftKey: Boolean Flag indicating if the shift key is pressed
public	signals: MouseSignals Events emitted by the mouse observer
public	which: Integer Indicates which mouse button was pressed: 0: No button; 1: Left button; 2: Middle button; 3: Right button

Method Summary

Public Methods
public	dispose()
public	setParameters()

Private Methods
private	_distance()
private	_listen(): undefined listen to mouse actions
private	_onContextmenu()
private	_onMousedown()
private	_onMousemove(event: Event): undefined handle mouse move
private	_onMouseup(event: Event): undefined handle mouse up
private	_onMousewheel(event: Event): undefined handle mouse scroll
private	_onTouchend()
private	_onTouchmove()
private	_onTouchstart()
private	_setCanvasPosition()
private	_setKeys()

Public Constructors

public constructor(domElement: Element, params: Object) source

Params:

Name	Type	Attribute	Description
domElement	Element		the dom element to observe mouse events in
params	Object		parameters object
params.hoverTimeout	Integer		timeout in ms until the MouseSignals.hovered signal is fired, set to -1 to ignore hovering
params.handleScroll	Boolean		whether or not to handle scroll events
params.doubleClickSpeed	Integer		max time in ms to trigger double click

Public Members

public altKey: Boolean source

Flag indicating if the alt key is pressed

public buttons: Integer source

Indicates which mouse buttons were pressed: 0: No button; 1: Left button; 2: Right button; 4: Middle button

public canvasPosition: Vector2 source

Position on dom element

public ctrlKey: Boolean source

Flag indicating if the ctrl key is pressed

public domElement source

public doubleClickPending source

public doubleClickSpeed source

public down: Vector2 source

Position on page when clicked

public handleScroll source

public hoverTimeout source

public hovering: Boolean source

Flag indicating if the mouse is hovering

public get key source

public lastClicked source

public lastMoved: Number source

Timestamp of last mouse move

public lastTouchDistance source

public metaKey: Boolean source

Flag indicating if the meta key is pressed

public moving: Boolean source

Flag indicating if the mouse is moving

public overElement source

public position: Vector2 source

Position on page

public pressed: Boolean source

Flag indicating if the mouse is pressed down

public prevClickCP source

public prevPosition: Vector2 source

Previous position on page

public scrolled: Boolean source

Flag indicating if there was a scolling event since the last mouse move

public shiftKey: Boolean source

Flag indicating if the shift key is pressed

public signals: MouseSignals source

Events emitted by the mouse observer

public which: Integer source

Indicates which mouse button was pressed: 0: No button; 1: Left button; 2: Middle button; 3: Right button

Public Methods

public dispose() source

public setParameters() source

Private Methods

private _distance() source

private _listen(): undefined source

listen to mouse actions

Return:

undefined

Emit:

MouseSignals.clicked	when clicked
MouseSignals.hovered	when hovered

private _onContextmenu() source

private _onMousedown() source

private _onMousemove(event: Event): undefined source

handle mouse move

Params:

Name	Type	Attribute	Description
event	Event		mouse event

Return:

undefined

Emit:

MouseSignals.moved	when moved
MouseSignals.dragged	when dragged

private _onMouseup(event: Event): undefined source

handle mouse up

Params:

Name	Type	Attribute	Description
event	Event		mouse event

Return:

undefined

Emit:

MouseSignals.doubleClicked	when double clicked
MouseSignals.dropped	when dropped

private _onMousewheel(event: Event): undefined source

handle mouse scroll

Params:

Name	Type	Attribute	Description
event	Event		mouse event

MouseObserver

Example:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(domElement: Element, params: Object) source

Params:

Public Members

public altKey: Boolean source

public buttons: Integer source

public canvasPosition: Vector2 source

public ctrlKey: Boolean source

public domElement source

public doubleClickPending source

public doubleClickSpeed source

public down: Vector2 source

public handleScroll source

public hoverTimeout source

public hovering: Boolean source

public get key source

public lastClicked source

public lastMoved: Number source

public lastTouchDistance source

public metaKey: Boolean source

public moving: Boolean source

public overElement source

public position: Vector2 source

public pressed: Boolean source

public prevClickCP source

public prevPosition: Vector2 source

public scrolled: Boolean source

public shiftKey: Boolean source

public signals: MouseSignals source

public which: Integer source

Public Methods

public dispose() source

public setParameters() source

Private Methods

private _distance() source

private _listen(): undefined source

Return:

Emit:

private _onContextmenu() source

private _onMousedown() source

private _onMousemove(event: Event): undefined source

Params:

Return:

Emit:

private _onMouseup(event: Event): undefined source

Params:

Return:

Emit:

private _onMousewheel(event: Event): undefined source

Params:

Return:

Emit:

private _onTouchend() source

private _onTouchmove() source

private _onTouchstart() source

private _setCanvasPosition() source

private _setKeys() source