mirror of
https://github.com/photonstorm/phaser
synced 2024-11-23 21:24:09 +00:00
651 lines
16 KiB
HTML
651 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Phaser Source: core/Camera.js</title>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="container-fluid">
|
|
<div class="navbar navbar-fixed-top navbar-inverse">
|
|
<div class="navbar-inner">
|
|
<a class="brand" href="index.html">Phaser</a>
|
|
<ul class="nav">
|
|
|
|
<li class="dropdown">
|
|
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
|
|
class="caret"></b></a>
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
<li>
|
|
<a href="module-Phaser.html">Phaser</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
|
|
class="caret"></b></a>
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
<li>
|
|
<a href="Phaser.Animation.html">Animation</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Animation.Frame.html">Frame</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Animation.FrameData.html">FrameData</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Animation.Parser.html">Parser</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.AnimationManager.html">AnimationManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Cache.html">Cache</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Camera.html">Camera</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Canvas.html">Canvas</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Device.html">Device</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Game.html">Game</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Group.html">Group</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Input.html">Input</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.InputHandler.html">InputHandler</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Key.html">Key</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Keyboard.html">Keyboard</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.LinkedList.html">LinkedList</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Loader.html">Loader</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Loader.Parser.html">Parser</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Math.html">Math</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Mouse.html">Mouse</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.MSPointer.html">MSPointer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Net.html">Net</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Particles.html">Particles</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Plugin.html">Plugin</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.PluginManager.html">PluginManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Point.html">Point</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Pointer.html">Pointer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.QuadTree.html">QuadTree</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Rectangle.html">Rectangle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Signal.html">Signal</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Sound.html">Sound</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.SoundManager.html">SoundManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Stage.html">Stage</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.StageScaleMode.html">StageScaleMode</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.State.html">State</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.StateManager.html">StateManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Touch.html">Touch</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.World.html">World</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="SignalBinding.html">SignalBinding</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: core/Camera.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="sunlight-highlight-javascript linenums">/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2013 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view.
|
|
* The game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x/y
|
|
*
|
|
* @class Phaser.Camera
|
|
* @constructor
|
|
* @param {Phaser.Game} game - Game reference to the currently running game.
|
|
* @param {number} id - Not being used at the moment, will be when Phaser supports multiple camera
|
|
* @param {number} x - Position of the camera on the X axis
|
|
* @param {number} y - Position of the camera on the Y axis
|
|
* @param {number} width - The width of the view rectangle
|
|
* @param {number} height - The height of the view rectangle
|
|
*/
|
|
|
|
Phaser.Camera = function (game, id, x, y, width, height) {
|
|
|
|
/**
|
|
* @property {Phaser.Game} game - A reference to the currently running Game.
|
|
*/
|
|
this.game = game;
|
|
|
|
/**
|
|
* @property {Phaser.World} world - A reference to the game world.
|
|
*/
|
|
this.world = game.world;
|
|
|
|
/**
|
|
* @property {number} id - Reserved for future multiple camera set-ups.
|
|
* @default
|
|
*/
|
|
this.id = 0;
|
|
|
|
/**
|
|
* 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 (unless set to ignore the Camera, i.e. UI?).
|
|
* @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.
|
|
*/
|
|
this.screenView = new Phaser.Rectangle(x, y, width, height);
|
|
|
|
/**
|
|
* @property {Phaser.Rectangle} deadzone - Moving inside this Rectangle will not cause camera moving.
|
|
*/
|
|
this.deadzone = null;
|
|
|
|
/**
|
|
* @property {boolean} visible - Whether this camera is visible or not.
|
|
* @default
|
|
*/
|
|
this.visible = true;
|
|
|
|
/**
|
|
* @property {boolean} atLimit - Whether this camera is flush with the World Bounds or not.
|
|
*/
|
|
this.atLimit = { x: false, y: false };
|
|
|
|
/**
|
|
* @property {Phaser.Sprite} target - If the camera is tracking a Sprite, this is a reference to it, otherwise null.
|
|
* @default
|
|
*/
|
|
this.target = null;
|
|
|
|
/**
|
|
* @property {number} edge - Edge property.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._edge = 0;
|
|
|
|
};
|
|
|
|
/**
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
Phaser.Camera.FOLLOW_LOCKON = 0;
|
|
|
|
/**
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
Phaser.Camera.FOLLOW_PLATFORMER = 1;
|
|
|
|
/**
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
Phaser.Camera.FOLLOW_TOPDOWN = 2;
|
|
|
|
/**
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
Phaser.Camera.FOLLOW_TOPDOWN_TIGHT = 3;
|
|
|
|
Phaser.Camera.prototype = {
|
|
|
|
/**
|
|
* Tells this camera which sprite to follow.
|
|
* @method Phaser.Camera#follow
|
|
* @param {Phaser.Sprite} target - The object you want the camera to track. Set to null to not follow anything.
|
|
* @param {number} [style] Leverage one of the existing "deadzone" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().
|
|
*/
|
|
follow: function (target, style) {
|
|
|
|
if (typeof style === "undefined") { style = Phaser.Camera.FOLLOW_LOCKON; }
|
|
|
|
this.target = target;
|
|
|
|
var helper;
|
|
|
|
switch (style) {
|
|
|
|
case Phaser.Camera.FOLLOW_PLATFORMER:
|
|
var w = this.width / 8;
|
|
var h = this.height / 3;
|
|
this.deadzone = new Phaser.Rectangle((this.width - w) / 2, (this.height - h) / 2 - h * 0.25, w, h);
|
|
break;
|
|
|
|
case Phaser.Camera.FOLLOW_TOPDOWN:
|
|
helper = Math.max(this.width, this.height) / 4;
|
|
this.deadzone = new Phaser.Rectangle((this.width - helper) / 2, (this.height - helper) / 2, helper, helper);
|
|
break;
|
|
|
|
case Phaser.Camera.FOLLOW_TOPDOWN_TIGHT:
|
|
helper = Math.max(this.width, this.height) / 8;
|
|
this.deadzone = new Phaser.Rectangle((this.width - helper) / 2, (this.height - helper) / 2, helper, helper);
|
|
break;
|
|
|
|
case Phaser.Camera.FOLLOW_LOCKON:
|
|
default:
|
|
this.deadzone = null;
|
|
break;
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Move the camera focus to a location instantly.
|
|
* @method Phaser.Camera#focusOnXY
|
|
* @param {number} x - X position.
|
|
* @param {number} y - Y position.
|
|
*/
|
|
focusOnXY: function (x, y) {
|
|
|
|
this.view.x = Math.round(x - this.view.halfWidth);
|
|
this.view.y = Math.round(y - this.view.halfHeight);
|
|
|
|
},
|
|
|
|
/**
|
|
* Update focusing and scrolling.
|
|
* @method Phaser.Camera#update
|
|
*/
|
|
update: function () {
|
|
|
|
// Add dirty flag
|
|
|
|
if (this.target !== null)
|
|
{
|
|
if (this.deadzone)
|
|
{
|
|
this._edge = this.target.x - this.deadzone.x;
|
|
|
|
if (this.view.x > this._edge)
|
|
{
|
|
this.view.x = this._edge;
|
|
}
|
|
|
|
this._edge = this.target.x + this.target.width - this.deadzone.x - this.deadzone.width;
|
|
|
|
if (this.view.x < this._edge)
|
|
{
|
|
this.view.x = this._edge;
|
|
}
|
|
|
|
this._edge = this.target.y - this.deadzone.y;
|
|
|
|
if (this.view.y > this._edge)
|
|
{
|
|
this.view.y = this._edge;
|
|
}
|
|
|
|
this._edge = this.target.y + this.target.height - this.deadzone.y - this.deadzone.height;
|
|
|
|
if (this.view.y < this._edge)
|
|
{
|
|
this.view.y = this._edge;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
this.focusOnXY(this.target.x, this.target.y);
|
|
}
|
|
}
|
|
|
|
this.checkWorldBounds();
|
|
|
|
},
|
|
|
|
/**
|
|
* Method called to ensure the camera doesn't venture outside of the game world.
|
|
* @method Phaser.Camera#checkWorldBounds
|
|
*/
|
|
checkWorldBounds: function () {
|
|
|
|
this.atLimit.x = false;
|
|
this.atLimit.y = false;
|
|
|
|
// Make sure we didn't go outside the cameras worldBounds
|
|
if (this.view.x < this.world.bounds.left)
|
|
{
|
|
this.atLimit.x = true;
|
|
this.view.x = this.world.bounds.left;
|
|
}
|
|
|
|
if (this.view.x > this.world.bounds.right - this.width)
|
|
{
|
|
this.atLimit.x = true;
|
|
this.view.x = (this.world.bounds.right - this.width) + 1;
|
|
}
|
|
|
|
if (this.view.y < this.world.bounds.top)
|
|
{
|
|
this.atLimit.y = true;
|
|
this.view.y = this.world.bounds.top;
|
|
}
|
|
|
|
if (this.view.y > this.world.bounds.bottom - this.height)
|
|
{
|
|
this.atLimit.y = true;
|
|
this.view.y = (this.world.bounds.bottom - this.height) + 1;
|
|
}
|
|
|
|
this.view.floor();
|
|
|
|
},
|
|
|
|
/**
|
|
* A helper function to set both the X and Y properties of the camera at once
|
|
* without having to use game.camera.x and game.camera.y.
|
|
*
|
|
* @method Phaser.Camera#setPosition
|
|
* @param {number} x - X position.
|
|
* @param {number} y - Y position.
|
|
*/
|
|
setPosition: function (x, y) {
|
|
|
|
this.view.x = x;
|
|
this.view.y = y;
|
|
this.checkWorldBounds();
|
|
|
|
},
|
|
|
|
/**
|
|
* Sets the size of the view rectangle given the width and height in parameters.
|
|
*
|
|
* @method Phaser.Camera#setSize
|
|
* @param {number} width - The desired width.
|
|
* @param {number} height - The desired height.
|
|
*/
|
|
setSize: function (width, height) {
|
|
|
|
this.view.width = width;
|
|
this.view.height = height;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds.
|
|
* @name Phaser.Camera#x
|
|
* @property {number} x - Gets or sets the cameras x position.
|
|
*/
|
|
Object.defineProperty(Phaser.Camera.prototype, "x", {
|
|
|
|
get: function () {
|
|
return this.view.x;
|
|
},
|
|
|
|
set: function (value) {
|
|
this.view.x = value;
|
|
this.checkWorldBounds();
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* The Cameras y coordinate. This value is automatically clamped if it falls outside of the World bounds.
|
|
* @name Phaser.Camera#y
|
|
* @property {number} y - Gets or sets the cameras y position.
|
|
*/
|
|
Object.defineProperty(Phaser.Camera.prototype, "y", {
|
|
|
|
get: function () {
|
|
return this.view.y;
|
|
},
|
|
|
|
set: function (value) {
|
|
this.view.y = value;
|
|
this.checkWorldBounds();
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* The Cameras width. By default this is the same as the Game size and should not be adjusted for now.
|
|
* @name Phaser.Camera#width
|
|
* @property {number} width - Gets or sets the cameras width.
|
|
*/
|
|
Object.defineProperty(Phaser.Camera.prototype, "width", {
|
|
|
|
get: function () {
|
|
return this.view.width;
|
|
},
|
|
|
|
set: function (value) {
|
|
this.view.width = value;
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* The Cameras height. By default this is the same as the Game size and should not be adjusted for now.
|
|
* @name Phaser.Camera#height
|
|
* @property {number} height - Gets or sets the cameras height.
|
|
*/
|
|
Object.defineProperty(Phaser.Camera.prototype, "height", {
|
|
|
|
get: function () {
|
|
return this.view.height;
|
|
},
|
|
|
|
set: function (value) {
|
|
this.view.height = value;
|
|
}
|
|
|
|
});
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
Phaser Copyright © 2012-2013 Photon Storm Ltd.
|
|
</span>
|
|
<br />
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
|
|
on Thu Oct 03 2013 01:18:41 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</span>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
<br clear="both">
|
|
</div>
|
|
|
|
</div>
|
|
<script src="scripts/sunlight.js"></script>
|
|
<script src="scripts/sunlight.javascript.js"></script>
|
|
<script src="scripts/sunlight-plugin.doclinks.js"></script>
|
|
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
|
|
<script src="scripts/sunlight-plugin.menu.js"></script>
|
|
<script src="scripts/jquery.min.js"></script>
|
|
<script src="scripts/jquery.scrollTo.js"></script>
|
|
<script src="scripts/jquery.localScroll.js"></script>
|
|
<script src="scripts/bootstrap-dropdown.js"></script>
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
|
|
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
|
|
|
|
<script>
|
|
$( function () {
|
|
$( "#toc" ).toc( {
|
|
selectors : "h1,h2,h3,h4",
|
|
showAndHide : false,
|
|
scrollTo : 60
|
|
} );
|
|
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
|
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
|
|
|
} );
|
|
</script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|