Sprite.autoCull now properly works if the camera moves around the world.

Sprite.inCamera uses a much faster check if auto culling or world bounds checks are enabled and properly adjusts for camera position.

Author: photonstorm

README.md

@@ -157,6 +157,7 @@ The proxy methods are generated one-time dynamically but only when needed.
 * The Phaser.Device class has been made into a singleton and removed it's dependancy on Phaser.Game (thanks @pnstickne #1328)
 * ArrayList has been renamed to `ArraySet` (as it's actually a data set implementation) and moved from the `core` folder to the `utils` folder (thanks @pnstickne)
 * If you are reloading a Phaser Game on a page that never properly refreshes (such as in an AngularJS project) then you will quickly run out of AudioContext nodes. If this is the case create a global var called `PhaserGlobal` on the window object before creating the game. The active AudioContext will then be saved to `window.PhaserGlobal.audioContext` when the Phaser game is destroyed, and re-used when it starts again (#1233)
+* Camera.screenView is now deprecated. All Camera culling checks are made against Camera.view now instead.
 
 ### Bug Fixes
 
@@ -179,6 +180,8 @@ The proxy methods are generated one-time dynamically but only when needed.
 This fixes a bug in FF where it would use the default DOMMouseWheel (thanks @pnstickne #1313)
 * Stage.smoothed needed to modify the value of PIXI.scaleMode.DEFAULT instead of PIXI.scaleMode.LINEAR (thanks @pixelpicosean #1322)
 * Newly created Groups always had zero z index (thanks @spayton #1291)
+* Sprite.autoCull now properly works if the camera moves around the world.
+* Sprite.inCamera uses a much faster check if auto culling or world bounds checks are enabled and properly adjusts for camera position.
 
 ### Pixi 2.1.0 New Features
 

src/core/Camera.js

@@ -39,13 +39,14 @@ Phaser.Camera = function (game, id, x, y, width, height) {
     * Camera view.
     * The view into the world we wish to render (by default the game dimensions).
     * The x/y values are in world coordinates, not screen coordinates, the width/height is how many pixels to render.
-    * Objects outside of this view are not rendered if set to camera cull.
+    * Sprites outside of this view are not rendered if Sprite.autoCull is set to `true`. Otherwise they are always rendered.
     * @property {Phaser.Rectangle} view
     */
     this.view = new Phaser.Rectangle(x, y, width, height);
 
     /**
     * @property {Phaser.Rectangle} screenView - Used by Sprites to work out Camera culling.
+    * @deprecated No longer used for camera culling. Uses Camera.view instead.
     */
     this.screenView = new Phaser.Rectangle(x, y, width, height);
 
@@ -86,20 +87,6 @@ Phaser.Camera = function (game, id, x, y, width, height) {
     */
     this.target = null;
 
-    /**
-    * @property {number} edge - Edge property.
-    * @private
-    * @default
-    */
-    this._edge = 0;
-
-    /**
-    * @property {Phaser.Point} position - Current position of the camera in world.
-    * @private
-    * @default
-    */
-    this._position = new Phaser.Point();
-
     /**
     * @property {PIXI.DisplayObject} displayObject - The display object to which all game objects are added. Set by World.boot
     */
@@ -110,11 +97,31 @@ Phaser.Camera = function (game, id, x, y, width, height) {
     */
     this.scale = null;
 
+    /**
+    * @property {number} totalInView - The total number of Sprites with `autoCull` set to `true` that are visible by this Camera.
+    * @readOnly
+    */
+    this.totalInView = 0;
+
     /**
     * @property {Phaser.Point} _targetPosition - Internal point used to calculate target position
     */
     this._targetPosition = new Phaser.Point();
 
+    /**
+    * @property {number} edge - Edge property.
+    * @private
+    * @default
+    */
+    this._edge = 0;
+
+    /**
+    * @property {Phaser.Point} position - Current position of the camera in world.
+    * @private
+    * @default
+    */
+    this._position = new Phaser.Point();
+
 };
 
 /**
@@ -143,6 +150,12 @@ Phaser.Camera.FOLLOW_TOPDOWN_TIGHT = 3;
 
 Phaser.Camera.prototype = {
 
+    preUpdate: function () {
+
+        this.totalInView = 0;
+
+    },
+
     /**
     * Tells this camera which sprite to follow.
     * @method Phaser.Camera#follow
@@ -253,12 +266,12 @@ Phaser.Camera.prototype = {
     */
     updateTarget: function () {
 
-        this._targetPosition
-            .copyFrom(this.target)
-            .multiply(
-                this.target.parent ? this.target.parent.worldTransform.a : 1,
-                this.target.parent ? this.target.parent.worldTransform.d : 1
-            );
+        this._targetPosition.copyFrom(this.target);
+
+        if (this.target.parent)
+        {
+            this._targetPosition.multiply(this.target.parent.worldTransform.a, this.target.parent.worldTransform.d);
+        }
 
         if (this.deadzone)
         {

src/gameobjects/Sprite.js

@@ -261,32 +261,43 @@ Phaser.Sprite.prototype.preUpdate = function() {
     if (this.autoCull || this.checkWorldBounds)
     {
         this._bounds.copyFrom(this.getBounds());
-    }
 
-    if (this.autoCull)
-    {
-        //  Won't get rendered but will still get its transform updated
-        this.renderable = this.game.world.camera.screenView.intersects(this._bounds);
-    }
+        this._bounds.x += this.game.camera.view.x;
+        this._bounds.y += this.game.camera.view.y;
 
-    if (this.checkWorldBounds)
-    {
-        //  The Sprite is already out of the world bounds, so let's check to see if it has come back again
-        if (this._cache[5] === 1 && this.game.world.bounds.intersects(this._bounds))
+        if (this.autoCull)
         {
-            this._cache[5] = 0;
-            this.events.onEnterBounds.dispatch(this);
+            //  Won't get rendered but will still get its transform updated
+            if (this.game.world.camera.view.intersects(this._bounds))
+            {
+                this.renderable = true;
+                this.game.world.camera.totalInView++;
+            }
+            else
+            {
+                this.renderable = false;
+            }
         }
-        else if (this._cache[5] === 0 && !this.game.world.bounds.intersects(this._bounds))
-        {
-            //  The Sprite WAS in the screen, but has now left.
-            this._cache[5] = 1;
-            this.events.onOutOfBounds.dispatch(this);
 
-            if (this.outOfBoundsKill)
+        if (this.checkWorldBounds)
+        {
+            //  The Sprite is already out of the world bounds, so let's check to see if it has come back again
+            if (this._cache[5] === 1 && this.game.world.bounds.intersects(this._bounds))
+            {
+                this._cache[5] = 0;
+                this.events.onEnterBounds.dispatch(this);
+            }
+            else if (this._cache[5] === 0 && !this.game.world.bounds.intersects(this._bounds))
             {
-                this.kill();
-                return false;
+                //  The Sprite WAS in the screen, but has now left.
+                this._cache[5] = 1;
+                this.events.onOutOfBounds.dispatch(this);
+
+                if (this.outOfBoundsKill)
+                {
+                    this.kill();
+                    return false;
+                }
             }
         }
     }
@@ -1065,7 +1076,14 @@ Object.defineProperty(Phaser.Sprite.prototype, "inCamera", {
 
     get: function() {
 
-        return this.game.world.camera.screenView.intersects(this.getBounds());
+        if (!this.autoCull && !this.checkWorldBounds)
+        {
+            this._bounds.copyFrom(this.getBounds());
+            this._bounds.x += this.game.camera.view.x;
+            this._bounds.y += this.game.camera.view.y;
+        }
+
+        return this.game.world.camera.view.intersects(this._bounds);
 
     }
 

src/utils/Debug.js

@@ -278,6 +278,8 @@ Phaser.Utils.Debug.prototype = {
         }
 
         this.line('View x: ' + camera.view.x + ' Y: ' + camera.view.y + ' w: ' + camera.view.width + ' h: ' + camera.view.height);
+        // this.line('Screen View x: ' + camera.screenView.x + ' Y: ' + camera.screenView.y + ' w: ' + camera.screenView.width + ' h: ' + camera.screenView.height);
+        this.line('Total in view: ' + camera.totalInView);
         this.stop();
 
     },
@@ -474,6 +476,7 @@ Phaser.Utils.Debug.prototype = {
         this.line('x: ' + sprite.x.toFixed(1) + ' y: ' + sprite.y.toFixed(1));
         this.line('angle: ' + sprite.angle.toFixed(1) + ' rotation: ' + sprite.rotation.toFixed(1));
         this.line('visible: ' + sprite.visible + ' in camera: ' + sprite.inCamera);
+        this.line('bounds x: ' + sprite._bounds.x + ' y: ' + sprite._bounds.y + ' w: ' + sprite._bounds.width + ' h: ' + sprite._bounds.height);
 
         this.stop();
 

typescript/phaser.d.ts

@@ -458,6 +458,7 @@ declare module Phaser {
         scale: Phaser.Point;
         screenView: Phaser.Rectangle;
         target: Phaser.Sprite;
+        totalInView: number;
         view: Phaser.Rectangle;
         visible: boolean;
         width: number;