2013-10-01 12:54:29 +00:00
|
|
|
/**
|
|
|
|
* @author Richard Davey <rich@photonstorm.com>
|
2015-02-25 03:36:23 +00:00
|
|
|
* @copyright 2015 Photon Storm Ltd.
|
2013-10-01 12:54:29 +00:00
|
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2014-10-27 00:25:03 +00:00
|
|
|
* The Mouse class is responsible for handling all aspects of mouse interaction with the browser.
|
|
|
|
*
|
2014-09-04 22:29:43 +00:00
|
|
|
* It captures and processes mouse events that happen on the game canvas object. It also adds a single `mouseup` listener to `window` which
|
|
|
|
* is used to capture the mouse being released when not over the game.
|
2013-10-01 12:54:29 +00:00
|
|
|
*
|
|
|
|
* @class Phaser.Mouse
|
|
|
|
* @constructor
|
|
|
|
* @param {Phaser.Game} game - A reference to the currently running game.
|
|
|
|
*/
|
2013-08-31 20:50:34 +00:00
|
|
|
Phaser.Mouse = function (game) {
|
2013-08-31 12:54:59 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
|
|
|
* @property {Phaser.Game} game - A reference to the currently running game.
|
|
|
|
*/
|
|
|
|
this.game = game;
|
2014-03-23 07:59:28 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
2014-11-30 11:10:52 +00:00
|
|
|
* @property {object} callbackContext - The context under which callbacks are called.
|
2013-11-25 03:13:04 +00:00
|
|
|
*/
|
|
|
|
this.callbackContext = this.game;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @property {function} mouseDownCallback - A callback that can be fired when the mouse is pressed down.
|
|
|
|
*/
|
|
|
|
this.mouseDownCallback = null;
|
2014-03-23 07:59:28 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
2015-01-01 19:55:35 +00:00
|
|
|
* @property {function} mouseMoveCallback - A callback that can be fired when the mouse is moved.
|
|
|
|
* @deprecated Will be removed soon. Please use `Input.addMoveCallback` instead.
|
2013-11-25 03:13:04 +00:00
|
|
|
*/
|
|
|
|
this.mouseMoveCallback = null;
|
2014-03-23 07:59:28 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
|
|
|
* @property {function} mouseUpCallback - A callback that can be fired when the mouse is released from a pressed down state.
|
|
|
|
*/
|
|
|
|
this.mouseUpCallback = null;
|
2013-11-04 03:16:17 +00:00
|
|
|
|
2014-05-14 21:56:12 +00:00
|
|
|
/**
|
|
|
|
* @property {function} mouseOutCallback - A callback that can be fired when the mouse is no longer over the game canvas.
|
|
|
|
*/
|
|
|
|
this.mouseOutCallback = null;
|
|
|
|
|
2014-05-19 17:49:16 +00:00
|
|
|
/**
|
|
|
|
* @property {function} mouseOverCallback - A callback that can be fired when the mouse enters the game canvas (usually after a mouseout).
|
|
|
|
*/
|
|
|
|
this.mouseOverCallback = null;
|
|
|
|
|
2014-06-29 11:45:39 +00:00
|
|
|
/**
|
|
|
|
* @property {function} mouseWheelCallback - A callback that can be fired when the mousewheel is used.
|
|
|
|
*/
|
|
|
|
this.mouseWheelCallback = null;
|
|
|
|
|
2013-11-24 11:04:58 +00:00
|
|
|
/**
|
2015-02-05 05:13:15 +00:00
|
|
|
* @property {boolean} capture - If true the DOM mouse events will have event.preventDefault applied to them, if false they will propagate fully.
|
2013-11-24 11:04:58 +00:00
|
|
|
*/
|
2013-11-27 16:33:49 +00:00
|
|
|
this.capture = false;
|
2013-11-24 11:04:58 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
|
|
|
* @property {number} button- The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.
|
|
|
|
* @default
|
|
|
|
*/
|
|
|
|
this.button = -1;
|
2013-08-31 12:54:59 +00:00
|
|
|
|
2014-06-29 11:45:39 +00:00
|
|
|
/**
|
2014-11-12 11:53:26 +00:00
|
|
|
* @property {number} wheelDelta - The direction of the _last_ mousewheel usage 1 for up -1 for down
|
2014-06-29 11:45:39 +00:00
|
|
|
*/
|
|
|
|
this.wheelDelta = 0;
|
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
/**
|
2014-10-27 00:25:03 +00:00
|
|
|
* Mouse input will only be processed if enabled.
|
2014-10-29 04:46:33 +00:00
|
|
|
* @property {boolean} enabled
|
2013-10-01 12:54:29 +00:00
|
|
|
* @default
|
2013-08-31 12:54:59 +00:00
|
|
|
*/
|
2014-10-27 00:25:03 +00:00
|
|
|
this.enabled = true;
|
2013-08-31 12:54:59 +00:00
|
|
|
|
2013-09-09 18:59:31 +00:00
|
|
|
/**
|
2013-11-25 03:13:04 +00:00
|
|
|
* @property {boolean} locked - If the mouse has been Pointer Locked successfully this will be set to true.
|
2013-10-01 12:54:29 +00:00
|
|
|
* @default
|
2013-09-09 18:59:31 +00:00
|
|
|
*/
|
2013-10-02 14:05:55 +00:00
|
|
|
this.locked = false;
|
|
|
|
|
2014-05-14 21:56:12 +00:00
|
|
|
/**
|
|
|
|
* @property {boolean} stopOnGameOut - If true Pointer.stop will be called if the mouse leaves the game canvas.
|
|
|
|
* @default
|
|
|
|
*/
|
|
|
|
this.stopOnGameOut = false;
|
|
|
|
|
2013-11-04 03:16:17 +00:00
|
|
|
/**
|
2013-11-25 03:13:04 +00:00
|
|
|
* @property {Phaser.Signal} pointerLock - This event is dispatched when the browser enters or leaves pointer lock state.
|
2013-11-04 03:16:17 +00:00
|
|
|
* @default
|
|
|
|
*/
|
2013-11-25 03:13:04 +00:00
|
|
|
this.pointerLock = new Phaser.Signal();
|
2013-11-04 03:16:17 +00:00
|
|
|
|
2013-11-17 12:31:57 +00:00
|
|
|
/**
|
2014-11-12 11:53:26 +00:00
|
|
|
* The browser mouse DOM event. Will be null if no mouse event has ever been received.
|
|
|
|
* Access this property only inside a Mouse event handler and do not keep references to it.
|
|
|
|
* @property {MouseEvent|null} event
|
2013-12-27 00:26:21 +00:00
|
|
|
* @default
|
2013-11-17 12:31:57 +00:00
|
|
|
*/
|
2013-11-25 03:13:04 +00:00
|
|
|
this.event = null;
|
2013-11-17 12:31:57 +00:00
|
|
|
|
|
|
|
/**
|
2013-11-25 03:13:04 +00:00
|
|
|
* @property {function} _onMouseDown - Internal event handler reference.
|
2013-11-17 12:31:57 +00:00
|
|
|
* @private
|
|
|
|
*/
|
2013-11-25 03:13:04 +00:00
|
|
|
this._onMouseDown = null;
|
2013-11-17 12:31:57 +00:00
|
|
|
|
|
|
|
/**
|
2013-11-25 03:13:04 +00:00
|
|
|
* @property {function} _onMouseMove - Internal event handler reference.
|
2013-11-17 12:31:57 +00:00
|
|
|
* @private
|
|
|
|
*/
|
2013-11-25 03:13:04 +00:00
|
|
|
this._onMouseMove = null;
|
2013-11-17 12:31:57 +00:00
|
|
|
|
|
|
|
/**
|
2013-11-25 03:13:04 +00:00
|
|
|
* @property {function} _onMouseUp - Internal event handler reference.
|
2013-11-17 12:31:57 +00:00
|
|
|
* @private
|
|
|
|
*/
|
2013-11-25 03:13:04 +00:00
|
|
|
this._onMouseUp = null;
|
2013-11-17 12:31:57 +00:00
|
|
|
|
2014-05-14 21:56:12 +00:00
|
|
|
/**
|
|
|
|
* @property {function} _onMouseOut - Internal event handler reference.
|
|
|
|
* @private
|
|
|
|
*/
|
|
|
|
this._onMouseOut = null;
|
|
|
|
|
2014-05-19 17:49:16 +00:00
|
|
|
/**
|
|
|
|
* @property {function} _onMouseOver - Internal event handler reference.
|
|
|
|
* @private
|
|
|
|
*/
|
|
|
|
this._onMouseOver = null;
|
|
|
|
|
2014-06-29 11:45:39 +00:00
|
|
|
/**
|
2014-11-12 11:53:26 +00:00
|
|
|
* @property {function} _onMouseWheel - Internal event handler reference.
|
|
|
|
* @private
|
|
|
|
*/
|
2014-06-29 11:45:39 +00:00
|
|
|
this._onMouseWheel = null;
|
|
|
|
|
2014-11-12 11:53:26 +00:00
|
|
|
/**
|
|
|
|
* Wheel proxy event object, if required. Shared for all wheel events for this mouse.
|
|
|
|
* @property {Phaser.Mouse~WheelEventProxy} _wheelEvent
|
|
|
|
* @private
|
|
|
|
*/
|
|
|
|
this._wheelEvent = null;
|
|
|
|
|
2013-10-02 14:05:55 +00:00
|
|
|
};
|
|
|
|
|
2013-11-03 23:16:36 +00:00
|
|
|
/**
|
|
|
|
* @constant
|
|
|
|
* @type {number}
|
|
|
|
*/
|
|
|
|
Phaser.Mouse.NO_BUTTON = -1;
|
2013-11-25 03:13:04 +00:00
|
|
|
|
2013-10-02 14:05:55 +00:00
|
|
|
/**
|
|
|
|
* @constant
|
|
|
|
* @type {number}
|
|
|
|
*/
|
|
|
|
Phaser.Mouse.LEFT_BUTTON = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @constant
|
|
|
|
* @type {number}
|
|
|
|
*/
|
|
|
|
Phaser.Mouse.MIDDLE_BUTTON = 1;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @constant
|
|
|
|
* @type {number}
|
|
|
|
*/
|
|
|
|
Phaser.Mouse.RIGHT_BUTTON = 2;
|
|
|
|
|
2014-06-29 12:23:09 +00:00
|
|
|
/**
|
|
|
|
* @constant
|
|
|
|
* @type {number}
|
|
|
|
*/
|
|
|
|
Phaser.Mouse.WHEEL_UP = 1;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @constant
|
|
|
|
* @type {number}
|
|
|
|
*/
|
|
|
|
Phaser.Mouse.WHEEL_DOWN = -1;
|
|
|
|
|
2013-10-02 14:05:55 +00:00
|
|
|
Phaser.Mouse.prototype = {
|
2013-09-09 18:59:31 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
2013-10-01 12:54:29 +00:00
|
|
|
* Starts the event listeners running.
|
2013-10-02 14:05:55 +00:00
|
|
|
* @method Phaser.Mouse#start
|
2013-08-31 12:54:59 +00:00
|
|
|
*/
|
|
|
|
start: function () {
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
if (this.game.device.android && this.game.device.chrome === false)
|
2013-08-31 12:54:59 +00:00
|
|
|
{
|
|
|
|
// Android stock browser fires mouse events even if you preventDefault on the touchStart, so ...
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2014-03-19 13:22:04 +00:00
|
|
|
if (this._onMouseDown !== null)
|
|
|
|
{
|
|
|
|
// Avoid setting multiple listeners
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
var _this = this;
|
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
this._onMouseDown = function (event) {
|
|
|
|
return _this.onMouseDown(event);
|
|
|
|
};
|
|
|
|
|
|
|
|
this._onMouseMove = function (event) {
|
|
|
|
return _this.onMouseMove(event);
|
|
|
|
};
|
|
|
|
|
|
|
|
this._onMouseUp = function (event) {
|
|
|
|
return _this.onMouseUp(event);
|
|
|
|
};
|
|
|
|
|
2014-09-04 22:29:43 +00:00
|
|
|
this._onMouseUpGlobal = function (event) {
|
|
|
|
return _this.onMouseUpGlobal(event);
|
|
|
|
};
|
|
|
|
|
2014-05-14 21:56:12 +00:00
|
|
|
this._onMouseOut = function (event) {
|
|
|
|
return _this.onMouseOut(event);
|
|
|
|
};
|
|
|
|
|
2014-05-19 17:49:16 +00:00
|
|
|
this._onMouseOver = function (event) {
|
|
|
|
return _this.onMouseOver(event);
|
|
|
|
};
|
|
|
|
|
2014-06-29 11:45:39 +00:00
|
|
|
this._onMouseWheel = function (event) {
|
2014-06-29 11:49:45 +00:00
|
|
|
return _this.onMouseWheel(event);
|
2014-06-29 11:45:39 +00:00
|
|
|
};
|
|
|
|
|
2014-02-14 03:34:35 +00:00
|
|
|
this.game.canvas.addEventListener('mousedown', this._onMouseDown, true);
|
|
|
|
this.game.canvas.addEventListener('mousemove', this._onMouseMove, true);
|
|
|
|
this.game.canvas.addEventListener('mouseup', this._onMouseUp, true);
|
2014-05-29 21:23:33 +00:00
|
|
|
|
|
|
|
if (!this.game.device.cocoonJS)
|
|
|
|
{
|
2014-09-04 22:29:43 +00:00
|
|
|
window.addEventListener('mouseup', this._onMouseUpGlobal, true);
|
2014-05-29 21:23:33 +00:00
|
|
|
this.game.canvas.addEventListener('mouseover', this._onMouseOver, true);
|
|
|
|
this.game.canvas.addEventListener('mouseout', this._onMouseOut, true);
|
2014-11-12 21:24:03 +00:00
|
|
|
}
|
2014-11-12 11:53:26 +00:00
|
|
|
|
2014-11-12 21:24:03 +00:00
|
|
|
var wheelEvent = this.game.device.wheelEvent;
|
2015-02-05 06:12:20 +00:00
|
|
|
|
2014-11-12 21:24:03 +00:00
|
|
|
if (wheelEvent)
|
|
|
|
{
|
|
|
|
this.game.canvas.addEventListener(wheelEvent, this._onMouseWheel, true);
|
|
|
|
|
|
|
|
if (wheelEvent === 'mousewheel')
|
2014-11-12 11:53:26 +00:00
|
|
|
{
|
|
|
|
this._wheelEvent = new WheelEventProxy(-1/40, 1);
|
|
|
|
}
|
2014-11-12 21:24:03 +00:00
|
|
|
else if (wheelEvent === 'DOMMouseScroll')
|
2014-11-12 11:53:26 +00:00
|
|
|
{
|
|
|
|
this._wheelEvent = new WheelEventProxy(1, 1);
|
|
|
|
}
|
2014-05-29 21:23:33 +00:00
|
|
|
}
|
2013-09-10 15:46:39 +00:00
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
},
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
|
|
|
* The internal method that handles the mouse down event from the browser.
|
|
|
|
* @method Phaser.Mouse#onMouseDown
|
|
|
|
* @param {MouseEvent} event - The native event from the browser. This gets stored in Mouse.event.
|
2013-08-31 12:54:59 +00:00
|
|
|
*/
|
|
|
|
onMouseDown: function (event) {
|
|
|
|
|
2013-11-17 12:31:57 +00:00
|
|
|
this.event = event;
|
|
|
|
|
2013-11-24 11:04:58 +00:00
|
|
|
if (this.capture)
|
|
|
|
{
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
2013-11-01 02:07:21 +00:00
|
|
|
|
2014-02-21 15:47:00 +00:00
|
|
|
this.button = event.button;
|
2013-11-03 22:43:47 +00:00
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
if (this.mouseDownCallback)
|
|
|
|
{
|
|
|
|
this.mouseDownCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
2014-10-27 00:25:03 +00:00
|
|
|
if (!this.game.input.enabled || !this.enabled)
|
2013-08-31 12:54:59 +00:00
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
event['identifier'] = 0;
|
|
|
|
|
|
|
|
this.game.input.mousePointer.start(event);
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
2013-11-04 03:16:17 +00:00
|
|
|
* The internal method that handles the mouse move event from the browser.
|
2013-11-25 03:13:04 +00:00
|
|
|
* @method Phaser.Mouse#onMouseMove
|
|
|
|
* @param {MouseEvent} event - The native event from the browser. This gets stored in Mouse.event.
|
2013-08-31 12:54:59 +00:00
|
|
|
*/
|
|
|
|
onMouseMove: function (event) {
|
|
|
|
|
2013-11-17 12:31:57 +00:00
|
|
|
this.event = event;
|
|
|
|
|
2013-11-24 11:04:58 +00:00
|
|
|
if (this.capture)
|
|
|
|
{
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
2013-11-01 02:07:21 +00:00
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
if (this.mouseMoveCallback)
|
|
|
|
{
|
|
|
|
this.mouseMoveCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
2014-10-27 00:25:03 +00:00
|
|
|
if (!this.game.input.enabled || !this.enabled)
|
2013-08-31 12:54:59 +00:00
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
event['identifier'] = 0;
|
|
|
|
|
|
|
|
this.game.input.mousePointer.move(event);
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
2013-11-04 03:16:17 +00:00
|
|
|
* The internal method that handles the mouse up event from the browser.
|
2013-11-25 03:13:04 +00:00
|
|
|
* @method Phaser.Mouse#onMouseUp
|
|
|
|
* @param {MouseEvent} event - The native event from the browser. This gets stored in Mouse.event.
|
2013-08-31 12:54:59 +00:00
|
|
|
*/
|
|
|
|
onMouseUp: function (event) {
|
|
|
|
|
2013-11-17 12:31:57 +00:00
|
|
|
this.event = event;
|
|
|
|
|
2013-11-24 11:04:58 +00:00
|
|
|
if (this.capture)
|
|
|
|
{
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
2013-11-01 02:07:21 +00:00
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
this.button = Phaser.Mouse.NO_BUTTON;
|
2013-11-03 22:43:47 +00:00
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
if (this.mouseUpCallback)
|
|
|
|
{
|
|
|
|
this.mouseUpCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
2014-10-27 00:25:03 +00:00
|
|
|
if (!this.game.input.enabled || !this.enabled)
|
2013-08-31 12:54:59 +00:00
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
event['identifier'] = 0;
|
|
|
|
|
|
|
|
this.game.input.mousePointer.stop(event);
|
|
|
|
|
2013-09-09 18:59:31 +00:00
|
|
|
},
|
|
|
|
|
2014-09-04 22:29:43 +00:00
|
|
|
/**
|
|
|
|
* The internal method that handles the mouse up event from the window.
|
|
|
|
*
|
|
|
|
* @method Phaser.Mouse#onMouseUpGlobal
|
|
|
|
* @param {MouseEvent} event - The native event from the browser. This gets stored in Mouse.event.
|
|
|
|
*/
|
|
|
|
onMouseUpGlobal: function (event) {
|
|
|
|
|
|
|
|
if (!this.game.input.mousePointer.withinGame)
|
|
|
|
{
|
|
|
|
this.button = Phaser.Mouse.NO_BUTTON;
|
|
|
|
|
|
|
|
if (this.mouseUpCallback)
|
|
|
|
{
|
|
|
|
this.mouseUpCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
|
|
|
event['identifier'] = 0;
|
|
|
|
|
|
|
|
this.game.input.mousePointer.stop(event);
|
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2014-05-14 21:56:12 +00:00
|
|
|
/**
|
|
|
|
* The internal method that handles the mouse out event from the browser.
|
|
|
|
*
|
|
|
|
* @method Phaser.Mouse#onMouseOut
|
|
|
|
* @param {MouseEvent} event - The native event from the browser. This gets stored in Mouse.event.
|
|
|
|
*/
|
|
|
|
onMouseOut: function (event) {
|
|
|
|
|
|
|
|
this.event = event;
|
|
|
|
|
|
|
|
if (this.capture)
|
|
|
|
{
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
|
|
|
|
2014-09-04 22:29:43 +00:00
|
|
|
this.game.input.mousePointer.withinGame = false;
|
|
|
|
|
2014-05-14 21:56:12 +00:00
|
|
|
if (this.mouseOutCallback)
|
|
|
|
{
|
|
|
|
this.mouseOutCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
2014-10-27 00:25:03 +00:00
|
|
|
if (!this.game.input.enabled || !this.enabled)
|
2014-05-14 21:56:12 +00:00
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (this.stopOnGameOut)
|
|
|
|
{
|
|
|
|
event['identifier'] = 0;
|
|
|
|
|
|
|
|
this.game.input.mousePointer.stop(event);
|
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2014-06-29 11:45:39 +00:00
|
|
|
/**
|
|
|
|
* The internal method that handles the mouse wheel event from the browser.
|
|
|
|
*
|
|
|
|
* @method Phaser.Mouse#onMouseWheel
|
2014-11-12 11:53:26 +00:00
|
|
|
* @param {MouseEvent} event - The native event from the browser.
|
2014-06-29 11:45:39 +00:00
|
|
|
*/
|
|
|
|
onMouseWheel: function (event) {
|
|
|
|
|
2014-11-12 11:53:26 +00:00
|
|
|
if (this._wheelEvent) {
|
|
|
|
event = this._wheelEvent.bindEvent(event);
|
|
|
|
}
|
|
|
|
|
2014-06-29 11:45:39 +00:00
|
|
|
this.event = event;
|
|
|
|
|
|
|
|
if (this.capture)
|
|
|
|
{
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
|
|
|
|
|
|
|
// reverse detail for firefox
|
2014-11-12 11:53:26 +00:00
|
|
|
this.wheelDelta = Phaser.Math.clamp(-event.deltaY, -1, 1);
|
2014-06-29 11:45:39 +00:00
|
|
|
|
|
|
|
if (this.mouseWheelCallback)
|
|
|
|
{
|
|
|
|
this.mouseWheelCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2014-05-19 17:49:16 +00:00
|
|
|
/**
|
|
|
|
* The internal method that handles the mouse over event from the browser.
|
|
|
|
*
|
|
|
|
* @method Phaser.Mouse#onMouseOver
|
|
|
|
* @param {MouseEvent} event - The native event from the browser. This gets stored in Mouse.event.
|
|
|
|
*/
|
|
|
|
onMouseOver: function (event) {
|
|
|
|
|
|
|
|
this.event = event;
|
|
|
|
|
|
|
|
if (this.capture)
|
|
|
|
{
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
|
|
|
|
2014-09-04 22:29:43 +00:00
|
|
|
this.game.input.mousePointer.withinGame = true;
|
|
|
|
|
2014-05-19 17:49:16 +00:00
|
|
|
if (this.mouseOverCallback)
|
|
|
|
{
|
|
|
|
this.mouseOverCallback.call(this.callbackContext, event);
|
|
|
|
}
|
|
|
|
|
2014-10-27 00:25:03 +00:00
|
|
|
if (!this.game.input.enabled || !this.enabled)
|
2014-05-19 17:49:16 +00:00
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2013-10-01 12:54:29 +00:00
|
|
|
/**
|
2013-11-04 03:16:17 +00:00
|
|
|
* If the browser supports it you can request that the pointer be locked to the browser window.
|
|
|
|
* This is classically known as 'FPS controls', where the pointer can't leave the browser until the user presses an exit key.
|
|
|
|
* If the browser successfully enters a locked state the event Phaser.Mouse.pointerLock will be dispatched and the first parameter will be 'true'.
|
2013-11-25 03:13:04 +00:00
|
|
|
* @method Phaser.Mouse#requestPointerLock
|
2013-10-01 12:54:29 +00:00
|
|
|
*/
|
2013-09-09 18:59:31 +00:00
|
|
|
requestPointerLock: function () {
|
|
|
|
|
|
|
|
if (this.game.device.pointerLock)
|
|
|
|
{
|
2014-02-13 12:55:58 +00:00
|
|
|
var element = this.game.canvas;
|
2013-09-09 18:59:31 +00:00
|
|
|
|
|
|
|
element.requestPointerLock = element.requestPointerLock || element.mozRequestPointerLock || element.webkitRequestPointerLock;
|
|
|
|
|
|
|
|
element.requestPointerLock();
|
|
|
|
|
|
|
|
var _this = this;
|
|
|
|
|
|
|
|
this._pointerLockChange = function (event) {
|
|
|
|
return _this.pointerLockChange(event);
|
|
|
|
};
|
|
|
|
|
2013-11-04 03:16:17 +00:00
|
|
|
document.addEventListener('pointerlockchange', this._pointerLockChange, true);
|
|
|
|
document.addEventListener('mozpointerlockchange', this._pointerLockChange, true);
|
|
|
|
document.addEventListener('webkitpointerlockchange', this._pointerLockChange, true);
|
2013-09-09 18:59:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
|
|
|
* Internal pointerLockChange handler.
|
2014-10-21 21:43:42 +00:00
|
|
|
*
|
2013-11-25 03:13:04 +00:00
|
|
|
* @method Phaser.Mouse#pointerLockChange
|
2014-10-21 21:43:42 +00:00
|
|
|
* @param {Event} event - The native event from the browser. This gets stored in Mouse.event.
|
2013-10-01 12:54:29 +00:00
|
|
|
*/
|
2013-09-09 18:59:31 +00:00
|
|
|
pointerLockChange: function (event) {
|
|
|
|
|
2014-02-13 12:55:58 +00:00
|
|
|
var element = this.game.canvas;
|
2013-09-09 18:59:31 +00:00
|
|
|
|
|
|
|
if (document.pointerLockElement === element || document.mozPointerLockElement === element || document.webkitPointerLockElement === element)
|
|
|
|
{
|
|
|
|
// Pointer was successfully locked
|
|
|
|
this.locked = true;
|
2013-11-25 03:13:04 +00:00
|
|
|
this.pointerLock.dispatch(true, event);
|
2013-09-09 18:59:31 +00:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
// Pointer was unlocked
|
|
|
|
this.locked = false;
|
2013-11-25 03:13:04 +00:00
|
|
|
this.pointerLock.dispatch(false, event);
|
2013-09-09 18:59:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
|
|
|
* Internal release pointer lock handler.
|
|
|
|
* @method Phaser.Mouse#releasePointerLock
|
2013-10-01 12:54:29 +00:00
|
|
|
*/
|
2013-09-09 18:59:31 +00:00
|
|
|
releasePointerLock: function () {
|
|
|
|
|
|
|
|
document.exitPointerLock = document.exitPointerLock || document.mozExitPointerLock || document.webkitExitPointerLock;
|
|
|
|
|
|
|
|
document.exitPointerLock();
|
|
|
|
|
2013-11-04 03:16:17 +00:00
|
|
|
document.removeEventListener('pointerlockchange', this._pointerLockChange, true);
|
|
|
|
document.removeEventListener('mozpointerlockchange', this._pointerLockChange, true);
|
|
|
|
document.removeEventListener('webkitpointerlockchange', this._pointerLockChange, true);
|
2013-09-09 18:59:31 +00:00
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
},
|
|
|
|
|
2013-11-25 03:13:04 +00:00
|
|
|
/**
|
2013-10-01 12:54:29 +00:00
|
|
|
* Stop the event listeners.
|
2013-10-02 14:05:55 +00:00
|
|
|
* @method Phaser.Mouse#stop
|
2013-08-31 12:54:59 +00:00
|
|
|
*/
|
|
|
|
stop: function () {
|
|
|
|
|
2014-02-14 03:34:35 +00:00
|
|
|
this.game.canvas.removeEventListener('mousedown', this._onMouseDown, true);
|
|
|
|
this.game.canvas.removeEventListener('mousemove', this._onMouseMove, true);
|
|
|
|
this.game.canvas.removeEventListener('mouseup', this._onMouseUp, true);
|
2014-05-19 17:49:16 +00:00
|
|
|
this.game.canvas.removeEventListener('mouseover', this._onMouseOver, true);
|
2014-05-14 21:56:12 +00:00
|
|
|
this.game.canvas.removeEventListener('mouseout', this._onMouseOut, true);
|
2014-11-12 11:53:26 +00:00
|
|
|
|
2014-11-12 21:24:03 +00:00
|
|
|
var wheelEvent = this.game.device.wheelEvent;
|
|
|
|
if (wheelEvent)
|
|
|
|
{
|
|
|
|
this.game.canvas.removeEventListener(wheelEvent, this._onMouseWheel, true);
|
|
|
|
}
|
2013-08-31 12:54:59 +00:00
|
|
|
|
2014-09-04 22:29:43 +00:00
|
|
|
window.removeEventListener('mouseup', this._onMouseUpGlobal, true);
|
|
|
|
|
2014-08-28 02:31:47 +00:00
|
|
|
document.removeEventListener('pointerlockchange', this._pointerLockChange, true);
|
|
|
|
document.removeEventListener('mozpointerlockchange', this._pointerLockChange, true);
|
|
|
|
document.removeEventListener('webkitpointerlockchange', this._pointerLockChange, true);
|
|
|
|
|
2013-08-31 12:54:59 +00:00
|
|
|
}
|
|
|
|
|
2013-11-03 22:43:47 +00:00
|
|
|
};
|
2013-12-30 16:54:00 +00:00
|
|
|
|
|
|
|
Phaser.Mouse.prototype.constructor = Phaser.Mouse;
|
2014-10-27 00:25:03 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* If disabled all Mouse input will be ignored.
|
2014-10-29 04:46:33 +00:00
|
|
|
* @property {boolean} disabled
|
|
|
|
* @memberof Phaser.Mouse
|
2014-10-27 00:25:03 +00:00
|
|
|
* @default false
|
|
|
|
* @deprecated Use {@link Phaser.Mouse#enabled} instead
|
|
|
|
*/
|
|
|
|
Object.defineProperty(Phaser.Mouse.prototype, "disabled", {
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
return !this.enabled;
|
|
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
this.enabled = !value;
|
|
|
|
}
|
|
|
|
|
|
|
|
});
|
2014-11-12 11:53:26 +00:00
|
|
|
|
|
|
|
/* jshint latedef:nofunc */
|
|
|
|
/**
|
|
|
|
* A purely internal event support class to proxy 'wheelscroll' and 'DOMMouseWheel'
|
|
|
|
* events to 'wheel'-like events.
|
|
|
|
*
|
|
|
|
* See https://developer.mozilla.org/en-US/docs/Web/Events/mousewheel for choosing a scale and delta mode.
|
|
|
|
*
|
2014-11-25 00:20:41 +00:00
|
|
|
* @method Phaser.Mouse#WheelEventProxy
|
2014-11-12 11:53:26 +00:00
|
|
|
* @private
|
|
|
|
* @param {number} scaleFactor - Scale factor as applied to wheelDelta/wheelDeltaX or details.
|
2014-11-12 12:01:50 +00:00
|
|
|
* @param {integer} deltaMode - The reported delta mode.
|
2014-11-12 11:53:26 +00:00
|
|
|
*/
|
|
|
|
function WheelEventProxy (scaleFactor, deltaMode) {
|
|
|
|
|
2014-11-25 00:20:41 +00:00
|
|
|
/**
|
|
|
|
* @property {number} _scaleFactor - Scale factor as applied to wheelDelta/wheelDeltaX or details.
|
|
|
|
* @private
|
|
|
|
*/
|
2014-11-12 11:53:26 +00:00
|
|
|
this._scaleFactor = scaleFactor;
|
|
|
|
|
2014-11-25 00:20:41 +00:00
|
|
|
/**
|
|
|
|
* @property {number} _deltaMode - The reported delta mode.
|
|
|
|
* @private
|
|
|
|
*/
|
2014-11-12 11:53:26 +00:00
|
|
|
this._deltaMode = deltaMode;
|
|
|
|
|
|
|
|
/**
|
2014-11-25 00:20:41 +00:00
|
|
|
* @property {any} originalEvent - The original event _currently_ being proxied; the getters will follow suit.
|
|
|
|
* @private
|
2014-11-12 11:53:26 +00:00
|
|
|
*/
|
|
|
|
this.originalEvent = null;
|
|
|
|
}
|
|
|
|
|
|
|
|
WheelEventProxy.prototype = {};
|
|
|
|
WheelEventProxy.prototype.constructor = WheelEventProxy;
|
|
|
|
|
|
|
|
WheelEventProxy.prototype.bindEvent = function (event) {
|
|
|
|
|
|
|
|
// Generate stubs automatically
|
|
|
|
if (!WheelEventProxy._stubsGenerated && event)
|
|
|
|
{
|
|
|
|
var makeBinder = function (name) {
|
2014-11-25 00:20:41 +00:00
|
|
|
|
2014-11-12 11:53:26 +00:00
|
|
|
return function () {
|
|
|
|
var v = this.originalEvent[name];
|
|
|
|
return typeof v !== 'function' ? v : v.bind(this.originalEvent);
|
|
|
|
};
|
2014-11-25 00:20:41 +00:00
|
|
|
|
2014-11-12 11:53:26 +00:00
|
|
|
};
|
2014-11-25 00:20:41 +00:00
|
|
|
|
|
|
|
for (var prop in event)
|
|
|
|
{
|
2014-11-12 11:53:26 +00:00
|
|
|
if (!(prop in WheelEventProxy.prototype))
|
|
|
|
{
|
|
|
|
Object.defineProperty(WheelEventProxy.prototype, prop, {
|
|
|
|
get: makeBinder(prop)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
WheelEventProxy._stubsGenerated = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
this.originalEvent = event;
|
|
|
|
return this;
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
Object.defineProperties(WheelEventProxy.prototype, {
|
|
|
|
"type": { value: "wheel" },
|
|
|
|
"deltaMode": { get: function () { return this._deltaMode; } },
|
|
|
|
"deltaY": {
|
|
|
|
get: function () {
|
2014-11-12 21:24:03 +00:00
|
|
|
return (this._scaleFactor * (this.originalEvent.wheelDelta || this.originalEvent.detail)) || 0;
|
2014-11-12 11:53:26 +00:00
|
|
|
}
|
|
|
|
},
|
|
|
|
"deltaX": {
|
|
|
|
get: function () {
|
2014-11-12 21:24:03 +00:00
|
|
|
return (this._scaleFactor * this.originalEvent.wheelDeltaX) || 0;
|
2014-11-12 11:53:26 +00:00
|
|
|
}
|
|
|
|
},
|
2014-11-12 12:01:50 +00:00
|
|
|
"deltaZ": { value: 0 }
|
2014-11-12 11:53:26 +00:00
|
|
|
});
|