Native support for wheel events

This commit is contained in:
Richard Davey 2019-06-05 15:31:13 +01:00
parent 62cb5c68a8
commit 98be6adfda
3 changed files with 108 additions and 4 deletions

View file

@ -756,6 +756,22 @@ var InputManager = new Class({
this.updateInputPlugins(CONST.MOUSE_UP, this.mousePointerContainer); this.updateInputPlugins(CONST.MOUSE_UP, this.mousePointerContainer);
}, },
/**
* Processes a mouse wheel event, as passed in by the MouseManager.
*
* @method Phaser.Input.InputManager#onMouseWheel
* @private
* @since 3.18.0
*
* @param {WheelEvent} event - The native DOM Wheel event.
*/
onMouseWheel: function (event)
{
this.mousePointer.wheel(event);
this.updateInputPlugins(CONST.MOUSE_WHEEL, this.mousePointerContainer);
},
/** /**
* Checks if the given Game Object should be considered as a candidate for input or not. * Checks if the given Game Object should be considered as a candidate for input or not.
* *

View file

@ -609,10 +609,7 @@ var InputPlugin = new Class({
} }
} }
if (pointersTotal < 3 || !pointer.wasTouch) total += this.processOverOutEvents(pointer);
{
total += this.processOverOutEvents(pointer);
}
this.processDragThresholdEvent(pointer); this.processDragThresholdEvent(pointer);
@ -711,6 +708,10 @@ var InputPlugin = new Class({
total += this.processMoveEvents(pointer); total += this.processMoveEvents(pointer);
total += this.processOverOutEvents(pointer); total += this.processOverOutEvents(pointer);
break; break;
case CONST.MOUSE_WHEEL:
total += this.processWheelEvent(pointer);
break;
} }
if (total > 0) if (total > 0)
@ -1433,6 +1434,73 @@ var InputPlugin = new Class({
return total; return total;
}, },
/**
* An internal method that handles a mouse wheel event.
*
* @method Phaser.Input.InputPlugin#processWheelEvent
* @private
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_WHEEL
* @fires Phaser.Input.Events#GAMEOBJECT_WHEEL
* @fires Phaser.Input.Events#POINTER_WHEEL
* @since 3.18.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to check for events against.
*
* @return {integer} The total number of objects interacted with.
*/
processWheelEvent: function (pointer)
{
var total = 0;
var currentlyOver = this._temp;
var _eventData = this._eventData;
var _eventContainer = this._eventContainer;
_eventData.cancelled = false;
var aborted = false;
var dx = pointer.deltaX;
var dy = pointer.deltaY;
var dz = pointer.deltaZ;
// Go through all objects the pointer was over and fire their events / callbacks
for (var i = 0; i < currentlyOver.length; i++)
{
var gameObject = currentlyOver[i];
if (!gameObject.input)
{
continue;
}
total++;
gameObject.emit(Events.GAMEOBJECT_POINTER_WHEEL, pointer, dx, dy, dz, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
this.emit(Events.GAMEOBJECT_WHEEL, pointer, gameObject, dx, dy, dz, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
}
if (!aborted)
{
this.emit(Events.POINTER_WHEEL, pointer, currentlyOver, dx, dy, dz);
}
return total;
},
/** /**
* An internal method that handles the Pointer over events. * An internal method that handles the Pointer over events.
* This is called when a touch input hits the canvas, having previously been off of it. * This is called when a touch input hits the canvas, having previously been off of it.

View file

@ -160,6 +160,17 @@ var MouseManager = new Class({
*/ */
this.onMouseOut = NOOP; this.onMouseOut = NOOP;
/**
* The Mouse Wheel Event handler.
* This function is sent the native DOM MouseEvent.
* Initially empty and bound in the `startListeners` method.
*
* @name Phaser.Input.Mouse.MouseManager#onMouseWheel
* @type {function}
* @since 3.18.0
*/
this.onMouseWheel = NOOP;
/** /**
* Internal pointerLockChange handler. * Internal pointerLockChange handler.
* This function is sent the native DOM MouseEvent. * This function is sent the native DOM MouseEvent.
@ -364,6 +375,14 @@ var MouseManager = new Class({
} }
}; };
this.onMouseWheel = function (event)
{
if (!event.defaultPrevented && _this.enabled && _this.manager && _this.manager.enabled)
{
_this.manager.onMouseWheel(event);
}
};
var target = this.target; var target = this.target;
if (!target) if (!target)
@ -379,6 +398,7 @@ var MouseManager = new Class({
target.addEventListener('mouseup', this.onMouseUp, (this.capture) ? nonPassive : passive); target.addEventListener('mouseup', this.onMouseUp, (this.capture) ? nonPassive : passive);
target.addEventListener('mouseover', this.onMouseOver, (this.capture) ? nonPassive : passive); target.addEventListener('mouseover', this.onMouseOver, (this.capture) ? nonPassive : passive);
target.addEventListener('mouseout', this.onMouseOut, (this.capture) ? nonPassive : passive); target.addEventListener('mouseout', this.onMouseOut, (this.capture) ? nonPassive : passive);
target.addEventListener('wheel', this.onMouseWheel, (this.capture) ? nonPassive : passive);
if (window && this.manager.game.config.inputWindowEvents) if (window && this.manager.game.config.inputWindowEvents)
{ {