mirror of
https://github.com/photonstorm/phaser
synced 2025-01-10 04:08:50 +00:00
33 lines
1.2 KiB
JavaScript
33 lines
1.2 KiB
JavaScript
/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2020 Photon Storm Ltd.
|
|
* @license {@link https://opensource.org/licenses/MIT|MIT License}
|
|
*/
|
|
|
|
var Point = require('../point/Point');
|
|
|
|
/**
|
|
* Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.
|
|
*
|
|
* @function Phaser.Geom.Circle.CircumferencePoint
|
|
* @since 3.0.0
|
|
*
|
|
* @generic {Phaser.Geom.Point} O - [out,$return]
|
|
*
|
|
* @param {Phaser.Geom.Circle} circle - The Circle to get the circumference point on.
|
|
* @param {number} angle - The angle from the center of the Circle to the circumference to return the point from. Given in radians.
|
|
* @param {(Phaser.Geom.Point|object)} [out] - A Point, or point-like object, to store the results in. If not given a Point will be created.
|
|
*
|
|
* @return {(Phaser.Geom.Point|object)} A Point object where the `x` and `y` properties are the point on the circumference.
|
|
*/
|
|
var CircumferencePoint = function (circle, angle, out)
|
|
{
|
|
if (out === undefined) { out = new Point(); }
|
|
|
|
out.x = circle.x + (circle.radius * Math.cos(angle));
|
|
out.y = circle.y + (circle.radius * Math.sin(angle));
|
|
|
|
return out;
|
|
};
|
|
|
|
module.exports = CircumferencePoint;
|