2013-10-02 11:11:22 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Point< / 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" >
2013-10-03 01:38:35 +00:00
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
2013-10-02 11:11:22 +00:00
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-02 11:11:22 +00:00
< / 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 >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-02 11:11:22 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-02 11:11:22 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-02 11:11:22 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-02 11:11:22 +00:00
< / li >
2013-10-02 14:05:55 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-02 14:05:55 +00:00
< / li >
2013-10-02 11:11:22 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-02 11:11:22 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-10-02 11:11:22 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-02 11:11:22 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2013-10-02 14:05:55 +00:00
< 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 >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-02 14:05:55 +00:00
< / 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 >
2013-10-02 11:11:22 +00:00
< / li >
2013-10-02 19:18:24 +00:00
< 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 >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2013-10-02 14:05:55 +00:00
< 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 >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.StageScaleMode.html" > StageScaleMode< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
2013-10-03 01:38:35 +00:00
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "global.html#HEXtoRGB" > HEXtoRGB< / a >
< / li >
< / ul >
< / li >
2013-10-02 11:11:22 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Point< / h1 >
< section >
< header >
< h2 >
2013-10-03 01:38:35 +00:00
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
2013-10-02 11:11:22 +00:00
Point
< / h2 >
< div class = "class-description" > < p > The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis.< / p > < / div >
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Point" > < span class = "type-signature" > < / span > new Point< span class = "signature" > (x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Creates a new Point. If you pass no parameters a Point is created set to (0,0).< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The horizontal position of this Point (default 0)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The vertical position of this Point (default 0)< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-15" > line 15< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
< h4 class = "name" id = "x" > < span class = "type-signature" > < / span > x< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate of the point.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-23" > line 23< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "y" > < span class = "type-signature" > < / span > y< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The y coordinate of the point.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-28" > line 28< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "add" > < span class = "type-signature" > < static> < / span > add< span class = "signature" > (a, b, < span class = "optional" > out< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds the coordinates of two points together to create a new point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The first Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > b< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The second Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > out< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional Point to store the value in, if not supplied a new Point object will be created.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-258" > line 258< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The new Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "distance" > < span class = "type-signature" > < static> < / span > distance< span class = "signature" > (a, b, < span class = "optional" > round< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the distance of this Point object to the given object (can be a Circle, Point or anything with x/y properties).< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The target object. Must have visible x and y properties that represent the center of the object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > b< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The target object. Must have visible x and y properties that represent the center of the object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > round< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Round the distance to the nearest integer (default false).< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-345" > line 345< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The distance between this Point object and the destination Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "divide" > < span class = "type-signature" > < static> < / span > divide< span class = "signature" > (a, b, < span class = "optional" > out< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Divides the coordinates of two points to create a new point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The first Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > b< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The second Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > out< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional Point to store the value in, if not supplied a new Point object will be created.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-315" > line 315< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The new Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "equals" > < span class = "type-signature" > < static> < / span > equals< span class = "signature" > (a, b)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Determines whether the two given Point objects are equal. They are considered equal if they have the same x and y values.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The first Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > b< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The second Point object.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-334" > line 334< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A value of true if the Points are equal, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "multiply" > < span class = "type-signature" > < static> < / span > multiply< span class = "signature" > (a, b, < span class = "optional" > out< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Multiplies the coordinates of two points to create a new point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The first Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > b< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The second Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > out< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional Point to store the value in, if not supplied a new Point object will be created.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-296" > line 296< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The new Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "rotate" > < span class = "type-signature" > < static> < / span > rotate< span class = "signature" > (a, x, y, angle, asDegrees, distance)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Rotates a Point around the x/y coordinates given to the desired angle.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The Point object to rotate.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate of the anchor point< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The y coordinate of the anchor point< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > angle< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The angle in radians (unless asDegrees is true) to rotate the Point to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > asDegrees< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Is the given rotation in radians (false) or degrees (true)?< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > distance< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > An optional distance constraint between the Point and the anchor.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-368" > line 368< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The modified point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "subtract" > < span class = "type-signature" > < static> < / span > subtract< span class = "signature" > (a, b, < span class = "optional" > out< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Subtracts the coordinates of two points to create a new point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The first Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > b< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The second Point object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > out< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional Point to store the value in, if not supplied a new Point object will be created.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-277" > line 277< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The new Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "add" > < span class = "type-signature" > < / span > add< span class = "signature" > (x, y)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds the given x and y values to this Point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to add to Point.x.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to add to Point.y.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-68" > line 68< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object. Useful for chaining method calls.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clamp" > < span class = "type-signature" > < / span > clamp< span class = "signature" > (min, max)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Clamps this Point object values to be between the given min and max.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > min< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The minimum value to clamp this Point to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > max< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The maximum value to clamp this Point to.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-156" > line 156< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clampX" > < span class = "type-signature" > < / span > clampX< span class = "signature" > (min, max)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Clamps the x value of this Point to be between the given min and max.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > min< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The minimum value to clamp this Point to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > max< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The maximum value to clamp this Point to.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-128" > line 128< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clampY" > < span class = "type-signature" > < / span > clampY< span class = "signature" > (min, max)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Clamps the y value of this Point to be between the given min and max< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > min< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The minimum value to clamp this Point to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > max< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The maximum value to clamp this Point to.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-142" > line 142< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "clone" > < span class = "type-signature" > < / span > clone< span class = "signature" > (< span class = "optional" > output< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Creates a copy of the given Point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > output< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional Point object. If given the values will be set into this object, otherwise a brand new Point object will be created and returned.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-171" > line 171< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The new Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "copyFrom" > < span class = "type-signature" > < / span > copyFrom< span class = "signature" > (source)< / span > < span class = "type-signature" > → {Point}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Copies the x and y properties from any given object to this Point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > source< / code > < / td >
< td class = "type" >
< span class = "param-type" > any< / span >
< / td >
< td class = "description last" > < p > The object to copy from.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-34" > line 34< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Point< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "copyFrom" > < span class = "type-signature" > < / span > copyFrom< span class = "signature" > (source)< / span > < span class = "type-signature" > → {Point}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Copies the x and y properties from any given object to this Point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > source< / code > < / td >
< td class = "type" >
< span class = "param-type" > any< / span >
< / td >
< td class = "description last" > < p > The object to copy from.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-185" > line 185< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Point< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "copyTo" > < span class = "type-signature" > < / span > copyTo< span class = "signature" > (dest)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Copies the x and y properties from this Point to any given object.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > dest< / code > < / td >
< td class = "type" >
< span class = "param-type" > any< / span >
< / td >
< td class = "description last" > < p > The object to copy to.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-195" > line 195< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The dest object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Object< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "distance" > < span class = "type-signature" > < / span > distance< span class = "signature" > (dest, < span class = "optional" > round< / span > )< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the distance of this Point object to the given object (can be a Circle, Point or anything with x/y properties)< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > dest< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The target object. Must have visible x and y properties that represent the center of the object.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > round< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Round the distance to the nearest integer (default false).< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-210" > line 210< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The distance between this Point object and the destination Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "divide" > < span class = "type-signature" > < / span > divide< span class = "signature" > (x, y)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Divides Point.x and Point.y by the given x and y values.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to divide Point.x by.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to divide Point.x by.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-113" > line 113< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object. Useful for chaining method calls.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "equals" > < span class = "type-signature" > < / span > equals< span class = "signature" > (a)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Determines whether the given objects x/y values are equal to this Point object.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > a< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The first object to compare.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-223" > line 223< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A value of true if the Points are equal, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "invert" > < span class = "type-signature" > < / span > invert< span class = "signature" > ()< / span > < span class = "type-signature" > → {Point}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Inverts the x and y values of this Point< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-44" > line 44< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Point< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "multiply" > < span class = "type-signature" > < / span > multiply< span class = "signature" > (x, y)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Multiplies Point.x and Point.y by the given x and y values.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to multiply Point.x by.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to multiply Point.x by.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-98" > line 98< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object. Useful for chaining method calls.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "rotate" > < span class = "type-signature" > < / span > rotate< span class = "signature" > (x, y, angle, asDegrees, < span class = "optional" > distance< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Rotates this Point around the x/y coordinates given to the desired angle.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The x coordinate of the anchor point< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The y coordinate of the anchor point< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > angle< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The angle in radians (unless asDegrees is true) to rotate the Point to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > asDegrees< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Is the given rotation in radians (false) or degrees (true)?< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > distance< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > An optional distance constraint between the Point and the anchor.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-233" > line 233< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The modified point object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setTo" > < span class = "type-signature" > < / span > setTo< span class = "signature" > (x, y)< / span > < span class = "type-signature" > → {Point}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets the x and y values of this Point object to the given coordinates.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The horizontal position of this point.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The vertical position of this point.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-53" > line 53< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object. Useful for chaining method calls.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Point< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "subtract" > < span class = "type-signature" > < / span > subtract< span class = "signature" > (x, y)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Subtracts the given x and y values from this Point.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to subtract from Point.x.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The value to subtract from Point.y.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-83" > line 83< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > This Point object. Useful for chaining method calls.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "toString" > < span class = "type-signature" > < / span > toString< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns a string representation of this object.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-23 13:00:28 +00:00
< a href = "Point.js.html" > geom/Point.js< / a > , < a href = "Point.js.html#sunlight-1-line-247" > line 247< / a >
2013-10-02 11:11:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A string representation of the instance.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< / dd >
< / dl >
< / 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 >
2013-10-23 13:00:28 +00:00
on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-02 11:11:22 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / 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 >
