mirror of
https://github.com/photonstorm/phaser
synced 2024-12-23 11:33:28 +00:00
315 lines
9.3 KiB
JavaScript
315 lines
9.3 KiB
JavaScript
/**
|
|
* @author Richard Davey <rich@phaser.io>
|
|
* @copyright 2013-2024 Phaser Studio Inc.
|
|
* @license {@link https://opensource.org/licenses/MIT|MIT License}
|
|
*/
|
|
|
|
var BlendModes = require('../../renderer/BlendModes');
|
|
var Circle = require('../../geom/circle/Circle');
|
|
var CircleContains = require('../../geom/circle/Contains');
|
|
var Class = require('../../utils/Class');
|
|
var Components = require('../components');
|
|
var GameObject = require('../GameObject');
|
|
var Rectangle = require('../../geom/rectangle/Rectangle');
|
|
var RectangleContains = require('../../geom/rectangle/Contains');
|
|
|
|
/**
|
|
* @classdesc
|
|
* A Zone Game Object.
|
|
*
|
|
* A Zone is a non-rendering rectangular Game Object that has a position and size.
|
|
* It has no texture and never displays, but does live on the display list and
|
|
* can be moved, scaled and rotated like any other Game Object.
|
|
*
|
|
* Its primary use is for creating Drop Zones and Input Hit Areas and it has a couple of helper methods
|
|
* specifically for this. It is also useful for object overlap checks, or as a base for your own
|
|
* non-displaying Game Objects.
|
|
|
|
* The default origin is 0.5, the center of the Zone, the same as with Game Objects.
|
|
*
|
|
* @class Zone
|
|
* @extends Phaser.GameObjects.GameObject
|
|
* @memberof Phaser.GameObjects
|
|
* @constructor
|
|
* @since 3.0.0
|
|
*
|
|
* @extends Phaser.GameObjects.Components.Depth
|
|
* @extends Phaser.GameObjects.Components.GetBounds
|
|
* @extends Phaser.GameObjects.Components.Origin
|
|
* @extends Phaser.GameObjects.Components.Transform
|
|
* @extends Phaser.GameObjects.Components.ScrollFactor
|
|
* @extends Phaser.GameObjects.Components.Visible
|
|
*
|
|
* @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.
|
|
* @param {number} x - The horizontal position of this Game Object in the world.
|
|
* @param {number} y - The vertical position of this Game Object in the world.
|
|
* @param {number} [width=1] - The width of the Game Object.
|
|
* @param {number} [height=1] - The height of the Game Object.
|
|
*/
|
|
var Zone = new Class({
|
|
|
|
Extends: GameObject,
|
|
|
|
Mixins: [
|
|
Components.Depth,
|
|
Components.GetBounds,
|
|
Components.Origin,
|
|
Components.Transform,
|
|
Components.ScrollFactor,
|
|
Components.Visible
|
|
],
|
|
|
|
initialize:
|
|
|
|
function Zone (scene, x, y, width, height)
|
|
{
|
|
if (width === undefined) { width = 1; }
|
|
if (height === undefined) { height = width; }
|
|
|
|
GameObject.call(this, scene, 'Zone');
|
|
|
|
this.setPosition(x, y);
|
|
|
|
/**
|
|
* The native (un-scaled) width of this Game Object.
|
|
*
|
|
* @name Phaser.GameObjects.Zone#width
|
|
* @type {number}
|
|
* @since 3.0.0
|
|
*/
|
|
this.width = width;
|
|
|
|
/**
|
|
* The native (un-scaled) height of this Game Object.
|
|
*
|
|
* @name Phaser.GameObjects.Zone#height
|
|
* @type {number}
|
|
* @since 3.0.0
|
|
*/
|
|
this.height = height;
|
|
|
|
/**
|
|
* The Blend Mode of the Game Object.
|
|
* Although a Zone never renders, it still has a blend mode to allow it to fit seamlessly into
|
|
* display lists without causing a batch flush.
|
|
*
|
|
* @name Phaser.GameObjects.Zone#blendMode
|
|
* @type {number}
|
|
* @since 3.0.0
|
|
*/
|
|
this.blendMode = BlendModes.NORMAL;
|
|
|
|
this.updateDisplayOrigin();
|
|
},
|
|
|
|
/**
|
|
* The displayed width of this Game Object.
|
|
* This value takes into account the scale factor.
|
|
*
|
|
* @name Phaser.GameObjects.Zone#displayWidth
|
|
* @type {number}
|
|
* @since 3.0.0
|
|
*/
|
|
displayWidth: {
|
|
|
|
get: function ()
|
|
{
|
|
return this.scaleX * this.width;
|
|
},
|
|
|
|
set: function (value)
|
|
{
|
|
this.scaleX = value / this.width;
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* The displayed height of this Game Object.
|
|
* This value takes into account the scale factor.
|
|
*
|
|
* @name Phaser.GameObjects.Zone#displayHeight
|
|
* @type {number}
|
|
* @since 3.0.0
|
|
*/
|
|
displayHeight: {
|
|
|
|
get: function ()
|
|
{
|
|
return this.scaleY * this.height;
|
|
},
|
|
|
|
set: function (value)
|
|
{
|
|
this.scaleY = value / this.height;
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Sets the size of this Game Object.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setSize
|
|
* @since 3.0.0
|
|
*
|
|
* @param {number} width - The width of this Game Object.
|
|
* @param {number} height - The height of this Game Object.
|
|
* @param {boolean} [resizeInput=true] - If this Zone has a Rectangle for a hit area this argument will resize the hit area as well.
|
|
*
|
|
* @return {this} This Game Object.
|
|
*/
|
|
setSize: function (width, height, resizeInput)
|
|
{
|
|
if (resizeInput === undefined) { resizeInput = true; }
|
|
|
|
this.width = width;
|
|
this.height = height;
|
|
|
|
this.updateDisplayOrigin();
|
|
|
|
var input = this.input;
|
|
|
|
if (resizeInput && input && !input.customHitArea)
|
|
{
|
|
input.hitArea.width = width;
|
|
input.hitArea.height = height;
|
|
}
|
|
|
|
return this;
|
|
},
|
|
|
|
/**
|
|
* Sets the display size of this Game Object.
|
|
* Calling this will adjust the scale.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setDisplaySize
|
|
* @since 3.0.0
|
|
*
|
|
* @param {number} width - The width of this Game Object.
|
|
* @param {number} height - The height of this Game Object.
|
|
*
|
|
* @return {this} This Game Object.
|
|
*/
|
|
setDisplaySize: function (width, height)
|
|
{
|
|
this.displayWidth = width;
|
|
this.displayHeight = height;
|
|
|
|
return this;
|
|
},
|
|
|
|
/**
|
|
* Sets this Zone to be a Circular Drop Zone.
|
|
* The circle is centered on this Zones `x` and `y` coordinates.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setCircleDropZone
|
|
* @since 3.0.0
|
|
*
|
|
* @param {number} radius - The radius of the Circle that will form the Drop Zone.
|
|
*
|
|
* @return {this} This Game Object.
|
|
*/
|
|
setCircleDropZone: function (radius)
|
|
{
|
|
return this.setDropZone(new Circle(0, 0, radius), CircleContains);
|
|
},
|
|
|
|
/**
|
|
* Sets this Zone to be a Rectangle Drop Zone.
|
|
* The rectangle is centered on this Zones `x` and `y` coordinates.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setRectangleDropZone
|
|
* @since 3.0.0
|
|
*
|
|
* @param {number} width - The width of the rectangle drop zone.
|
|
* @param {number} height - The height of the rectangle drop zone.
|
|
*
|
|
* @return {this} This Game Object.
|
|
*/
|
|
setRectangleDropZone: function (width, height)
|
|
{
|
|
return this.setDropZone(new Rectangle(0, 0, width, height), RectangleContains);
|
|
},
|
|
|
|
/**
|
|
* Allows you to define your own Geometry shape to be used as a Drop Zone.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setDropZone
|
|
* @since 3.0.0
|
|
*
|
|
* @param {object} [hitArea] - A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape. If not given it will try to create a Rectangle based on the size of this zone.
|
|
* @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - A function that will return `true` if the given x/y coords it is sent are within the shape. If you provide a shape you must also provide a callback.
|
|
*
|
|
* @return {this} This Game Object.
|
|
*/
|
|
setDropZone: function (hitArea, hitAreaCallback)
|
|
{
|
|
if (!this.input)
|
|
{
|
|
this.setInteractive(hitArea, hitAreaCallback, true);
|
|
}
|
|
|
|
return this;
|
|
},
|
|
|
|
/**
|
|
* A NOOP method so you can pass a Zone to a Container.
|
|
* Calling this method will do nothing. It is intentionally empty.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setAlpha
|
|
* @private
|
|
* @since 3.11.0
|
|
*/
|
|
setAlpha: function ()
|
|
{
|
|
},
|
|
|
|
/**
|
|
* A NOOP method so you can pass a Zone to a Container in Canvas.
|
|
* Calling this method will do nothing. It is intentionally empty.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#setBlendMode
|
|
* @private
|
|
* @since 3.16.2
|
|
*/
|
|
setBlendMode: function ()
|
|
{
|
|
},
|
|
|
|
/**
|
|
* A Zone does not render.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#renderCanvas
|
|
* @private
|
|
* @since 3.53.0
|
|
*
|
|
* @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - A reference to the current active Canvas renderer.
|
|
* @param {Phaser.GameObjects.Image} src - The Game Object being rendered in this call.
|
|
* @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object.
|
|
* @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - This transform matrix is defined if the game object is nested
|
|
*/
|
|
renderCanvas: function (renderer, src, camera)
|
|
{
|
|
camera.addToRenderList(src);
|
|
},
|
|
|
|
/**
|
|
* A Zone does not render.
|
|
*
|
|
* @method Phaser.GameObjects.Zone#renderWebGL
|
|
* @private
|
|
* @since 3.53.0
|
|
*
|
|
* @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.
|
|
* @param {Phaser.GameObjects.Image} src - The Game Object being rendered in this call.
|
|
* @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object.
|
|
* @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - This transform matrix is defined if the game object is nested
|
|
*/
|
|
renderWebGL: function (renderer, src, camera)
|
|
{
|
|
camera.addToRenderList(src);
|
|
}
|
|
|
|
});
|
|
|
|
module.exports = Zone;
|