phaser/src/math/Vector2.js

545 lines
10 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
// Adapted from [gl-matrix](https://github.com/toji/gl-matrix) by toji
// and [vecmath](https://github.com/mattdesl/vecmath) by mattdesl
2017-09-15 03:04:51 +00:00
var Class = require('../utils/Class');
2018-01-31 17:48:30 +00:00
/**
2018-02-07 15:27:21 +00:00
* @classdesc
2018-01-31 17:48:30 +00:00
* [description]
*
* @class Vector2
* @memberOf Phaser.Math
* @constructor
* @since 3.0.0
*
* @param {number} [x] - [description]
* @param {number} [y] - [description]
*/
2017-09-15 03:04:51 +00:00
var Vector2 = new Class({
initialize:
function Vector2 (x, y)
{
2018-02-07 15:27:21 +00:00
/**
* The x component of this Vector.
*
* @name Phaser.Math.Vector2#x
* @type {number}
* @default 0
* @since 3.0.0
*/
/**
* The y component of this Vector.
*
* @name Phaser.Math.Vector2#y
* @type {number}
* @default 0
* @since 3.0.0
*/
if (typeof x === 'object')
{
this.x = x.x || 0;
this.y = x.y || 0;
}
else
{
2017-10-17 03:18:29 +00:00
if (y === undefined) { y = x; }
this.x = x || 0;
this.y = y || 0;
}
2017-09-15 03:04:51 +00:00
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#clone
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} A clone of this Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
clone: function ()
{
return new Vector2(this.x, this.y);
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#copy
* @since 3.0.0
*
* @param {Phaser.Math.Vector2|object} src - [description]
2018-01-26 06:19:27 +00:00
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
copy: function (src)
{
this.x = src.x || 0;
this.y = src.y || 0;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#setFromObject
* @since 3.0.0
*
* @param {[type]} obj - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
setFromObject: function (obj)
{
this.x = obj.x || 0;
this.y = obj.y || 0;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#set
* @since 3.0.0
*
* @param {[type]} x - [description]
* @param {[type]} y - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
set: function (x, y)
{
if (y === undefined) { y = x; }
this.x = x;
this.y = y;
2017-09-15 03:04:51 +00:00
return this;
},
2017-11-09 15:30:33 +00:00
// Sets the `x` and `y` values of this object from a given polar coordinate.
// @param {number} azimuth - The angular coordinate, in radians.
// @param {number} [radius=1] - The radial coordinate (length).
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#setToPolar
* @since 3.0.0
*
* @param {[type]} azimuth - [description]
* @param {[type]} radius - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-11-09 15:30:33 +00:00
setToPolar: function (azimuth, radius)
{
if (radius == null) { radius = 1; }
this.x = Math.cos(azimuth) * radius;
this.y = Math.sin(azimuth) * radius;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#equals
* @since 3.0.0
*
* @param {[type]} v - [description]
*
2018-02-07 15:27:21 +00:00
* @return {boolean} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-21 16:11:56 +00:00
equals: function (v)
{
return ((this.x === v.x) && (this.y === v.y));
},
2017-09-20 22:10:03 +00:00
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#angle
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-21 16:11:56 +00:00
angle: function ()
{
2017-09-20 22:10:03 +00:00
// computes the angle in radians with respect to the positive x-axis
var angle = Math.atan2(this.y, this.x);
if (angle < 0)
{
angle += 2 * Math.PI;
}
return angle;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#add
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
add: function (src)
{
this.x += src.x;
this.y += src.y;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#subtract
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
subtract: function (src)
{
this.x -= src.x;
this.y -= src.y;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#multiply
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
multiply: function (src)
{
this.x *= src.x;
this.y *= src.y;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#scale
* @since 3.0.0
*
* @param {[type]} value - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
scale: function (value)
{
if (isFinite(value))
{
this.x *= value;
this.y *= value;
}
else
{
this.x = 0;
this.y = 0;
}
2017-09-15 03:04:51 +00:00
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#divide
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
divide: function (src)
{
this.x /= src.x;
this.y /= src.y;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#negate
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
negate: function ()
{
this.x = -this.x;
this.y = -this.y;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#distance
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
distance: function (src)
{
var dx = src.x - this.x;
var dy = src.y - this.y;
return Math.sqrt(dx * dx + dy * dy);
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#distanceSq
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
distanceSq: function (src)
{
var dx = src.x - this.x;
var dy = src.y - this.y;
return dx * dx + dy * dy;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#length
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
length: function ()
{
var x = this.x;
var y = this.y;
return Math.sqrt(x * x + y * y);
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#lengthSq
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
lengthSq: function ()
{
var x = this.x;
var y = this.y;
return x * x + y * y;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#normalize
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
normalize: function ()
{
var x = this.x;
var y = this.y;
var len = x * x + y * y;
if (len > 0)
{
len = 1 / Math.sqrt(len);
this.x = x * len;
this.y = y * len;
}
return this;
},
2017-09-21 01:03:37 +00:00
/**
* Right-hand normalize (make unit length) this Vector
*/
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#normalizeRightHand
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-21 01:03:37 +00:00
normalizeRightHand: function ()
{
var x = this.x;
this.x = this.y * -1;
this.y = x;
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#dot
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
dot: function (src)
{
return this.x * src.x + this.y * src.y;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#cross
* @since 3.0.0
*
* @param {[type]} src - [description]
*
2018-02-07 15:27:21 +00:00
* @return {number} [description]
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
cross: function (src)
{
return this.x * src.y - this.y * src.x;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#lerp
* @since 3.0.0
*
* @param {[type]} src - [description]
* @param {[type]} t - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
lerp: function (src, t)
{
if (t === undefined) { t = 0; }
var ax = this.x;
var ay = this.y;
this.x = ax + t * (src.x - ax);
this.y = ay + t * (src.y - ay);
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#transformMat3
* @since 3.0.0
*
* @param {[type]} mat - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
transformMat3: function (mat)
{
var x = this.x;
var y = this.y;
var m = mat.val;
this.x = m[0] * x + m[3] * y + m[6];
this.y = m[1] * x + m[4] * y + m[7];
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#transformMat4
* @since 3.0.0
*
* @param {[type]} mat - [description]
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
2017-09-15 03:04:51 +00:00
transformMat4: function (mat)
{
var x = this.x;
var y = this.y;
var m = mat.val;
this.x = m[0] * x + m[4] * y + m[12];
this.y = m[1] * x + m[5] * y + m[13];
return this;
},
2018-01-26 06:19:27 +00:00
/**
* [description]
*
* @method Phaser.Math.Vector2#reset
* @since 3.0.0
*
2018-02-07 15:27:21 +00:00
* @return {Phaser.Math.Vector2} This Vector2.
2018-01-26 06:19:27 +00:00
*/
reset: function ()
2017-09-15 03:04:51 +00:00
{
this.x = 0;
this.y = 0;
return this;
}
});
/**
* A static zero Vector2 for use by reference.
*
* @method Phaser.Math.Vector2.ZERO
* @since 3.0.1
*/
Vector2.ZERO = new Vector2();
2017-09-15 03:04:51 +00:00
module.exports = Vector2;