Merge pull request #5207 from samme/feature/display-getBounds

Add Phaser.Display.Bounds.GetBounds()
This commit is contained in:
Richard Davey 2020-07-13 13:14:30 +01:00 committed by GitHub
commit 8080196800
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 1 deletions

View file

@ -0,0 +1,38 @@
/**
* @author samme
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var GetBottom = require('./GetBottom');
var GetLeft = require('./GetLeft');
var GetRight = require('./GetRight');
var GetTop = require('./GetTop');
/**
* Returns the unrotated bounds of the Game Object as a rectangle.
*
* @function Phaser.Display.Bounds.GetBounds
* @since 3.24.0
*
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.
* @param {(Phaser.Geom.Rectangle|object)} [output] - An object to store the values in.
*
* @return {(Phaser.Geom.Rectangle|object)} - The bounds of the Game Object.
*/
var GetBounds = function (gameObject, output)
{
if (output === undefined) { output = {}; }
var left = GetLeft(gameObject);
var top = GetTop(gameObject);
output.x = left;
output.y = top;
output.width = GetRight(gameObject) - left;
output.height = GetBottom(gameObject) - top;
return output;
};
module.exports = GetBounds;

View file

@ -12,6 +12,7 @@ module.exports = {
CenterOn: require('./CenterOn'),
GetBottom: require('./GetBottom'),
GetBounds: require('./GetBounds'),
GetCenterX: require('./GetCenterX'),
GetCenterY: require('./GetCenterY'),
GetLeft: require('./GetLeft'),
@ -25,5 +26,5 @@ module.exports = {
SetLeft: require('./SetLeft'),
SetRight: require('./SetRight'),
SetTop: require('./SetTop')
};