phaser/docs/src_math_Math.js.html

2322 lines
68 KiB
HTML
Raw Normal View History

2013-10-02 14:05:55 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
2015-03-23 23:46:30 +00:00
<title>Phaser Source: src/math/Math.js</title>
2013-10-02 14:05:55 +00:00
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
2013-10-02 14:05:55 +00:00
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2014-11-25 00:23:44 +00:00
2013-10-02 14:05:55 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2014-11-25 00:23:44 +00:00
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
2013-10-02 14:05:55 +00:00
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
2013-10-02 14:05:55 +00:00
<ul class="nav">
2014-11-25 00:23:44 +00:00
2013-10-02 14:05:55 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
2013-10-02 14:05:55 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
2013-10-02 14:05:55 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
2013-10-02 14:05:55 +00:00
</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 ">
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="Matrix.html">Matrix</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
2013-10-03 00:21:08 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
2013-10-02 14:05:55 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.html#TilemapCollision">TilemapCollision</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.World.html">World</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PolyK.html">PolyK</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.RenderTexture.html">RenderTexture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Rope.html">Rope</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html">Sprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Stage.html">Stage</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Strip.html">Strip</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.StripShader.html">StripShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Text.html">Text</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Texture.html">Texture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.TilingSprite.html">TilingSprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.VideoTexture.html">VideoTexture</a>
2014-11-15 20:01:46 +00:00
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
2014-11-25 00:23:44 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="RoundedRectangle.html">RoundedRectangle</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#append">append</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#apply">apply</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#applyInverse">applyInverse</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#clone">clone</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#contains">contains</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#fromArray">fromArray</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#identity">identity</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#rotate">rotate</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scale">scale</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#sort">sort</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#toArray">toArray</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#translate">translate</a>
2014-11-15 20:01:46 +00:00
</li>
2013-10-02 14:05:55 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2014-11-25 00:23:44 +00:00
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
2014-11-15 20:01:46 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="https://leanpub.com/u/photonstorm">Phaser Books</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://examples.phaser.io">Phaser Examples</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-1"><a href="http://phaser.io/coding-tips.php">Weekly Coding Tips</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="https://twitter.com/photonstorm">Twitter</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/">IRC</a></li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">Donate to the project</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
2014-11-25 00:23:44 +00:00
</ul>
</li>
2013-10-02 14:05:55 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
2015-03-23 23:46:30 +00:00
<h1 class="page-title">Source: src/math/Math.js</h1>
2013-10-02 14:05:55 +00:00
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
2015-03-23 23:46:30 +00:00
* @copyright 2015 Photon Storm Ltd.
2013-10-02 14:05:55 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
2014-11-15 20:01:46 +00:00
* A collection of useful mathematical functions.
*
* These are normally accessed through `game.math`.
2013-10-02 14:05:55 +00:00
*
* @class Phaser.Math
2014-11-15 20:01:46 +00:00
* @static
* @see {@link Phaser.Utils}
* @see {@link Phaser.ArrayUtils}
2013-10-02 14:05:55 +00:00
*/
Phaser.Math = {
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Twice PI.
* @property {number} Phaser.Math#PI2
* @default ~6.283
* @deprecated 2.2.0 - Not used internally. Use `2 * Math.PI` instead.
2013-11-28 15:57:09 +00:00
*/
PI2: Math.PI * 2,
/**
2014-11-15 20:01:46 +00:00
* Two number are fuzzyEqual if their difference is less than epsilon.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#fuzzyEqual
* @param {number} a
* @param {number} b
2014-11-15 20:01:46 +00:00
* @param {number} [epsilon=(small value)]
* @return {boolean} True if |a-b|&lt;epsilon
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
fuzzyEqual: function (a, b, epsilon) {
2014-11-15 20:01:46 +00:00
if (typeof epsilon === 'undefined') { epsilon = 0.0001; }
2013-10-02 14:05:55 +00:00
return Math.abs(a - b) &lt; epsilon;
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* `a` is fuzzyLessThan `b` if it is less than b + epsilon.
*
* @method Phaser.Math#fuzzyLessThan
2013-11-28 15:57:09 +00:00
* @param {number} a
* @param {number} b
2014-11-15 20:01:46 +00:00
* @param {number} [epsilon=(small value)]
* @return {boolean} True if a&lt;b+epsilon
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
fuzzyLessThan: function (a, b, epsilon) {
2014-11-15 20:01:46 +00:00
if (typeof epsilon === 'undefined') { epsilon = 0.0001; }
2013-10-02 14:05:55 +00:00
return a &lt; b + epsilon;
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* `a` is fuzzyGreaterThan `b` if it is more than b - epsilon.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#fuzzyGreaterThan
* @param {number} a
* @param {number} b
2014-11-15 20:01:46 +00:00
* @param {number} [epsilon=(small value)]
* @return {boolean} True if a>b+epsilon
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
fuzzyGreaterThan: function (a, b, epsilon) {
2014-11-15 20:01:46 +00:00
if (typeof epsilon === 'undefined') { epsilon = 0.0001; }
2013-10-02 14:05:55 +00:00
return a > b - epsilon;
},
/**
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#fuzzyCeil
2014-11-15 20:01:46 +00:00
*
2013-11-28 15:57:09 +00:00
* @param {number} val
2014-11-15 20:01:46 +00:00
* @param {number} [epsilon=(small value)]
* @return {boolean} ceiling(val-epsilon)
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
fuzzyCeil: function (val, epsilon) {
2014-11-15 20:01:46 +00:00
if (typeof epsilon === 'undefined') { epsilon = 0.0001; }
2013-10-02 14:05:55 +00:00
return Math.ceil(val - epsilon);
},
/**
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#fuzzyFloor
2014-11-15 20:01:46 +00:00
*
2013-11-28 15:57:09 +00:00
* @param {number} val
2014-11-15 20:01:46 +00:00
* @param {number} [epsilon=(small value)]
* @return {boolean} floor(val-epsilon)
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
fuzzyFloor: function (val, epsilon) {
2014-11-15 20:01:46 +00:00
if (typeof epsilon === 'undefined') { epsilon = 0.0001; }
2013-10-02 14:05:55 +00:00
return Math.floor(val + epsilon);
},
/**
2014-11-15 20:01:46 +00:00
* Averages all values passed to the function and returns the result.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#average
2014-11-15 20:01:46 +00:00
* @params {...number} The numbers to average
2013-10-02 14:05:55 +00:00
* @return {number} The average of all given values.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
average: function () {
2014-11-15 20:01:46 +00:00
var sum = 0;
2013-10-02 14:05:55 +00:00
2014-11-15 20:01:46 +00:00
for (var i = 0; i &lt; arguments.length; i++) {
sum += (+arguments[i]);
2013-10-02 14:05:55 +00:00
}
2014-11-15 20:01:46 +00:00
return sum / arguments.length;
2013-10-02 14:05:55 +00:00
},
/**
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#truncate
2013-10-02 14:05:55 +00:00
* @param {number} n
2014-11-15 20:01:46 +00:00
* @return {integer}
* @deprecated 2.2.0 - Use `Math.trunc` (now with polyfill)
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
truncate: function (n) {
2014-11-15 20:01:46 +00:00
return Math.trunc(n);
2013-10-02 14:05:55 +00:00
},
/**
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#shear
* @param {number} n
* @return {number} n mod 1
*/
2013-10-02 14:05:55 +00:00
shear: function (n) {
return n % 1;
},
2013-11-28 15:57:09 +00:00
/**
* Snap a value to nearest grid slice, using rounding.
*
* Example: if you have an interval gap of 5 and a position of 12... you will snap to 10 whereas 14 will snap to 15.
*
* @method Phaser.Math#snapTo
* @param {number} input - The value to snap.
* @param {number} gap - The interval gap of the grid.
* @param {number} [start] - Optional starting offset for gap.
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
snapTo: function (input, gap, start) {
2014-11-15 20:01:46 +00:00
if (typeof start === 'undefined') { start = 0; }
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
if (gap === 0) {
2013-10-02 14:05:55 +00:00
return input;
}
input -= start;
input = gap * Math.round(input / gap);
return start + input;
},
2013-11-28 15:57:09 +00:00
/**
2013-10-02 14:05:55 +00:00
* Snap a value to nearest grid slice, using floor.
*
* Example: if you have an interval gap of 5 and a position of 12... you will snap to 10. As will 14 snap to 10... but 16 will snap to 15
*
* @method Phaser.Math#snapToFloor
* @param {number} input - The value to snap.
* @param {number} gap - The interval gap of the grid.
* @param {number} [start] - Optional starting offset for gap.
* @return {number}
*/
snapToFloor: function (input, gap, start) {
2014-11-15 20:01:46 +00:00
if (typeof start === 'undefined') { start = 0; }
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
if (gap === 0) {
2013-10-02 14:05:55 +00:00
return input;
}
input -= start;
input = gap * Math.floor(input / gap);
return start + input;
},
2013-11-28 15:57:09 +00:00
/**
* Snap a value to nearest grid slice, using ceil.
*
* Example: if you have an interval gap of 5 and a position of 12... you will snap to 15. As will 14 will snap to 15... but 16 will snap to 20.
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#snapToCeil
* @param {number} input - The value to snap.
* @param {number} gap - The interval gap of the grid.
* @param {number} [start] - Optional starting offset for gap.
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
snapToCeil: function (input, gap, start) {
2014-11-15 20:01:46 +00:00
if (typeof start === 'undefined') { start = 0; }
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
if (gap === 0) {
2013-10-02 14:05:55 +00:00
return input;
}
input -= start;
input = gap * Math.ceil(input / gap);
return start + input;
},
2013-11-28 15:57:09 +00:00
/**
* Snaps a value to the nearest value in an array.
2014-11-15 20:01:46 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#snapToInArray
* @param {number} input
2014-11-15 20:01:46 +00:00
* @param {number[]} arr
2013-11-28 15:57:09 +00:00
* @param {boolean} sort - True if the array needs to be sorted.
2013-10-02 14:05:55 +00:00
* @return {number}
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - See {@link Phaser.ArrayUtils.findClosest} for an alternative.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
snapToInArray: function (input, arr, sort) {
2014-11-15 20:01:46 +00:00
if (typeof sort === 'undefined') { sort = true; }
2013-10-02 14:05:55 +00:00
if (sort) {
arr.sort();
}
2014-11-15 20:01:46 +00:00
return Phaser.ArrayUtils.findClosest(input, arr);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Round to some place comparative to a `base`, default is 10 for decimal place.
* The `place` is represented by the power applied to `base` to get that place.
2013-11-28 15:57:09 +00:00
*
2014-11-15 20:01:46 +00:00
* e.g. 2000/7 ~= 285.714285714285714285714 ~= (bin)100011101.1011011011011011
2013-11-28 15:57:09 +00:00
*
2014-11-15 20:01:46 +00:00
* roundTo(2000/7,3) === 0
* roundTo(2000/7,2) == 300
* roundTo(2000/7,1) == 290
* roundTo(2000/7,0) == 286
* roundTo(2000/7,-1) == 285.7
* roundTo(2000/7,-2) == 285.71
* roundTo(2000/7,-3) == 285.714
* roundTo(2000/7,-4) == 285.7143
* roundTo(2000/7,-5) == 285.71429
2013-11-28 15:57:09 +00:00
*
2014-11-15 20:01:46 +00:00
* roundTo(2000/7,3,2) == 288 -- 100100000
* roundTo(2000/7,2,2) == 284 -- 100011100
* roundTo(2000/7,1,2) == 286 -- 100011110
* roundTo(2000/7,0,2) == 286 -- 100011110
* roundTo(2000/7,-1,2) == 285.5 -- 100011101.1
* roundTo(2000/7,-2,2) == 285.75 -- 100011101.11
* roundTo(2000/7,-3,2) == 285.75 -- 100011101.11
* roundTo(2000/7,-4,2) == 285.6875 -- 100011101.1011
* roundTo(2000/7,-5,2) == 285.71875 -- 100011101.10111
2013-11-28 15:57:09 +00:00
*
* Note what occurs when we round to the 3rd space (8ths place), 100100000, this is to be assumed
* because we are rounding 100011.1011011011011011 which rounds up.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#roundTo
* @param {number} value - The value to round.
* @param {number} place - The place to round to.
* @param {number} base - The base to round in... default is 10 for decimal.
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
roundTo: function (value, place, base) {
2014-11-15 20:01:46 +00:00
if (typeof place === 'undefined') { place = 0; }
if (typeof base === 'undefined') { base = 10; }
2013-10-02 14:05:55 +00:00
var p = Math.pow(base, -place);
2013-10-02 14:05:55 +00:00
return Math.round(value * p) / p;
},
/**
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#floorTo
* @param {number} value - The value to round.
* @param {number} place - The place to round to.
* @param {number} base - The base to round in... default is 10 for decimal.
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
floorTo: function (value, place, base) {
2014-11-15 20:01:46 +00:00
if (typeof place === 'undefined') { place = 0; }
if (typeof base === 'undefined') { base = 10; }
2013-10-02 14:05:55 +00:00
var p = Math.pow(base, -place);
return Math.floor(value * p) / p;
},
/**
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#ceilTo
* @param {number} value - The value to round.
* @param {number} place - The place to round to.
* @param {number} base - The base to round in... default is 10 for decimal.
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
ceilTo: function (value, place, base) {
2014-11-15 20:01:46 +00:00
if (typeof place === 'undefined') { place = 0; }
if (typeof base === 'undefined') { base = 10; }
2013-10-02 14:05:55 +00:00
var p = Math.pow(base, -place);
return Math.ceil(value * p) / p;
},
2013-11-28 15:57:09 +00:00
/**
* A one dimensional linear interpolation of a value.
* @method Phaser.Math#interpolateFloat
* @param {number} a
* @param {number} b
* @param {number} weight
2013-10-02 14:05:55 +00:00
* @return {number}
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - See {@link Phaser.Math#linear}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
interpolateFloat: function (a, b, weight) {
return (b - a) * weight + a;
},
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* Find the angle of a segment from (x1, y1) -> (x2, y2).
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#angleBetween
* @param {number} x1
* @param {number} y1
* @param {number} x2
* @param {number} y2
2014-11-15 20:01:46 +00:00
* @return {number} The angle, in radians.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
angleBetween: function (x1, y1, x2, y2) {
2014-04-15 14:39:23 +00:00
return Math.atan2(y2 - y1, x2 - x1);
},
2014-09-09 14:36:56 +00:00
/**
* Find the angle of a segment from (x1, y1) -> (x2, y2).
* Note that the difference between this method and Math.angleBetween is that this assumes the y coordinate travels
* down the screen.
*
* @method Phaser.Math#angleBetweenY
* @param {number} x1
* @param {number} y1
* @param {number} x2
* @param {number} y2
2014-11-15 20:01:46 +00:00
* @return {number} The angle, in radians.
2014-09-09 14:36:56 +00:00
*/
angleBetweenY: function (x1, y1, x2, y2) {
return Math.atan2(x2 - x1, y2 - y1);
},
/**
* Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).
* @method Phaser.Math#angleBetweenPoints
* @param {Phaser.Point} point1
* @param {Phaser.Point} point2
2014-11-15 20:01:46 +00:00
* @return {number} The angle, in radians.
*/
angleBetweenPoints: function (point1, point2) {
2014-04-15 14:39:23 +00:00
return Math.atan2(point2.y - point1.y, point2.x - point1.x);
2013-10-02 14:05:55 +00:00
},
2014-09-09 14:36:56 +00:00
/**
* Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).
* @method Phaser.Math#angleBetweenPointsY
* @param {Phaser.Point} point1
* @param {Phaser.Point} point2
2014-11-15 20:01:46 +00:00
* @return {number} The angle, in radians.
2014-09-09 14:36:56 +00:00
*/
angleBetweenPointsY: function (point1, point2) {
return Math.atan2(point2.x - point1.x, point2.y - point1.y);
},
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* Reverses an angle.
* @method Phaser.Math#reverseAngle
* @param {number} angleRad - The angle to reverse, in radians.
* @return {number} Returns the reverse angle, in radians.
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
reverseAngle: function (angleRad) {
return this.normalizeAngle(angleRad + Math.PI, true);
},
2013-10-02 14:05:55 +00:00
2014-02-05 06:29:17 +00:00
/**
* Normalizes an angle to the [0,2pi) range.
* @method Phaser.Math#normalizeAngle
* @param {number} angleRad - The angle to normalize, in radians.
* @return {number} Returns the angle, fit within the [0,2pi] range, in radians.
*/
normalizeAngle: function (angleRad) {
2013-10-02 14:05:55 +00:00
2014-02-05 06:29:17 +00:00
angleRad = angleRad % (2 * Math.PI);
return angleRad >= 0 ? angleRad : angleRad + 2 * Math.PI;
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* Normalizes a latitude to the [-90,90] range. Latitudes above 90 or below -90 are capped, not wrapped.
* @method Phaser.Math#normalizeLatitude
* @param {number} lat - The latitude to normalize, in degrees.
* @return {number} Returns the latitude, fit within the [-90,90] range.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.Math#clamp}.
2014-02-05 06:29:17 +00:00
*/
normalizeLatitude: function (lat) {
2014-11-15 20:01:46 +00:00
return Phaser.Math.clamp(lat, -90, 90);
2014-02-05 06:29:17 +00:00
},
/**
* Normalizes a longitude to the [-180,180] range. Longitudes above 180 or below -180 are wrapped.
* @method Phaser.Math#normalizeLongitude
* @param {number} lng - The longitude to normalize, in degrees.
* @return {number} Returns the longitude, fit within the [-180,180] range.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.Math#wrap}.
2014-02-05 06:29:17 +00:00
*/
normalizeLongitude: function (lng) {
2014-11-15 20:01:46 +00:00
return Phaser.Math.wrap(lng, -180, 180);
2014-02-05 06:29:17 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Generate a random bool result based on the chance value.
2014-11-15 20:01:46 +00:00
*
2013-11-28 15:57:09 +00:00
* Returns true or false based on the chance value (default 50%). For example if you wanted a player to have a 30% chance
* of getting a bonus, call chanceRoll(30) - true means the chance passed, false means it failed.
2014-11-15 20:01:46 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#chanceRoll
* @param {number} chance - The chance of receiving the value. A number between 0 and 100 (effectively 0% to 100%).
* @return {boolean} True if the roll passed, or false otherwise.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.Utils.chanceRoll}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
chanceRoll: function (chance) {
2014-11-15 20:01:46 +00:00
return Phaser.Utils.chanceRoll(chance);
2013-10-02 14:05:55 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Create an array representing the inclusive range of numbers (usually integers) in `[start, end]`.
2013-10-02 14:05:55 +00:00
*
* @method Phaser.Math#numberArray
2014-11-15 20:01:46 +00:00
* @param {number} start - The minimum value the array starts with.
* @param {number} end - The maximum value the array contains.
2014-12-03 10:39:11 +00:00
* @return {number[]} The array of number values.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - See {@link Phaser.ArrayUtils.numberArray}
2013-10-02 14:05:55 +00:00
*/
2014-11-15 20:01:46 +00:00
numberArray: function (start, end) {
return Phaser.ArrayUtils.numberArray(start, end);
2013-10-02 14:05:55 +00:00
},
2014-09-09 14:36:56 +00:00
/**
2014-11-15 20:01:46 +00:00
* Create an array of numbers (positive and/or negative) progressing from `start`
* up to but not including `end` by advancing by `step`.
*
* If `start` is less than `stop` a zero-length range is created unless a negative `step` is specified.
*
* Certain values for `start` and `end` (eg. NaN/undefined/null) are coerced to 0;
* for forward compatibility make sure to pass in actual numbers.
*
* @method Phaser.Math#numberArrayStep
* @param {number} start - The start of the range.
* @param {number} end - The end of the range.
* @param {number} [step=1] - The value to increment or decrement by.
* @returns {Array} Returns the new array of numbers.
* @deprecated 2.2.0 - See {@link Phaser.ArrayUtils.numberArrayStep}
*/
2014-09-09 14:36:56 +00:00
numberArrayStep: function(start, end, step) {
2014-11-15 20:01:46 +00:00
return Phaser.ArrayUtils.numberArrayStep(start, end, step);
2014-09-09 14:36:56 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Adds the given amount to the value, but never lets the value go over the specified maximum.
*
* @method Phaser.Math#maxAdd
* @param {number} value - The value to add the amount to.
* @param {number} amount - The amount to add to the value.
2014-11-15 20:01:46 +00:00
* @param {number} max - The maximum the value is allowed to be.
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
maxAdd: function (value, amount, max) {
2014-11-15 20:01:46 +00:00
return Math.min(value + amount, max);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Subtracts the given amount from the value, but never lets the value go below the specified minimum.
*
* @method Phaser.Math#minSub
* @param {number} value - The base value.
* @param {number} amount - The amount to subtract from the base value.
* @param {number} min - The minimum the value is allowed to be.
* @return {number} The new value.
*/
2013-10-02 14:05:55 +00:00
minSub: function (value, amount, min) {
2014-11-15 20:01:46 +00:00
return Math.max(value - amount, min);
2013-10-02 14:05:55 +00:00
},
/**
* Ensures that the value always stays between min and max, by wrapping the value around.
2014-11-15 20:01:46 +00:00
*
* If `max` is not larger than `min` the result is 0.
2013-10-02 14:05:55 +00:00
*
* @method Phaser.Math#wrap
2014-02-05 06:29:17 +00:00
* @param {number} value - The value to wrap.
* @param {number} min - The minimum the value is allowed to be.
2014-11-15 20:01:46 +00:00
* @param {number} max - The maximum the value is allowed to be, should be larger than `min`.
2014-02-05 06:29:17 +00:00
* @return {number} The wrapped value.
2013-10-02 14:05:55 +00:00
*/
wrap: function (value, min, max) {
var range = max - min;
2013-10-02 14:05:55 +00:00
if (range &lt;= 0)
{
return 0;
}
2013-10-02 14:05:55 +00:00
var result = (value - min) % range;
2013-10-02 14:05:55 +00:00
if (result &lt; 0)
{
result += range;
}
2013-10-02 14:05:55 +00:00
return result + min;
2013-10-02 14:05:55 +00:00
},
/**
* Adds value to amount and ensures that the result always stays between 0 and max, by wrapping the value around.
2014-11-15 20:01:46 +00:00
*
* Values _must_ be positive integers, and are passed through Math.abs. See {@link Phaser.Math#wrap} for an alternative.
2013-10-02 14:05:55 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#wrapValue
* @param {number} value - The value to add the amount to.
* @param {number} amount - The amount to add to the value.
* @param {number} max - The maximum the value is allowed to be.
* @return {number} The wrapped value.
2013-10-02 14:05:55 +00:00
*/
wrapValue: function (value, amount, max) {
var diff;
value = Math.abs(value);
amount = Math.abs(amount);
max = Math.abs(max);
diff = (value + amount) % max;
return diff;
},
2014-04-29 14:39:02 +00:00
/**
* Ensures the given value is between min and max inclusive.
*
* @method Phaser.Math#limitValue
* @param {number} value - The value to limit.
* @param {number} min - The minimum the value can be.
* @param {number} max - The maximum the value can be.
* @return {number} The limited value.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.Math#clamp}
2014-04-29 14:39:02 +00:00
*/
limitValue: function(value, min, max) {
2014-11-15 20:01:46 +00:00
return Phaser.Math.clamp(value, min, max);
2014-04-29 14:39:02 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Randomly returns either a 1 or -1.
*
* @method Phaser.Math#randomSign
2014-11-15 20:01:46 +00:00
* @return {number} Either 1 or -1
* @deprecated 2.2.0 - Use {@link Phaser.Utils.randomChoice} or other
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
randomSign: function () {
2014-11-15 20:01:46 +00:00
return Phaser.Utils.randomChoice(-1, 1);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Returns true if the number given is odd.
*
* @method Phaser.Math#isOdd
2014-11-15 20:01:46 +00:00
* @param {integer} n - The number to check.
* @return {boolean} True if the given number is odd. False if the given number is even.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
isOdd: function (n) {
2014-11-15 20:01:46 +00:00
// Does not work with extremely large values
2015-03-23 23:46:30 +00:00
return (n &amp; 1);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Returns true if the number given is even.
*
* @method Phaser.Math#isEven
2014-11-15 20:01:46 +00:00
* @param {integer} n - The number to check.
2013-11-28 15:57:09 +00:00
* @return {boolean} True if the given number is even. False if the given number is odd.
*/
2013-10-02 14:05:55 +00:00
isEven: function (n) {
2014-11-15 20:01:46 +00:00
// Does not work with extremely large values
2015-03-23 23:46:30 +00:00
return !(n &amp; 1);
2013-10-02 14:05:55 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Variation of Math.min that can be passed either an array of numbers or the numbers as parameters.
*
* Prefer the standard `Math.min` function when appropriate.
2013-10-02 14:05:55 +00:00
*
* @method Phaser.Math#min
* @return {number} The lowest value from those given.
2014-11-15 20:01:46 +00:00
* @see {@link http://jsperf.com/math-s-min-max-vs-homemade}
2013-10-02 14:05:55 +00:00
*/
min: function () {
2014-11-15 20:01:46 +00:00
2015-03-23 23:46:30 +00:00
if (arguments.length === 1 &amp;&amp; typeof arguments[0] === 'object')
2014-02-05 06:29:17 +00:00
{
var data = arguments[0];
}
else
{
var data = arguments;
}
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
for (var i = 1, min = 0, len = data.length; i &lt; len; i++)
{
if (data[i] &lt; data[min])
{
min = i;
}
}
return data[min];
},
/**
2014-11-15 20:01:46 +00:00
* Variation of Math.max that can be passed either an array of numbers or the numbers as parameters.
*
* Prefer the standard `Math.max` function when appropriate.
2014-02-05 06:29:17 +00:00
*
* @method Phaser.Math#max
* @return {number} The largest value from those given.
2014-11-15 20:01:46 +00:00
* @see {@link http://jsperf.com/math-s-min-max-vs-homemade}
2014-02-05 06:29:17 +00:00
*/
max: function () {
2014-11-15 20:01:46 +00:00
2015-03-23 23:46:30 +00:00
if (arguments.length === 1 &amp;&amp; typeof arguments[0] === 'object')
2014-02-05 06:29:17 +00:00
{
var data = arguments[0];
}
else
{
var data = arguments;
}
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
for (var i = 1, max = 0, len = data.length; i &lt; len; i++)
{
if (data[i] > data[max])
{
max = i;
}
}
return data[max];
},
/**
2014-11-15 20:01:46 +00:00
* Variation of Math.min that can be passed a property and either an array of objects or the objects as parameters.
2014-02-05 06:29:17 +00:00
* It will find the lowest matching property value from the given objects.
*
* @method Phaser.Math#minProperty
* @return {number} The lowest value from those given.
*/
minProperty: function (property) {
2015-03-23 23:46:30 +00:00
if (arguments.length === 2 &amp;&amp; typeof arguments[1] === 'object')
2014-02-05 06:29:17 +00:00
{
var data = arguments[1];
}
else
{
var data = arguments.slice(1);
}
for (var i = 1, min = 0, len = data.length; i &lt; len; i++)
2013-10-02 14:05:55 +00:00
{
2014-02-05 06:29:17 +00:00
if (data[i][property] &lt; data[min][property])
2013-10-02 14:05:55 +00:00
{
min = i;
}
}
2014-02-05 06:29:17 +00:00
return data[min][property];
},
/**
2014-11-15 20:01:46 +00:00
* Variation of Math.max that can be passed a property and either an array of objects or the objects as parameters.
2014-02-05 06:29:17 +00:00
* It will find the largest matching property value from the given objects.
*
* @method Phaser.Math#maxProperty
* @return {number} The largest value from those given.
*/
maxProperty: function (property) {
2015-03-23 23:46:30 +00:00
if (arguments.length === 2 &amp;&amp; typeof arguments[1] === 'object')
2014-02-05 06:29:17 +00:00
{
var data = arguments[1];
}
else
{
var data = arguments.slice(1);
}
for (var i = 1, max = 0, len = data.length; i &lt; len; i++)
{
if (data[i][property] > data[max][property])
{
max = i;
}
}
return data[max][property];
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Keeps an angle value between -180 and +180; or -PI and PI if radians.
2013-11-28 15:57:09 +00:00
*
* @method Phaser.Math#wrapAngle
2014-11-15 20:01:46 +00:00
* @param {number} angle - The angle value to wrap
* @param {boolean} [radians=false] - Set to `true` if the angle is given in radians, otherwise degrees is expected.
* @return {number} The new angle value; will be the same as the input angle if it was within bounds.
2013-11-28 15:57:09 +00:00
*/
2014-03-24 12:41:45 +00:00
wrapAngle: function (angle, radians) {
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
return radians ? this.wrap(angle, -Math.PI, Math.PI) : this.wrap(angle, -180, 180);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
* Keeps an angle value between the given min and max values.
*
* @method Phaser.Math#angleLimit
* @param {number} angle - The angle value to check. Must be between -180 and +180.
* @param {number} min - The minimum angle that is allowed (must be -180 or greater).
* @param {number} max - The maximum angle that is allowed (must be 180 or less).
* @return {number} The new angle value, returns the same as the input angle if it was within bounds
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.Math#clamp} instead
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
angleLimit: function (angle, min, max) {
2013-10-02 14:05:55 +00:00
var result = angle;
if (angle > max)
{
2013-10-02 14:05:55 +00:00
result = max;
}
else if (angle &lt; min)
{
2013-10-02 14:05:55 +00:00
result = min;
}
2013-10-02 14:05:55 +00:00
return result;
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* A Linear Interpolation Method, mostly used by Phaser.Tween.
2015-03-23 23:46:30 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#linearInterpolation
2015-03-23 23:46:30 +00:00
* @param {Array} v - The input array of values to interpolate between.
* @param {number} k - The percentage of interpolation, between 0 and 1.
* @return {number} The interpolated value
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
linearInterpolation: function (v, k) {
2013-10-02 14:05:55 +00:00
var m = v.length - 1;
var f = m * k;
var i = Math.floor(f);
if (k &lt; 0)
{
2013-10-02 14:05:55 +00:00
return this.linear(v[0], v[1], f);
}
if (k > 1)
{
2013-10-02 14:05:55 +00:00
return this.linear(v[m], v[m - 1], m - f);
}
2013-10-02 14:05:55 +00:00
return this.linear(v[i], v[i + 1 > m ? m : i + 1], f - i);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* A Bezier Interpolation Method, mostly used by Phaser.Tween.
2015-03-23 23:46:30 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#bezierInterpolation
2015-03-23 23:46:30 +00:00
* @param {Array} v - The input array of values to interpolate between.
* @param {number} k - The percentage of interpolation, between 0 and 1.
* @return {number} The interpolated value
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
bezierInterpolation: function (v, k) {
2013-10-02 14:05:55 +00:00
var b = 0;
var n = v.length - 1;
for (var i = 0; i &lt;= n; i++)
{
2013-10-02 14:05:55 +00:00
b += Math.pow(1 - k, n - i) * Math.pow(k, i) * v[i] * this.bernstein(n, i);
}
2013-10-02 14:05:55 +00:00
return b;
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* A Catmull Rom Interpolation Method, mostly used by Phaser.Tween.
2015-03-23 23:46:30 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#catmullRomInterpolation
2015-03-23 23:46:30 +00:00
* @param {Array} v - The input array of values to interpolate between.
* @param {number} k - The percentage of interpolation, between 0 and 1.
* @return {number} The interpolated value
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
catmullRomInterpolation: function (v, k) {
var m = v.length - 1;
var f = m * k;
var i = Math.floor(f);
if (v[0] === v[m])
{
if (k &lt; 0)
{
2013-10-02 14:05:55 +00:00
i = Math.floor(f = m * (1 + k));
}
2013-10-02 14:05:55 +00:00
return this.catmullRom(v[(i - 1 + m) % m], v[i], v[(i + 1) % m], v[(i + 2) % m], f - i);
}
else
{
if (k &lt; 0)
{
2013-10-02 14:05:55 +00:00
return v[0] - (this.catmullRom(v[0], v[0], v[1], v[1], -f) - v[0]);
}
if (k > 1)
{
2013-10-02 14:05:55 +00:00
return v[m] - (this.catmullRom(v[m], v[m], v[m - 1], v[m - 1], f - m) - v[m]);
}
2013-10-02 14:05:55 +00:00
return this.catmullRom(v[i ? i - 1 : 0], v[i], v[m &lt; i + 1 ? m : i + 1], v[m &lt; i + 2 ? m : i + 2], f - i);
}
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Calculates a linear (interpolation) value over t.
2014-10-22 20:49:44 +00:00
*
2014-11-15 20:01:46 +00:00
* @method Phaser.Math#linear
2013-11-28 15:57:09 +00:00
* @param {number} p0
* @param {number} p1
* @param {number} t
* @return {number}
*/
2013-10-02 14:05:55 +00:00
linear: function (p0, p1, t) {
return (p1 - p0) * t + p0;
},
2013-11-28 15:57:09 +00:00
/**
* @method Phaser.Math#bernstein
2014-11-15 20:01:46 +00:00
* @protected
2013-11-28 15:57:09 +00:00
* @param {number} n
* @param {number} i
* @return {number}
*/
2013-10-02 14:05:55 +00:00
bernstein: function (n, i) {
return this.factorial(n) / this.factorial(i) / this.factorial(n - i);
},
2014-07-10 19:31:11 +00:00
/**
* @method Phaser.Math#factorial
* @param {number} value - the number you want to evaluate
* @return {number}
*/
factorial : function( value ){
2015-03-23 23:46:30 +00:00
if (value === 0)
2014-07-10 19:31:11 +00:00
{
return 1;
}
2014-09-09 14:36:56 +00:00
2014-07-10 19:31:11 +00:00
var res = value;
2014-09-09 14:36:56 +00:00
2015-03-23 23:46:30 +00:00
while(--value)
2014-07-10 19:31:11 +00:00
{
res *= value;
}
2014-09-09 14:36:56 +00:00
2014-07-10 19:31:11 +00:00
return res;
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2015-03-23 23:46:30 +00:00
* Calculates a catmum rom value.
2014-10-22 20:49:44 +00:00
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#catmullRom
2014-11-15 20:01:46 +00:00
* @protected
2013-11-28 15:57:09 +00:00
* @param {number} p0
* @param {number} p1
* @param {number} p2
* @param {number} p3
* @param {number} t
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
catmullRom: function (p0, p1, p2, p3, t) {
2013-10-02 14:05:55 +00:00
var v0 = (p2 - p0) * 0.5, v1 = (p3 - p1) * 0.5, t2 = t * t, t3 = t * t2;
2013-10-02 14:05:55 +00:00
return (2 * p1 - 2 * p2 + v0 + v1) * t3 + (-3 * p1 + 3 * p2 - 2 * v0 - v1) * t2 + v0 * t + p1;
2013-10-02 14:05:55 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* The (absolute) difference between two values.
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#difference
* @param {number} a
* @param {number} b
* @return {number}
*/
difference: function (a, b) {
return Math.abs(a - b);
},
2013-11-28 15:57:09 +00:00
/**
* Fetch a random entry from the given array.
2014-12-03 10:39:11 +00:00
*
* Will return null if there are no array items that fall within the specified range
* or if there is no item for the randomly choosen index.
2013-11-28 15:57:09 +00:00
*
* @method Phaser.Math#getRandom
2014-12-03 10:39:11 +00:00
* @param {any[]} objects - An array of objects.
* @param {integer} startIndex - Optional offset off the front of the array. Default value is 0, or the beginning of the array.
* @param {integer} length - Optional restriction on the number of values you want to randomly select from.
* @return {object} The random object that was selected.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ArrayUtils.getRandomItem}
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
getRandom: function (objects, startIndex, length) {
2014-11-15 20:01:46 +00:00
return Phaser.ArrayUtils.getRandomItem(objects, startIndex, length);
2013-10-02 14:05:55 +00:00
},
2014-03-24 12:41:45 +00:00
/**
* Removes a random object from the given array and returns it.
2014-12-03 10:39:11 +00:00
*
* Will return null if there are no array items that fall within the specified range
* or if there is no item for the randomly choosen index.
2014-03-24 12:41:45 +00:00
*
* @method Phaser.Math#removeRandom
2014-12-03 10:39:11 +00:00
* @param {any[]} objects - An array of objects.
* @param {integer} startIndex - Optional offset off the front of the array. Default value is 0, or the beginning of the array.
* @param {integer} length - Optional restriction on the number of values you want to randomly select from.
2014-03-24 12:41:45 +00:00
* @return {object} The random object that was removed.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ArrayUtils.removeRandomItem}
2014-03-24 12:41:45 +00:00
*/
removeRandom: function (objects, startIndex, length) {
2014-11-15 20:01:46 +00:00
return Phaser.ArrayUtils.removeRandomItem(objects, startIndex, length);
2014-03-24 12:41:45 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* _Do not use this function._
*
* Round to the next whole number _towards_ zero.
*
* E.g. `floor(1.7) == 1`, and `floor(-2.7) == -2`.
2013-11-28 15:57:09 +00:00
*
* @method Phaser.Math#floor
2014-11-15 20:01:46 +00:00
* @param {number} value - Any number.
* @return {integer} The rounded value of that number.
* @deprecated 2.2.0 - Use {@link Phaser.Math#truncate} or `Math.trunc` instead.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
floor: function (value) {
2014-11-15 20:01:46 +00:00
return Math.trunc(value);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* _Do not use this function._
*
* Round to the next whole number _away_ from zero.
*
* E.g. `ceil(1.3) == 2`, and `ceil(-2.3) == -3`.
2013-11-28 15:57:09 +00:00
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#ceil
2013-11-28 15:57:09 +00:00
* @param {number} value - Any number.
2014-11-15 20:01:46 +00:00
* @return {integer} The rounded value of that number.
* @deprecated 2.2.0 - Use {@link Phaser.Math#roundAwayFromZero} instead.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
ceil: function (value) {
2014-11-15 20:01:46 +00:00
return Phaser.Math.roundAwayFromZero(value);
},
/**
* Round to the next whole number _away_ from zero.
*
* @method Phaser.Math#roundAwayFromZero
* @param {number} value - Any number.
* @return {integer} The rounded value of that number.
*/
roundAwayFromZero: function (value) {
// "Opposite" of truncate.
return (value > 0) ? Math.ceil(value) : Math.floor(value);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2015-03-23 23:46:30 +00:00
* Generate a sine and cosine table simultaneously and extremely quickly.
* The parameters allow you to specify the length, amplitude and frequency of the wave.
* This generator is fast enough to be used in real-time.
* Code based on research by Franky of scene.at
2014-11-15 20:01:46 +00:00
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#sinCosGenerator
* @param {number} length - The length of the wave
* @param {number} sinAmplitude - The amplitude to apply to the sine table (default 1.0) if you need values between say -+ 125 then give 125 as the value
* @param {number} cosAmplitude - The amplitude to apply to the cosine table (default 1.0) if you need values between say -+ 125 then give 125 as the value
* @param {number} frequency - The frequency of the sine and cosine table data
2014-11-15 20:01:46 +00:00
* @return {{sin:number[], cos:number[]}} Returns the table data.
2013-10-02 14:05:55 +00:00
*/
sinCosGenerator: function (length, sinAmplitude, cosAmplitude, frequency) {
2014-11-15 20:01:46 +00:00
if (typeof sinAmplitude === 'undefined') { sinAmplitude = 1.0; }
if (typeof cosAmplitude === 'undefined') { cosAmplitude = 1.0; }
if (typeof frequency === 'undefined') { frequency = 1.0; }
2013-10-02 14:05:55 +00:00
var sin = sinAmplitude;
var cos = cosAmplitude;
var frq = frequency * Math.PI / length;
2013-10-02 14:05:55 +00:00
var cosTable = [];
var sinTable = [];
2013-10-02 14:05:55 +00:00
for (var c = 0; c &lt; length; c++) {
cos -= sin * frq;
sin += cos * frq;
cosTable[c] = cos;
sinTable[c] = sin;
}
2013-11-28 15:57:09 +00:00
return { sin: sinTable, cos: cosTable, length: length };
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Moves the element from the start of the array to the end, shifting all items in the process.
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#shift
2014-11-15 20:01:46 +00:00
* @param {any[]} array - The array to shift/rotate. The array is modified.
2013-10-02 14:05:55 +00:00
* @return {any} The shifted value.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ArrayUtils.rotate} instead
2013-10-02 14:05:55 +00:00
*/
2014-11-15 20:01:46 +00:00
shift: function (array) {
2013-10-02 14:05:55 +00:00
2014-11-15 20:01:46 +00:00
var s = array.shift();
array.push(s);
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
return s;
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Shuffles the data in the given array into a new order.
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#shuffleArray
2014-12-03 10:39:11 +00:00
* @param {any[]} array - The array to shuffle
* @return {any[]} The array
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ArrayUtils.shuffle}
2013-10-02 14:05:55 +00:00
*/
shuffleArray: function (array) {
2014-11-15 20:01:46 +00:00
return Phaser.ArrayUtils.shuffle(array);
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2015-01-06 06:57:25 +00:00
* Returns the euclidian distance between the two given set of coordinates.
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#distance
* @param {number} x1
* @param {number} y1
* @param {number} x2
* @param {number} y2
2014-02-05 06:29:17 +00:00
* @return {number} The distance between the two sets of coordinates.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
distance: function (x1, y1, x2, y2) {
var dx = x1 - x2;
var dy = y1 - y2;
return Math.sqrt(dx * dx + dy * dy);
},
2014-02-05 06:29:17 +00:00
/**
* Returns the distance between the two given set of coordinates at the power given.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.Math#distancePow
* @param {number} x1
* @param {number} y1
* @param {number} x2
* @param {number} y2
* @param {number} [pow=2]
* @return {number} The distance between the two sets of coordinates.
*/
distancePow: function (x1, y1, x2, y2, pow) {
if (typeof pow === 'undefined') { pow = 2; }
return Math.sqrt(Math.pow(x2 - x1, pow) + Math.pow(y2 - y1, pow));
},
2013-10-02 14:05:55 +00:00
/**
* Returns the rounded distance between the two given set of coordinates.
*
2013-10-02 14:05:55 +00:00
* @method Phaser.Math#distanceRounded
* @param {number} x1
* @param {number} y1
* @param {number} x2
* @param {number} y2
* @return {number} The distance between this Point object and the destination Point object.
2014-11-15 20:01:46 +00:00
* @deprecated 2.2.0 - Do the rounding locally.
2013-11-28 15:57:09 +00:00
*/
2013-10-02 14:05:55 +00:00
distanceRounded: function (x1, y1, x2, y2) {
2013-11-28 15:57:09 +00:00
return Math.round(Phaser.Math.distance(x1, y1, x2, y2));
2013-10-02 14:05:55 +00:00
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Force a value within the boundaries by clamping `x` to the range `[a, b]`.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#clamp
* @param {number} x
* @param {number} a
* @param {number} b
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2014-11-15 20:01:46 +00:00
clamp: function (x, a, b) {
2013-11-28 15:57:09 +00:00
return ( x &lt; a ) ? a : ( ( x > b ) ? b : x );
},
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* Clamp `x` to the range `[a, Infinity)`.
* Roughly the same as `Math.max(x, a)`, except for NaN handling.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#clampBottom
* @param {number} x
* @param {number} a
2013-10-02 14:05:55 +00:00
* @return {number}
2013-11-28 15:57:09 +00:00
*/
2014-11-15 20:01:46 +00:00
clampBottom: function (x, a) {
2013-11-28 15:57:09 +00:00
return x &lt; a ? a : x;
},
/**
* Checks if two values are within the given tolerance of each other.
*
* @method Phaser.Math#within
* @param {number} a - The first number to check
* @param {number} b - The second number to check
* @param {number} tolerance - The tolerance. Anything equal to or less than this is considered within the range.
* @return {boolean} True if a is &lt;= tolerance of b.
2014-11-15 20:01:46 +00:00
* @see {@link Phaser.Math.fuzzyEqual}
*/
2014-11-15 20:01:46 +00:00
within: function (a, b, tolerance) {
return (Math.abs(a - b) &lt;= tolerance);
},
2013-11-28 15:57:09 +00:00
/**
* Linear mapping from range &lt;a1, a2> to range &lt;b1, b2>
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#mapLinear
* @param {number} x the value to map
* @param {number} a1 first endpoint of the range &lt;a1, a2>
* @param {number} a2 final endpoint of the range &lt;a1, a2>
* @param {number} b1 first endpoint of the range &lt;b1, b2>
* @param {number} b2 final endpoint of the range &lt;b1, b2>
2013-11-28 15:57:09 +00:00
* @return {number}
*/
2014-11-15 20:01:46 +00:00
mapLinear: function (x, a1, a2, b1, b2) {
2013-11-28 15:57:09 +00:00
return b1 + ( x - a1 ) * ( b2 - b1 ) / ( a2 - a1 );
},
/**
* Smoothstep function as detailed at http://en.wikipedia.org/wiki/Smoothstep
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#smoothstep
* @param {number} x
* @param {number} min
* @param {number} max
* @return {number}
*/
2014-11-15 20:01:46 +00:00
smoothstep: function (x, min, max) {
2014-04-29 14:39:02 +00:00
x = Math.max(0, Math.min(1, (x - min) / (max - min)));
2013-11-28 15:57:09 +00:00
return x * x * (3 - 2 * x);
},
/**
2013-10-02 14:05:55 +00:00
* Smootherstep function as detailed at http://en.wikipedia.org/wiki/Smoothstep
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#smootherstep
* @param {number} x
* @param {number} min
* @param {number} max
* @return {number}
*/
2014-11-15 20:01:46 +00:00
smootherstep: function (x, min, max) {
2014-04-29 14:39:02 +00:00
x = Math.max(0, Math.min(1, (x - min) / (max - min)));
2013-11-28 15:57:09 +00:00
return x * x * x * (x * (x * 6 - 15) + 10);
},
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* A value representing the sign of the value: -1 for negative, +1 for positive, 0 if value is 0.
*
* This works differently from `Math.sign` for values of NaN and -0, etc.
*
2013-11-28 15:57:09 +00:00
* @method Phaser.Math#sign
* @param {number} x
2014-11-15 20:01:46 +00:00
* @return {integer} An integer in {-1, 0, 1}
2013-11-28 15:57:09 +00:00
*/
2014-11-15 20:01:46 +00:00
sign: function (x) {
2013-11-28 15:57:09 +00:00
return ( x &lt; 0 ) ? -1 : ( ( x > 0 ) ? 1 : 0 );
},
2013-10-02 14:05:55 +00:00
2014-05-20 09:12:48 +00:00
/**
2014-11-15 20:01:46 +00:00
* Work out what percentage value `a` is of value `b` using the given base.
2014-05-20 09:12:48 +00:00
*
* @method Phaser.Math#percent
* @param {number} a - The value to work out the percentage for.
* @param {number} b - The value you wish to get the percentage of.
* @param {number} [base=0] - The base value.
* @return {number} The percentage a is of b, between 0 and 1.
*/
percent: function (a, b, base) {
if (typeof base === 'undefined') { base = 0; }
if (a > b || base > b)
{
return 1;
}
else if (a &lt; base || base > a)
{
return 0;
}
else
{
return (a - base) / b;
}
2014-11-15 20:01:46 +00:00
}
2013-10-02 14:05:55 +00:00
2014-11-15 20:01:46 +00:00
};
2013-10-02 14:05:55 +00:00
2014-11-15 20:01:46 +00:00
var degreeToRadiansFactor = Math.PI / 180;
var radianToDegreesFactor = 180 / Math.PI;
2013-10-02 14:05:55 +00:00
2014-11-15 20:01:46 +00:00
/**
* Convert degrees to radians.
*
* @method Phaser.Math#degToRad
* @param {number} degrees - Angle in degrees.
* @return {number} Angle in radians.
*/
Phaser.Math.degToRad = function degToRad (degrees) {
return degrees * degreeToRadiansFactor;
};
2013-10-02 14:05:55 +00:00
2014-11-15 20:01:46 +00:00
/**
* Convert degrees to radians.
*
* @method Phaser.Math#radToDeg
* @param {number} radians - Angle in radians.
* @return {number} Angle in degrees
*/
Phaser.Math.radToDeg = function radToDeg (radians) {
return radians * radianToDegreesFactor;
2014-09-09 14:36:56 +00:00
};
</pre>
2013-10-02 14:05:55 +00:00
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2015-03-23 23:46:30 +00:00
Phaser Copyright © 2012-2015 Photon Storm Ltd.
2013-10-02 14:05:55 +00:00
</span>
<br />
<span class="jsdoc-message">
2015-03-23 23:46:30 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a>
2015-03-26 02:38:46 +00:00
on Thu Mar 26 2015 02:37:58 GMT+0000 (GMT Standard Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-10-02 14:05:55 +00:00
</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( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-02 14:05:55 +00:00
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>