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

Add Phaser.Display.Bounds.GetBounds()

src/display/bounds/GetBounds.js

@@ -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;

src/display/bounds/index.js

@@ -12,6 +12,7 @@ module.exports = {
 
     CenterOn: require('./CenterOn'),
     GetBottom: require('./GetBottom'),
+    GetBounds: require('./GetBounds'),
     GetCenterX: require('./GetCenterX'),
     GetCenterY: require('./GetCenterY'),
     GetLeft: require('./GetLeft'),