2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-23 03:23:42 +00:00
phaser/wip/geom/Rectangle.js

1056 lines
35 KiB
JavaScript
Raw Normal View History

2013-10-01 12:54:29 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2016-04-04 21:15:01 +00:00
* @copyright 2016 Photon Storm Ltd.
2013-10-01 12:54:29 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters.
* If you call this function without parameters, a Rectangle with x, y, width, and height properties set to 0 is created.
2013-08-28 18:18:34 +00:00
*
2013-10-01 12:54:29 +00:00
* @class Phaser.Rectangle
* @constructor
2013-10-01 12:54:29 +00:00
* @param {number} x - The x coordinate of the top-left corner of the Rectangle.
* @param {number} y - The y coordinate of the top-left corner of the Rectangle.
2014-07-01 21:10:13 +00:00
* @param {number} width - The width of the Rectangle. Should always be either zero or a positive value.
* @param {number} height - The height of the Rectangle. Should always be either zero or a positive value.
*/
Phaser.Rectangle = function (x, y, width, height) {
x = x || 0;
y = y || 0;
width = width || 0;
height = height || 0;
/**
* @property {number} x - The x coordinate of the top-left corner of the Rectangle.
2013-10-01 12:54:29 +00:00
*/
this.x = x;
2014-03-23 07:59:28 +00:00
/**
* @property {number} y - The y coordinate of the top-left corner of the Rectangle.
2013-10-01 12:54:29 +00:00
*/
this.y = y;
2014-03-23 07:59:28 +00:00
/**
2014-07-01 21:10:13 +00:00
* @property {number} width - The width of the Rectangle. This value should never be set to a negative.
2013-10-01 12:54:29 +00:00
*/
this.width = width;
2014-03-23 07:59:28 +00:00
/**
2014-07-01 21:10:13 +00:00
* @property {number} height - The height of the Rectangle. This value should never be set to a negative.
2013-10-01 12:54:29 +00:00
*/
this.height = height;
2015-02-17 16:38:07 +00:00
/**
* @property {number} type - The const type of this object.
* @readonly
*/
this.type = Phaser.RECTANGLE;
};
Phaser.Rectangle.prototype.constructor = Phaser.Rectangle;
Phaser.Rectangle.prototype = {
/**
* Adjusts the location of the Rectangle object, as determined by its top-left corner, by the specified amounts.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#offset
2013-10-01 12:54:29 +00:00
* @param {number} dx - Moves the x value of the Rectangle object by this amount.
* @param {number} dy - Moves the y value of the Rectangle object by this amount.
* @return {Phaser.Rectangle} This Rectangle object.
*/
offset: function (dx, dy) {
this.x += dx;
this.y += dy;
return this;
},
2014-03-23 07:59:28 +00:00
/**
* Adjusts the location of the Rectangle object using a Point object as a parameter. This method is similar to the Rectangle.offset() method, except that it takes a Point object as a parameter.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#offsetPoint
* @param {Phaser.Point} point - A Point object to use to offset this Rectangle object.
* @return {Phaser.Rectangle} This Rectangle object.
*/
offsetPoint: function (point) {
return this.offset(point.x, point.y);
},
2014-03-23 07:59:28 +00:00
/**
* Sets the members of Rectangle to the specified values.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#setTo
2013-10-01 12:54:29 +00:00
* @param {number} x - The x coordinate of the top-left corner of the Rectangle.
* @param {number} y - The y coordinate of the top-left corner of the Rectangle.
2014-07-01 21:10:13 +00:00
* @param {number} width - The width of the Rectangle. Should always be either zero or a positive value.
* @param {number} height - The height of the Rectangle. Should always be either zero or a positive value.
* @return {Phaser.Rectangle} This Rectangle object
*/
setTo: function (x, y, width, height) {
this.x = x;
this.y = y;
this.width = width;
this.height = height;
return this;
},
/**
* Scales the width and height of this Rectangle by the given amounts.
*
* @method Phaser.Rectangle#scale
* @param {number} x - The amount to scale the width of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the width, etc.
* @param {number} [y] - The amount to scale the height of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the height, etc.
* @return {Phaser.Rectangle} This Rectangle object
*/
scale: function (x, y) {
if (y === undefined) { y = x; }
this.width *= x;
this.height *= y;
return this;
},
/**
* Centers this Rectangle so that the center coordinates match the given x and y values.
*
* @method Phaser.Rectangle#centerOn
* @param {number} x - The x coordinate to place the center of the Rectangle at.
* @param {number} y - The y coordinate to place the center of the Rectangle at.
* @return {Phaser.Rectangle} This Rectangle object
*/
centerOn: function (x, y) {
this.centerX = x;
this.centerY = y;
return this;
},
/**
* Runs Math.floor() on both the x and y values of this Rectangle.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#floor
*/
floor: function () {
this.x = Math.floor(this.x);
this.y = Math.floor(this.y);
},
2014-03-23 07:59:28 +00:00
/**
* Runs Math.floor() on the x, y, width and height values of this Rectangle.
* @method Phaser.Rectangle#floorAll
*/
floorAll: function () {
this.x = Math.floor(this.x);
this.y = Math.floor(this.y);
this.width = Math.floor(this.width);
this.height = Math.floor(this.height);
},
/**
* Runs Math.ceil() on both the x and y values of this Rectangle.
* @method Phaser.Rectangle#ceil
*/
ceil: function () {
this.x = Math.ceil(this.x);
this.y = Math.ceil(this.y);
},
/**
* Runs Math.ceil() on the x, y, width and height values of this Rectangle.
* @method Phaser.Rectangle#ceilAll
*/
ceilAll: function () {
this.x = Math.ceil(this.x);
this.y = Math.ceil(this.y);
this.width = Math.ceil(this.width);
this.height = Math.ceil(this.height);
},
/**
* Copies the x, y, width and height properties from any given object to this Rectangle.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#copyFrom
* @param {any} source - The object to copy from.
* @return {Phaser.Rectangle} This Rectangle object.
*/
copyFrom: function (source) {
return this.setTo(source.x, source.y, source.width, source.height);
},
/**
* Copies the x, y, width and height properties from this Rectangle to any given object.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#copyTo
* @param {any} source - The object to copy to.
* @return {object} This object.
*/
copyTo: function (dest) {
dest.x = this.x;
dest.y = this.y;
dest.width = this.width;
dest.height = this.height;
return dest;
},
2013-08-28 18:18:34 +00:00
/**
* Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#inflate
2013-10-01 12:54:29 +00:00
* @param {number} dx - The amount to be added to the left side of the Rectangle.
* @param {number} dy - The amount to be added to the bottom side of the Rectangle.
2013-08-28 18:18:34 +00:00
* @return {Phaser.Rectangle} This Rectangle object.
*/
inflate: function (dx, dy) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.inflate(this, dx, dy);
2013-08-28 18:18:34 +00:00
},
/**
* The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#size
2013-10-01 12:54:29 +00:00
* @param {Phaser.Point} [output] - Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.
* @return {Phaser.Point} The size of the Rectangle object.
2013-08-28 18:18:34 +00:00
*/
size: function (output) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.size(this, output);
},
2013-08-28 18:18:34 +00:00
/**
* Resize the Rectangle by providing a new width and height.
* The x and y positions remain unchanged.
*
* @method Phaser.Rectangle#resize
* @param {number} width - The width of the Rectangle. Should always be either zero or a positive value.
* @param {number} height - The height of the Rectangle. Should always be either zero or a positive value.
* @return {Phaser.Rectangle} This Rectangle object
*/
resize: function (width, height) {
this.width = width;
this.height = height;
return this;
},
2013-08-28 18:18:34 +00:00
/**
* Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#clone
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} [output] - Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.
2014-03-23 07:59:28 +00:00
* @return {Phaser.Rectangle}
2013-08-28 18:18:34 +00:00
*/
clone: function (output) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.clone(this, output);
2013-08-28 18:18:34 +00:00
},
/**
* Determines whether the specified coordinates are contained within the region defined by this Rectangle object.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#contains
2013-10-01 12:54:29 +00:00
* @param {number} x - The x coordinate of the point to test.
* @param {number} y - The y coordinate of the point to test.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the Rectangle object contains the specified point; otherwise false.
2013-08-28 18:18:34 +00:00
*/
contains: function (x, y) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.contains(this, x, y);
2013-08-28 18:18:34 +00:00
},
/**
* Determines whether the first Rectangle object is fully contained within the second Rectangle object.
* A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#containsRect
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} b - The second Rectangle object.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the Rectangle object contains the specified point; otherwise false.
2013-08-28 18:18:34 +00:00
*/
containsRect: function (b) {
return Phaser.Rectangle.containsRect(b, this);
2013-08-28 18:18:34 +00:00
},
/**
* Determines whether the two Rectangles are equal.
* This method compares the x, y, width and height properties of each Rectangle.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#equals
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} b - The second Rectangle object.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false.
2013-08-28 18:18:34 +00:00
*/
equals: function (b) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.equals(this, b);
2013-08-28 18:18:34 +00:00
},
/**
* If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#intersection
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} b - The second Rectangle object.
* @param {Phaser.Rectangle} out - Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
2013-08-28 18:18:34 +00:00
* @return {Phaser.Rectangle} A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0.
*/
intersection: function (b, out) {
return Phaser.Rectangle.intersection(this, b, out);
2013-08-28 18:18:34 +00:00
},
/**
* Determines whether this Rectangle and another given Rectangle intersect with each other.
* This method checks the x, y, width, and height properties of the two Rectangles.
*
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#intersects
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} b - The second Rectangle object.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the specified object intersects with this Rectangle object; otherwise false.
2013-08-28 18:18:34 +00:00
*/
intersects: function (b) {
return Phaser.Rectangle.intersects(this, b);
2013-08-28 18:18:34 +00:00
},
/**
2014-07-01 21:10:13 +00:00
* Determines whether the coordinates given intersects (overlaps) with this Rectangle.
*
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#intersectsRaw
2014-07-01 21:10:13 +00:00
* @param {number} left - The x coordinate of the left of the area.
* @param {number} right - The right coordinate of the area.
* @param {number} top - The y coordinate of the area.
* @param {number} bottom - The bottom coordinate of the area.
2013-10-01 12:54:29 +00:00
* @param {number} tolerance - A tolerance value to allow for an intersection test with padding, default to 0
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the specified object intersects with the Rectangle; otherwise false.
2013-08-28 18:18:34 +00:00
*/
intersectsRaw: function (left, right, top, bottom, tolerance) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.intersectsRaw(this, left, right, top, bottom, tolerance);
2013-08-28 18:18:34 +00:00
},
/**
* Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#union
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} b - The second Rectangle object.
* @param {Phaser.Rectangle} [out] - Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
2013-08-28 18:18:34 +00:00
* @return {Phaser.Rectangle} A Rectangle object that is the union of the two Rectangles.
*/
union: function (b, out) {
2013-08-28 18:18:34 +00:00
return Phaser.Rectangle.union(this, b, out);
2013-08-28 18:18:34 +00:00
},
/**
* Returns a uniformly distributed random point from anywhere within this Rectangle.
*
* @method Phaser.Rectangle#random
* @param {Phaser.Point|object} [out] - A Phaser.Point, or any object with public x/y properties, that the values will be set in.
* If no object is provided a new Phaser.Point object will be created. In high performance areas avoid this by re-using an existing object.
* @return {Phaser.Point} An object containing the random point in its `x` and `y` properties.
*/
random: function (out) {
if (out === undefined) { out = new Phaser.Point(); }
out.x = this.randomX;
out.y = this.randomY;
return out;
},
/**
* Returns a point based on the given position constant, which can be one of:
*
* `Phaser.TOP_LEFT`, `Phaser.TOP_CENTER`, `Phaser.TOP_RIGHT`, `Phaser.LEFT_CENTER`,
* `Phaser.CENTER`, `Phaser.RIGHT_CENTER`, `Phaser.BOTTOM_LEFT`, `Phaser.BOTTOM_CENTER`
* and `Phaser.BOTTOM_RIGHT`.
*
* This method returns the same values as calling Rectangle.bottomLeft, etc, but those
* calls always create a new Point object, where-as this one allows you to use your own.
*
* @method Phaser.Rectangle#getPoint
* @param {integer} [position] - One of the Phaser position constants, such as `Phaser.TOP_RIGHT`.
* @param {Phaser.Point} [out] - A Phaser.Point that the values will be set in.
* If no object is provided a new Phaser.Point object will be created. In high performance areas avoid this by re-using an existing object.
* @return {Phaser.Point} An object containing the point in its `x` and `y` properties.
*/
getPoint: function (position, out) {
if (out === undefined) { out = new Phaser.Point(); }
switch (position)
{
default:
case Phaser.TOP_LEFT:
return out.set(this.x, this.y);
case Phaser.TOP_CENTER:
return out.set(this.centerX, this.y);
case Phaser.TOP_RIGHT:
return out.set(this.right, this.y);
case Phaser.LEFT_CENTER:
return out.set(this.x, this.centerY);
case Phaser.CENTER:
return out.set(this.centerX, this.centerY);
case Phaser.RIGHT_CENTER:
return out.set(this.right, this.centerY);
case Phaser.BOTTOM_LEFT:
return out.set(this.x, this.bottom);
case Phaser.BOTTOM_CENTER:
return out.set(this.centerX, this.bottom);
case Phaser.BOTTOM_RIGHT:
return out.set(this.right, this.bottom);
}
},
/**
* Returns a string representation of this object.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle#toString
2013-10-01 12:54:29 +00:00
* @return {string} A string representation of the instance.
*/
toString: function () {
return "[{Rectangle (x=" + this.x + " y=" + this.y + " width=" + this.width + " height=" + this.height + " empty=" + this.empty + ")}]";
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
};
/**
* @name Phaser.Rectangle#halfWidth
* @property {number} halfWidth - Half of the width of the Rectangle.
* @readonly
*/
Object.defineProperty(Phaser.Rectangle.prototype, "halfWidth", {
2014-03-13 16:49:52 +00:00
get: function () {
return Math.round(this.width / 2);
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* @name Phaser.Rectangle#halfHeight
* @property {number} halfHeight - Half of the height of the Rectangle.
* @readonly
*/
Object.defineProperty(Phaser.Rectangle.prototype, "halfHeight", {
2014-03-13 16:49:52 +00:00
get: function () {
return Math.round(this.height / 2);
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
* @name Phaser.Rectangle#bottom
* @property {number} bottom - The sum of the y and height properties.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "bottom", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.y + this.height;
},
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
set: function (value) {
if (value <= this.y)
{
this.height = 0;
}
else
{
this.height = value - this.y;
}
}
});
/**
* The location of the Rectangles bottom left corner as a Point object.
* @name Phaser.Rectangle#bottomLeft
* @property {Phaser.Point} bottomLeft - Gets or sets the location of the Rectangles bottom left corner as a Point object.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "bottomLeft", {
get: function () {
return new Phaser.Point(this.x, this.bottom);
},
set: function (value) {
this.x = value.x;
this.bottom = value.y;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The location of the Rectangles bottom right corner as a Point object.
* @name Phaser.Rectangle#bottomRight
2014-03-13 16:49:52 +00:00
* @property {Phaser.Point} bottomRight - Gets or sets the location of the Rectangles bottom right corner as a Point object.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "bottomRight", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return new Phaser.Point(this.right, this.bottom);
},
2014-03-13 16:49:52 +00:00
set: function (value) {
this.right = value.x;
this.bottom = value.y;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The x coordinate of the left of the Rectangle. Changing the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.
* @name Phaser.Rectangle#left
* @property {number} left - The x coordinate of the left of the Rectangle.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "left", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.x;
},
2014-03-13 16:49:52 +00:00
set: function (value) {
if (value >= this.right) {
this.width = 0;
2014-03-13 16:49:52 +00:00
} else {
this.width = this.right - value;
}
this.x = value;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.
* @name Phaser.Rectangle#right
* @property {number} right - The sum of the x and width properties.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "right", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.x + this.width;
},
2014-03-13 16:49:52 +00:00
set: function (value) {
if (value <= this.x) {
this.width = 0;
2014-03-13 16:49:52 +00:00
} else {
this.width = value - this.x;
}
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The volume of the Rectangle derived from width * height.
* @name Phaser.Rectangle#volume
* @property {number} volume - The volume of the Rectangle derived from width * height.
* @readonly
*/
Object.defineProperty(Phaser.Rectangle.prototype, "volume", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.width * this.height;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The perimeter size of the Rectangle. This is the sum of all 4 sides.
* @name Phaser.Rectangle#perimeter
* @property {number} perimeter - The perimeter size of the Rectangle. This is the sum of all 4 sides.
* @readonly
*/
Object.defineProperty(Phaser.Rectangle.prototype, "perimeter", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return (this.width * 2) + (this.height * 2);
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The x coordinate of the center of the Rectangle.
* @name Phaser.Rectangle#centerX
* @property {number} centerX - The x coordinate of the center of the Rectangle.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "centerX", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.x + this.halfWidth;
},
2014-03-13 16:49:52 +00:00
set: function (value) {
this.x = value - this.halfWidth;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The y coordinate of the center of the Rectangle.
* @name Phaser.Rectangle#centerY
* @property {number} centerY - The y coordinate of the center of the Rectangle.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "centerY", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.y + this.halfHeight;
},
2014-03-13 16:49:52 +00:00
set: function (value) {
this.y = value - this.halfHeight;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
/**
* A random value between the left and right values (inclusive) of the Rectangle.
*
* @name Phaser.Rectangle#randomX
* @property {number} randomX - A random value between the left and right values (inclusive) of the Rectangle.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "randomX", {
get: function () {
return this.x + (Math.random() * this.width);
}
});
/**
* A random value between the top and bottom values (inclusive) of the Rectangle.
*
* @name Phaser.Rectangle#randomY
* @property {number} randomY - A random value between the top and bottom values (inclusive) of the Rectangle.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "randomY", {
get: function () {
return this.y + (Math.random() * this.height);
}
});
2014-03-13 16:49:52 +00:00
/**
* The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.
* However it does affect the height property, whereas changing the y value does not affect the height property.
* @name Phaser.Rectangle#top
* @property {number} top - The y coordinate of the top of the Rectangle.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "top", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return this.y;
},
2014-03-13 16:49:52 +00:00
set: function (value) {
if (value >= this.bottom) {
this.height = 0;
this.y = value;
2014-03-13 16:49:52 +00:00
} else {
this.height = (this.bottom - value);
}
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
2014-03-13 16:49:52 +00:00
/**
* The location of the Rectangles top left corner as a Point object.
* @name Phaser.Rectangle#topLeft
* @property {Phaser.Point} topLeft - The location of the Rectangles top left corner as a Point object.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "topLeft", {
2014-03-13 16:49:52 +00:00
get: function () {
return new Phaser.Point(this.x, this.y);
},
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
set: function (value) {
this.x = value.x;
this.y = value.y;
2014-03-13 16:49:52 +00:00
}
2014-03-13 16:49:52 +00:00
});
/**
* The location of the Rectangles top right corner as a Point object.
* @name Phaser.Rectangle#topRight
* @property {Phaser.Point} topRight - The location of the Rectangles top left corner as a Point object.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "topRight", {
get: function () {
return new Phaser.Point(this.x + this.width, this.y);
},
set: function (value) {
this.right = value.x;
this.y = value.y;
}
});
2014-03-13 16:49:52 +00:00
/**
* Determines whether or not this Rectangle object is empty. A Rectangle object is empty if its width or height is less than or equal to 0.
2014-03-23 07:59:28 +00:00
* If set to true then all of the Rectangle properties are set to 0.
2014-03-13 16:49:52 +00:00
* @name Phaser.Rectangle#empty
* @property {boolean} empty - Gets or sets the Rectangles empty state.
*/
Object.defineProperty(Phaser.Rectangle.prototype, "empty", {
2014-03-23 07:59:28 +00:00
2014-03-13 16:49:52 +00:00
get: function () {
return (!this.width || !this.height);
},
2014-03-13 16:49:52 +00:00
set: function (value) {
if (value === true)
{
this.setTo(0, 0, 0, 0);
}
2014-03-23 07:59:28 +00:00
}
2014-03-13 16:49:52 +00:00
});
/**
* Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.inflate
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The Rectangle object.
2013-10-01 15:39:39 +00:00
* @param {number} dx - The amount to be added to the left side of the Rectangle.
* @param {number} dy - The amount to be added to the bottom side of the Rectangle.
* @return {Phaser.Rectangle} This Rectangle object.
*/
Phaser.Rectangle.inflate = function (a, dx, dy) {
a.x -= dx;
a.width += 2 * dx;
a.y -= dy;
a.height += 2 * dy;
return a;
};
/**
* Increases the size of the Rectangle object. This method is similar to the Rectangle.inflate() method except it takes a Point object as a parameter.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.inflatePoint
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The Rectangle object.
* @param {Phaser.Point} point - The x property of this Point object is used to increase the horizontal dimension of the Rectangle object. The y property is used to increase the vertical dimension of the Rectangle object.
* @return {Phaser.Rectangle} The Rectangle object.
*/
Phaser.Rectangle.inflatePoint = function (a, point) {
2013-10-24 20:21:00 +00:00
return Phaser.Rectangle.inflate(a, point.x, point.y);
};
/**
* The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.size
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The Rectangle object.
* @param {Phaser.Point} [output] - Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.
* @return {Phaser.Point} The size of the Rectangle object
*/
Phaser.Rectangle.size = function (a, output) {
if (output === undefined || output === null)
{
output = new Phaser.Point(a.width, a.height);
}
else
{
output.setTo(a.width, a.height);
}
return output;
};
/**
* Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.clone
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The Rectangle object.
* @param {Phaser.Rectangle} [output] - Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.
* @return {Phaser.Rectangle}
*/
Phaser.Rectangle.clone = function (a, output) {
if (output === undefined || output === null)
{
output = new Phaser.Rectangle(a.x, a.y, a.width, a.height);
}
else
{
output.setTo(a.x, a.y, a.width, a.height);
}
return output;
};
/**
* Determines whether the specified coordinates are contained within the region defined by this Rectangle object.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.contains
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The Rectangle object.
* @param {number} x - The x coordinate of the point to test.
* @param {number} y - The y coordinate of the point to test.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the Rectangle object contains the specified point; otherwise false.
*/
Phaser.Rectangle.contains = function (a, x, y) {
if (a.width <= 0 || a.height <= 0)
{
return false;
}
2014-10-20 13:28:03 +00:00
return (x >= a.x && x < a.right && y >= a.y && y < a.bottom);
};
/**
* Determines whether the specified coordinates are contained within the region defined by the given raw values.
* @method Phaser.Rectangle.containsRaw
* @param {number} rx - The x coordinate of the top left of the area.
* @param {number} ry - The y coordinate of the top left of the area.
* @param {number} rw - The width of the area.
* @param {number} rh - The height of the area.
* @param {number} x - The x coordinate of the point to test.
* @param {number} y - The y coordinate of the point to test.
* @return {boolean} A value of true if the Rectangle object contains the specified point; otherwise false.
*/
2013-10-24 20:21:00 +00:00
Phaser.Rectangle.containsRaw = function (rx, ry, rw, rh, x, y) {
2014-10-20 13:28:03 +00:00
return (x >= rx && x < (rx + rw) && y >= ry && y < (ry + rh));
2013-10-24 20:21:00 +00:00
};
/**
* Determines whether the specified point is contained within the rectangular region defined by this Rectangle object. This method is similar to the Rectangle.contains() method, except that it takes a Point object as a parameter.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.containsPoint
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The Rectangle object.
* @param {Phaser.Point} point - The point object being checked. Can be Point or any object with .x and .y values.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the Rectangle object contains the specified point; otherwise false.
*/
Phaser.Rectangle.containsPoint = function (a, point) {
2013-10-24 20:21:00 +00:00
return Phaser.Rectangle.contains(a, point.x, point.y);
};
/**
* Determines whether the first Rectangle object is fully contained within the second Rectangle object.
* A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.containsRect
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The first Rectangle object.
* @param {Phaser.Rectangle} b - The second Rectangle object.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the Rectangle object contains the specified point; otherwise false.
*/
Phaser.Rectangle.containsRect = function (a, b) {
// If the given rect has a larger volume than this one then it can never contain it
if (a.volume > b.volume)
{
return false;
}
2014-10-20 13:28:03 +00:00
return (a.x >= b.x && a.y >= b.y && a.right < b.right && a.bottom < b.bottom);
};
/**
* Determines whether the two Rectangles are equal.
* This method compares the x, y, width and height properties of each Rectangle.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.equals
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The first Rectangle object.
* @param {Phaser.Rectangle} b - The second Rectangle object.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false.
*/
Phaser.Rectangle.equals = function (a, b) {
2016-08-25 12:03:41 +00:00
return (a.x === b.x && a.y === b.y && a.width === b.width && a.height === b.height);
};
ScaleManager: additional cleanup - Added `compatibility` settings - CHANGE (2.1.2-4): moved `supportsFullScreen` and `noMargins` into it - Added additional properties for greater control and up-front settings. - `scrollTo`: where the browser will scrollTo, if anywhere - `forceMinimumDocumentHeight`: apply document element style? - `allowShowAllExpand`: allow SHOW_ALL to try to expand? (It already could, this allows configuration.) - Removed `windowConstraints.top/left`. This may be a feature in the future, but scrubbed for now. - Added `USER_SCALE` scale mode. This is like NO_SCALE but it scales off of a user-specified scale factor, as set by `setUserScale`. This is marked as "experimental" as the exactly semantics of non-adjusting modes (e.g. NO_SCALE and USER_SCALE) wrt. Canvas and "maximum" size clamps need to be re-examined. - FIX: `onSizeChange` now works as documented, which means it is also fired if the game size changes even though the game canvas size does not. - CHANGE (no known breaking): `margins` is now non-Point/non-Rectangle that uses top/left/bottom/right properties (any quasi-updated x/y). This is to get around the issue that Rectangle is only designed for positive width/height cases. - Cleaned up property access / quotes for consistency - Various documentation cleanup and consistency - Fixed issue with not clearing an unparented `_createdFullScreenTarget` - Added Phaser.Rectangle.sameDimensions which does a strict equality check over the `width` and `height` properties of two objects, perhaps Rectangles.
2014-11-09 00:38:21 +00:00
/**
* Determines if the two objects (either Rectangles or Rectangle-like) have the same width and height values under strict equality.
* @method Phaser.Rectangle.sameDimensions
* @param {Rectangle-like} a - The first Rectangle object.
* @param {Rectangle-like} b - The second Rectangle object.
* @return {boolean} True if the object have equivalent values for the width and height properties.
*/
Phaser.Rectangle.sameDimensions = function (a, b) {
return (a.width === b.width && a.height === b.height);
};
/**
* If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.intersection
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The first Rectangle object.
* @param {Phaser.Rectangle} b - The second Rectangle object.
* @param {Phaser.Rectangle} [output] - Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
* @return {Phaser.Rectangle} A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0.
*/
Phaser.Rectangle.intersection = function (a, b, output) {
if (output === undefined)
{
output = new Phaser.Rectangle();
}
if (Phaser.Rectangle.intersects(a, b))
{
output.x = Math.max(a.x, b.x);
output.y = Math.max(a.y, b.y);
output.width = Math.min(a.right, b.right) - output.x;
output.height = Math.min(a.bottom, b.bottom) - output.y;
}
return output;
};
/**
* Determines whether the two Rectangles intersect with each other.
* This method checks the x, y, width, and height properties of the Rectangles.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.intersects
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The first Rectangle object.
* @param {Phaser.Rectangle} b - The second Rectangle object.
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the specified object intersects with this Rectangle object; otherwise false.
*/
Phaser.Rectangle.intersects = function (a, b) {
if (a.width <= 0 || a.height <= 0 || b.width <= 0 || b.height <= 0)
{
return false;
}
return !(a.right < b.x || a.bottom < b.y || a.x > b.right || a.y > b.bottom);
};
/**
* Determines whether the object specified intersects (overlaps) with the given values.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.intersectsRaw
2014-07-01 21:10:13 +00:00
* @param {number} left - The x coordinate of the left of the area.
* @param {number} right - The right coordinate of the area.
* @param {number} top - The y coordinate of the area.
* @param {number} bottom - The bottom coordinate of the area.
2013-10-01 12:54:29 +00:00
* @param {number} tolerance - A tolerance value to allow for an intersection test with padding, default to 0
2013-10-01 15:39:39 +00:00
* @return {boolean} A value of true if the specified object intersects with the Rectangle; otherwise false.
*/
Phaser.Rectangle.intersectsRaw = function (a, left, right, top, bottom, tolerance) {
if (tolerance === undefined) { tolerance = 0; }
return !(left > a.right + tolerance || right < a.left - tolerance || top > a.bottom + tolerance || bottom < a.top - tolerance);
};
/**
* Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.
2013-10-02 11:11:22 +00:00
* @method Phaser.Rectangle.union
2013-10-01 12:54:29 +00:00
* @param {Phaser.Rectangle} a - The first Rectangle object.
* @param {Phaser.Rectangle} b - The second Rectangle object.
* @param {Phaser.Rectangle} [output] - Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
* @return {Phaser.Rectangle} A Rectangle object that is the union of the two Rectangles.
*/
Phaser.Rectangle.union = function (a, b, output) {
if (output === undefined)
{
output = new Phaser.Rectangle();
}
return output.setTo(Math.min(a.x, b.x), Math.min(a.y, b.y), Math.max(a.right, b.right) - Math.min(a.left, b.left), Math.max(a.bottom, b.bottom) - Math.min(a.top, b.top));
2014-03-23 07:59:28 +00:00
};
/**
* Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.
*
* @method Phaser.Rectangle#aabb
* @param {Phaser.Point[]} points - The array of one or more points.
* @param {Phaser.Rectangle} [out] - Optional Rectangle to store the value in, if not supplied a new Rectangle object will be created.
* @return {Phaser.Rectangle} The new Rectangle object.
* @static
*/
Phaser.Rectangle.aabb = function(points, out) {
if (out === undefined) {
out = new Phaser.Rectangle();
}
var xMax = Number.NEGATIVE_INFINITY,
xMin = Number.POSITIVE_INFINITY,
yMax = Number.NEGATIVE_INFINITY,
yMin = Number.POSITIVE_INFINITY;
points.forEach(function(point) {
if (point.x > xMax) {
xMax = point.x;
}
if (point.x < xMin) {
xMin = point.x;
}
if (point.y > yMax) {
yMax = point.y;
}
if (point.y < yMin) {
yMin = point.y;
}
});
out.setTo(xMin, yMin, xMax - xMin, yMax - yMin);
return out;
};