phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
34 lines (28 loc) • 1.24 kB
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2025 Phaser Studio Inc.
* @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;