Area

staticArea(circle)

Description:

Calculates the area of the circle.

Parameters:

Returns: number - The area of the Circle.

Source: src/geom/circle/Area.js#L7
Since: 3.0.0

Circumference

staticCircumference(circle)

Description:

Returns the circumference of the given Circle.

Parameters:

Returns: number - The circumference of the Circle.

Source: src/geom/circle/Circumference.js#L7
Since: 3.0.0

CircumferencePoint

staticCircumferencePoint(circle, angle, [out])

Description:

Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point object where the x and y properties are the point on the circumference.

Source: src/geom/circle/CircumferencePoint.js#L9
Since: 3.0.0

Clone

staticClone(source)

Description:

Creates a new Circle instance based on the values contained in the given source.

Parameters:

Returns: Phaser.Geom.Circle - A clone of the source Circle.

Source: src/geom/circle/Clone.js#L9
Since: 3.0.0

Contains

staticContains(circle, x, y)

Description:

Check to see if the Circle contains the given x / y coordinates.

Parameters:

Returns: boolean - True if the coordinates are within the circle, otherwise false.

Source: src/geom/circle/Contains.js#L7
Since: 3.0.0

ContainsPoint

staticContainsPoint(circle, point)

Description:

Check to see if the Circle contains the given Point object.

Parameters:

Returns: boolean - True if the Point coordinates are within the circle, otherwise false.

Source: src/geom/circle/ContainsPoint.js#L9
Since: 3.0.0

ContainsRect

staticContainsRect(circle, rect)

Description:

Check to see if the Circle contains all four points of the given Rectangle object.

Parameters:

Returns: boolean - True if all of the Rectangle coordinates are within the circle, otherwise false.

Source: src/geom/circle/ContainsRect.js#L9
Since: 3.0.0

CopyFrom

staticCopyFrom(source, dest)

Description:

Copies the x, y and radius properties from the source Circle

into the given dest Circle, then returns the dest Circle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Circle - The destination Circle.

Source: src/geom/circle/CopyFrom.js#L7
Since: 3.0.0

Equals

staticEquals(circle, toCompare)

Description:

Compares the x, y and radius properties of the two given Circles.

Returns true if they all match, otherwise returns false.

Parameters:

Returns: boolean - true if the two Circles equal each other, otherwise false.

Source: src/geom/circle/Equals.js#L7
Since: 3.0.0

GetBounds

staticGetBounds(circle, [out])

Description:

Returns the bounds of the Circle object.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle, object - The Rectangle object containing the Circles bounds.

Source: src/geom/circle/GetBounds.js#L9
Since: 3.0.0

GetPoint

staticGetPoint(circle, position, [out])

Description:

Returns a Point object containing the coordinates of a point on the circumference of the Circle

based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point

at 180 degrees around the circle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point, or point-like object, containing the coordinates of the point around the circle.

Source: src/geom/circle/GetPoint.js#L12
Since: 3.0.0

GetPoints

staticGetPoints(circle, quantity, [stepRate], [output])

Description:

Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,

based on the given quantity or stepRate values.

Parameters:

Returns: Array.<Phaser.Geom.Point> - An array of Point objects pertaining to the points around the circumference of the circle.

Source: src/geom/circle/GetPoints.js#L12
Since: 3.0.0

Offset

staticOffset(circle, x, y)

Description:

Offsets the Circle by the values given.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Circle - The Circle that was offset.

Source: src/geom/circle/Offset.js#L7
Since: 3.0.0

OffsetPoint

staticOffsetPoint(circle, point)

Description:

Offsets the Circle by the values given in the x and y properties of the Point object.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Circle - The Circle that was offset.

Source: src/geom/circle/OffsetPoint.js#L7
Since: 3.0.0

Random

staticRandom(circle, [out])

Description:

Returns a uniformly distributed random point from anywhere within the given Circle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point object with the random values set in the x and y properties.

Source: src/geom/circle/Random.js#L9
Since: 3.0.0

Phaser.Geom.Ellipse

Area

staticArea(ellipse)

Description:

Calculates the area of the Ellipse.

Parameters:

Returns: number - The area of the Ellipse.

Source: src/geom/ellipse/Area.js#L7
Since: 3.0.0

Circumference

staticCircumference(ellipse)

Description:

Returns the circumference of the given Ellipse.

Parameters:

Returns: number - The circumference of th Ellipse.

Source: src/geom/ellipse/Circumference.js#L7
Since: 3.0.0

CircumferencePoint

staticCircumferencePoint(ellipse, angle, [out])

Description:

Returns a Point object containing the coordinates of a point on the circumference of the Ellipse based on the given angle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point object where the x and y properties are the point on the circumference.

Source: src/geom/ellipse/CircumferencePoint.js#L9
Since: 3.0.0

Clone

staticClone(source)

Description:

Creates a new Ellipse instance based on the values contained in the given source.

Parameters:

Returns: Phaser.Geom.Ellipse - A clone of the source Ellipse.

Source: src/geom/ellipse/Clone.js#L9
Since: 3.0.0

Contains

staticContains(ellipse, x, y)

Description:

Check to see if the Ellipse contains the given x / y coordinates.

Parameters:

Returns: boolean - True if the coordinates are within the ellipse, otherwise false.

Source: src/geom/ellipse/Contains.js#L7
Since: 3.0.0

ContainsPoint

staticContainsPoint(ellipse, point)

Description:

Check to see if the Ellipse contains the given Point object.

Parameters:

Returns: boolean - True if the Point coordinates are within the circle, otherwise false.

Source: src/geom/ellipse/ContainsPoint.js#L9
Since: 3.0.0

ContainsRect

staticContainsRect(ellipse, rect)

Description:

Check to see if the Ellipse contains all four points of the given Rectangle object.

Parameters:

Returns: boolean - True if all of the Rectangle coordinates are within the ellipse, otherwise false.

Source: src/geom/ellipse/ContainsRect.js#L9
Since: 3.0.0

CopyFrom

staticCopyFrom(source, dest)

Description:

Copies the x, y, width and height properties from the source Ellipse

into the given dest Ellipse, then returns the dest Ellipse.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Ellipse - The destination Ellipse.

Source: src/geom/ellipse/CopyFrom.js#L7
Since: 3.0.0

Equals

staticEquals(ellipse, toCompare)

Description:

Compares the x, y, width and height properties of the two given Ellipses.

Returns true if they all match, otherwise returns false.

Parameters:

Returns: boolean - true if the two Ellipse equal each other, otherwise false.

Source: src/geom/ellipse/Equals.js#L7
Since: 3.0.0

GetBounds

staticGetBounds(ellipse, [out])

Description:

Returns the bounds of the Ellipse object.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle, object - The Rectangle object containing the Ellipse bounds.

Source: src/geom/ellipse/GetBounds.js#L9
Since: 3.0.0

GetPoint

staticGetPoint(ellipse, position, [out])

Description:

Returns a Point object containing the coordinates of a point on the circumference of the Ellipse

based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point

at 180 degrees around the circle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point, or point-like object, containing the coordinates of the point around the ellipse.

Source: src/geom/ellipse/GetPoint.js#L12
Since: 3.0.0

GetPoints

staticGetPoints(ellipse, quantity, [stepRate], [out])

Description:

Returns an array of Point objects containing the coordinates of the points around the circumference of the Ellipse,

based on the given quantity or stepRate values.

Tags:

• generic

Parameters:

Returns: array, Array.<Phaser.Geom.Point> - An array of Point objects pertaining to the points around the circumference of the ellipse.

Source: src/geom/ellipse/GetPoints.js#L12
Since: 3.0.0

Offset

staticOffset(ellipse, x, y)

Description:

Offsets the Ellipse by the values given.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Ellipse - The Ellipse that was offset.

Source: src/geom/ellipse/Offset.js#L7
Since: 3.0.0

OffsetPoint

staticOffsetPoint(ellipse, point)

Description:

Offsets the Ellipse by the values given in the x and y properties of the Point object.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Ellipse - The Ellipse that was offset.

Source: src/geom/ellipse/OffsetPoint.js#L7
Since: 3.0.0

Random

staticRandom(ellipse, [out])

Description:

Returns a uniformly distributed random point from anywhere within the given Ellipse.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point object with the random values set in the x and y properties.

Source: src/geom/ellipse/Random.js#L9
Since: 3.0.0

Phaser.Geom.Intersects

CircleToCircle

staticCircleToCircle(circleA, circleB)

Description:

Checks if two Circles intersect.

Parameters:

Returns: boolean - true if the two Circles intersect, otherwise false.

Source: src/geom/intersects/CircleToCircle.js#L9
Since: 3.0.0

CircleToRectangle

staticCircleToRectangle(circle, rect)

Description:

Checks for intersection between a circle and a rectangle.

Parameters:

Returns: boolean - true if the two objects intersect, otherwise false.

Source: src/geom/intersects/CircleToRectangle.js#L7
Since: 3.0.0

GetCircleToCircle

staticGetCircleToCircle(circleA, circleB, [out])

Description:

Checks if two Circles intersect and returns the intersection points as a Point object array.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetCircleToCircle.js#L11
Since: 3.0.0

GetCircleToRectangle

staticGetCircleToRectangle(circle, rect, [out])

Description:

Checks for intersection between a circle and a rectangle,

and returns the intersection points as a Point object array.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetCircleToRectangle.js#L11
Since: 3.0.0

GetLineToCircle

staticGetLineToCircle(line, circle, [out])

Description:

Checks for intersection between the line segment and circle,

and returns the intersection points as a Point object array.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetLineToCircle.js#L11
Since: 3.0.0

GetLineToLine

staticGetLineToLine(line1, line2, [isRay], [out])

Description:

Checks for intersection between the two line segments, or a ray and a line segment,

and returns the intersection point as a Vector3, or null if the lines are parallel, or do not intersect.

The z property of the Vector3 contains the intersection distance, which can be used to find

the closest intersecting point from a group of line segments.

Parameters:

Returns: Phaser.Math.Vector3 - A Vector3 containing the intersection results, or null.

Source: src/geom/intersects/GetLineToLine.js#L9
Since: 3.50.0

GetLineToPoints

staticGetLineToPoints(line, points, [isRay], [out])

Description:

Checks for the closest point of intersection between a line segment and an array of points, where each pair

of points are converted to line segments for the intersection tests.

If no intersection is found, this function returns null.

If intersection was found, a Vector3 is returned with the following properties:

The x and y components contain the point of the intersection.

The z component contains the closest distance.

Parameters:

Returns: Phaser.Math.Vector3 - A Vector3 containing the intersection results, or null.

Source: src/geom/intersects/GetLineToPoints.js#L17
Since: 3.50.0

GetLineToPolygon

staticGetLineToPolygon(line, polygons, [isRay], [out])

Description:

Checks for the closest point of intersection between a line segment and an array of polygons.

If no intersection is found, this function returns null.

If intersection was found, a Vector4 is returned with the following properties:

The x and y components contain the point of the intersection.

The z component contains the closest distance.

The w component contains the index of the polygon, in the given array, that triggered the intersection.

Parameters:

Returns: Phaser.Math.Vector4 - A Vector4 containing the intersection results, or null.

Source: src/geom/intersects/GetLineToPolygon.js#L14
Since: 3.50.0

GetLineToRectangle

staticGetLineToRectangle(line, rect, [out])

Description:

Checks for intersection between the Line and a Rectangle shape,

and returns the intersection points as a Point object array.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetLineToRectangle.js#L12
Since: 3.0.0

GetRaysFromPointToPolygon

staticGetRaysFromPointToPolygon(x, y, polygons)

Description:

Projects rays out from the given point to each line segment of the polygons.

If the rays intersect with the polygons, the points of intersection are returned in an array.

If no intersections are found, the returned array will be empty.

Each Vector4 intersection result has the following properties:

The x and y components contain the point of the intersection.

The z component contains the angle of intersection.

The w component contains the index of the polygon, in the given array, that triggered the intersection.

Parameters:

Returns: Array.<Phaser.Math.Vector4> - An array containing all intersections in Vector4s.

Source: src/geom/intersects/GetRaysFromPointToPolygon.js#L40
Since: 3.50.0

GetRectangleIntersection

staticGetRectangleIntersection(rectA, rectB, [output])

Description:

Checks if two Rectangle shapes intersect and returns the area of this intersection as Rectangle object.

If optional output parameter is omitted, new Rectangle object is created and returned. If there is intersection, it will contain intersection area. If there is no intersection, it wil be empty Rectangle (all values set to zero).

If Rectangle object is passed as output and there is intersection, then intersection area data will be loaded into it and it will be returned. If there is no intersection, it will be returned without any change.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - A rectangle object with intersection data.

Source: src/geom/intersects/GetRectangleIntersection.js#L10
Since: 3.0.0

GetRectangleToRectangle

staticGetRectangleToRectangle(rectA, rectB, [out])

Description:

Checks if two Rectangles intersect and returns the intersection points as a Point object array.

A Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds. As such, the two Rectangles are considered "solid". A Rectangle with no width or no height will never intersect another Rectangle.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetRectangleToRectangle.js#L11
Since: 3.0.0

GetRectangleToTriangle

staticGetRectangleToTriangle(rect, triangle, [out])

Description:

Checks for intersection between Rectangle shape and Triangle shape,

and returns the intersection points as a Point object array.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetRectangleToTriangle.js#L11
Since: 3.0.0

GetTriangleToCircle

staticGetTriangleToCircle(triangle, circle, [out])

Description:

Checks if a Triangle and a Circle intersect, and returns the intersection points as a Point object array.

A Circle intersects a Triangle if its center is located within it or if any of the Triangle's sides intersect the Circle. As such, the Triangle and the Circle are considered "solid" for the intersection.

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetTriangleToCircle.js#L11
Since: 3.0.0

GetTriangleToLine

staticGetTriangleToLine(triangle, line, [out])

Description:

Checks if a Triangle and a Line intersect, and returns the intersection points as a Point object array.

The Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered "solid".

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetTriangleToLine.js#L12
Since: 3.0.0

GetTriangleToTriangle

staticGetTriangleToTriangle(triangleA, triangleB, [out])

Description:

Checks if two Triangles intersect, and returns the intersection points as a Point object array.

A Triangle intersects another Triangle if any pair of their lines intersects or if any point of one Triangle is within the other Triangle. Thus, the Triangles are considered "solid".

Parameters:

Returns: array - An array with the points of intersection if objects intersect, otherwise an empty array.

Source: src/geom/intersects/GetTriangleToTriangle.js#L11
Since: 3.0.0

LineToCircle

staticLineToCircle(line, circle, [nearest])

Description:

Checks for intersection between the line segment and circle.

Based on code by Matt DesLauriers.

Parameters:

Returns: boolean - true if the two objects intersect, otherwise false.

Source: src/geom/intersects/LineToCircle.js#L12
Since: 3.0.0

LineToLine

staticLineToLine(line1, line2, [out])

Description:

Checks if two Lines intersect. If the Lines are identical, they will be treated as parallel and thus non-intersecting.

Parameters:

Returns: boolean - true if the two Lines intersect, and the out object will be populated, if given. Otherwise, false.

Source: src/geom/intersects/LineToLine.js#L10
Since: 3.0.0

LineToRectangle

staticLineToRectangle(line, rect)

Description:

Checks for intersection between the Line and a Rectangle shape, or a rectangle-like

object, with public x, y, right and bottom properties, such as a Sprite or Body.

An intersection is considered valid if:

The line starts within, or ends within, the Rectangle.

The line segment intersects one of the 4 rectangle edges.

The for the purposes of this function rectangles are considered 'solid'.

Parameters:

Returns: boolean - true if the Line and the Rectangle intersect, false otherwise.

Source: src/geom/intersects/LineToRectangle.js#L7
Since: 3.0.0

PointToLine

staticPointToLine(point, line, [lineThickness])

Description:

Checks if the a Point falls between the two end-points of a Line, based on the given line thickness.

Assumes that the line end points are circular, not square.

Parameters:

Returns: boolean - true if the Point falls on the Line, otherwise false.

Source: src/geom/intersects/PointToLine.js#L8
Since: 3.0.0

PointToLineSegment

staticPointToLineSegment(point, line)

Description:

Checks if a Point is located on the given line segment.

Parameters:

Returns: boolean - true if the Point is on the given line segment, otherwise false.

Source: src/geom/intersects/PointToLineSegment.js#L9
Since: 3.0.0

RectangleToRectangle

staticRectangleToRectangle(rectA, rectB)

Description:

Checks if two Rectangles intersect.

A Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds.

As such, the two Rectangles are considered "solid".

A Rectangle with no width or no height will never intersect another Rectangle.

Parameters:

Returns: boolean - true if the two Rectangles intersect, otherwise false.

Source: src/geom/intersects/RectangleToRectangle.js#L7
Since: 3.0.0

RectangleToTriangle

staticRectangleToTriangle(rect, triangle)

Description:

Checks for intersection between Rectangle shape and Triangle shape.

Parameters:

Returns: boolean - A value of true if objects intersect; otherwise false.

Source: src/geom/intersects/RectangleToTriangle.js#L12
Since: 3.0.0

RectangleToValues

staticRectangleToValues(rect, left, right, top, bottom, [tolerance])

Description:

Check if rectangle intersects with values.

Parameters:

Returns: boolean - Returns true if there is an intersection.

Source: src/geom/intersects/RectangleToValues.js#L7
Since: 3.0.0

TriangleToCircle

staticTriangleToCircle(triangle, circle)

Description:

Checks if a Triangle and a Circle intersect.

A Circle intersects a Triangle if its center is located within it or if any of the Triangle's sides intersect the Circle. As such, the Triangle and the Circle are considered "solid" for the intersection.

Parameters:

Returns: boolean - true if the Triangle and the Circle intersect, otherwise false.

Source: src/geom/intersects/TriangleToCircle.js#L10
Since: 3.0.0

TriangleToLine

staticTriangleToLine(triangle, line)

Description:

Checks if a Triangle and a Line intersect.

The Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered "solid".

Parameters:

Returns: boolean - true if the Triangle and the Line intersect, otherwise false.

Source: src/geom/intersects/TriangleToLine.js#L9
Since: 3.0.0

TriangleToTriangle

staticTriangleToTriangle(triangleA, triangleB)

Description:

Checks if two Triangles intersect.

A Triangle intersects another Triangle if any pair of their lines intersects or if any point of one Triangle is within the other Triangle. Thus, the Triangles are considered "solid".

Parameters:

Returns: boolean - true if the Triangles intersect, otherwise false.

Source: src/geom/intersects/TriangleToTriangle.js#L11
Since: 3.0.0

Phaser.Geom.Line

Angle

staticAngle(line)

Description:

Calculate the angle of the line in radians.

Parameters:

Returns: number - The angle of the line, in radians.

Source: src/geom/line/Angle.js#L7
Since: 3.0.0

BresenhamPoints

staticBresenhamPoints(line, [stepRate], [results])

Description:

Using Bresenham's line algorithm this will return an array of all coordinates on this line.

The start and end points are rounded before this runs as the algorithm works on integers.

Parameters:

Returns: Array.<Phaser.Types.Math.Vector2Like> - The array of coordinates on the line.

Source: src/geom/line/BresenhamPoints.js#L7
Since: 3.0.0

CenterOn

staticCenterOn(line, x, y)

Description:

Center a line on the given coordinates.

Parameters:

Returns: Phaser.Geom.Line - The centered line.

Source: src/geom/line/CenterOn.js#L8
Since: 3.0.0

Clone

staticClone(source)

Description:

Clone the given line.

Parameters:

Returns: Phaser.Geom.Line - The cloned line.

Source: src/geom/line/Clone.js#L9
Since: 3.0.0

CopyFrom

staticCopyFrom(source, dest)

Description:

Copy the values of one line to a destination line.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Line - The destination line.

Source: src/geom/line/CopyFrom.js#L7
Since: 3.0.0

Equals

staticEquals(line, toCompare)

Description:

Compare two lines for strict equality.

Parameters:

Returns: boolean - Whether the two lines are equal.

Source: src/geom/line/Equals.js#L7
Since: 3.0.0

Extend

staticExtend(line, left, [right])

Description:

Extends the start and end points of a Line by the given amounts.

The amounts can be positive or negative. Positive points will increase the length of the line,

while negative ones will decrease it.

If no right value is provided it will extend the length of the line equally in both directions.

Pass a value of zero to leave the start or end point unchanged.

Parameters:

Returns: Phaser.Geom.Line - The modified Line instance.

Source: src/geom/line/Extend.js#L9
Since: 3.16.0

GetEasedPoints

staticGetEasedPoints(line, ease, quantity, [collinearThreshold], [easeParams])

Description:

Returns an array of quantity Points where each point is taken from the given Line,

spaced out according to the ease function specified.

const line = new Phaser.Geom.Line(100, 300, 700, 300);

const points = Phaser.Geom.Line.GetEasedPoints(line, 'sine.out', 32)

In the above example, the points array will contain 32 points spread-out across

the length of line, where the position of each point is determined by the Sine.out

ease function.

You can optionally provide a collinear threshold. In this case, the resulting points

are checked against each other, and if they are < collinearThreshold distance apart,

they are dropped from the results. This can help avoid lots of clustered points at

far ends of the line with tightly-packed eases such as Quartic. Leave the value set

to zero to skip this check.

Note that if you provide a collinear threshold, the resulting array may not always

contain quantity points.

Tags:

• generic

Parameters:

Returns: Array.<Phaser.Geom.Point> - An array of Geom.Points containing the coordinates of the points on the line.

Source: src/geom/line/GetEasedPoints.js#L11
Since: 3.23.0

GetMidPoint

staticGetMidPoint(line, [out])

Description:

Get the midpoint of the given line.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - The midpoint of the Line.

Source: src/geom/line/GetMidPoint.js#L9
Since: 3.0.0

GetNearestPoint

staticGetNearestPoint(line, point, [out])

Description:

Get the nearest point on a line perpendicular to the given point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - The nearest point on the line.

Source: src/geom/line/GetNearestPoint.js#L10
Since: 3.16.0

GetNormal

staticGetNormal(line, [out])

Description:

Calculate the normal of the given line.

The normal of a line is a vector that points perpendicular from it.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - The normal of the Line.

Source: src/geom/line/GetNormal.js#L11
Since: 3.0.0

GetPoint

staticGetPoint(line, position, [out])

Description:

Get a point on a line that's a given percentage along its length.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - The point on the line.

Source: src/geom/line/GetPoint.js#L9
Since: 3.0.0

GetPoints

staticGetPoints(line, quantity, [stepRate], [out])

Description:

Get a number of points along a line's length.

Provide a quantity to get an exact number of points along the line.

Provide a stepRate to ensure a specific distance between each point on the line. Set quantity to 0 when

providing a stepRate.

See also GetEasedPoints for a way to distribute the points across the line according to an ease type or input function.

Tags:

• generic

Parameters:

Returns: array, Array.<Phaser.Geom.Point> - An array of Points, or point-like objects, containing the coordinates of the points on the line.

Source: src/geom/line/GetPoints.js#L10
Since: 3.0.0

GetShortestDistance

staticGetShortestDistance(line, point)

Description:

Get the shortest distance from a Line to the given Point.

Parameters:

Returns: boolean, number - The shortest distance from the line to the point, or false.

Source: src/geom/line/GetShortestDistance.js#L8
Since: 3.16.0

Height

staticHeight(line)

Description:

Calculate the height of the given line.

Parameters:

Returns: number - The height of the line.

Source: src/geom/line/Height.js#L7
Since: 3.0.0

Length

staticLength(line)

Description:

Calculate the length of the given line.

Parameters:

Returns: number - The length of the line.

Source: src/geom/line/Length.js#L7
Since: 3.0.0

NormalAngle

staticNormalAngle(line)

Description:

Get the angle of the normal of the given line in radians.

Parameters:

Returns: number - The angle of the normal of the line in radians.

Source: src/geom/line/NormalAngle.js#L11
Since: 3.0.0

NormalX

staticNormalX(line)

Description:

Returns the x component of the normal vector of the given line.

Parameters:

Returns: number - The x component of the normal vector of the line.

Source: src/geom/line/NormalX.js#L10
Since: 3.0.0

NormalY

staticNormalY(line)

Description:

The Y value of the normal of the given line.

The normal of a line is a vector that points perpendicular from it.

Parameters:

Returns: number - The Y value of the normal of the Line.

Source: src/geom/line/NormalY.js#L10
Since: 3.0.0

Offset

staticOffset(line, x, y)

Description:

Offset a line by the given amount.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Line - The offset line.

Source: src/geom/line/Offset.js#L7
Since: 3.0.0

PerpSlope

staticPerpSlope(line)

Description:

Calculate the perpendicular slope of the given line.

Parameters:

Returns: number - The perpendicular slope of the line.

Source: src/geom/line/PerpSlope.js#L7
Since: 3.0.0

Random

staticRandom(line, [out])

Description:

Returns a random point on a given Line.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A random Point on the Line.

Source: src/geom/line/Random.js#L9
Since: 3.0.0

ReflectAngle

staticReflectAngle(lineA, lineB)

Description:

Calculate the reflected angle between two lines.

This is the outgoing angle based on the angle of Line 1 and the normalAngle of Line 2.

Parameters:

Returns: number - The reflected angle between each line.

Source: src/geom/line/ReflectAngle.js#L10
Since: 3.0.0

Rotate

staticRotate(line, angle)

Description:

Rotate a line around its midpoint by the given angle in radians.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Line - The rotated line.

Source: src/geom/line/Rotate.js#L9
Since: 3.0.0

RotateAroundPoint

staticRotateAroundPoint(line, point, angle)

Description:

Rotate a line around a point by the given angle in radians.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Line - The rotated line.

Source: src/geom/line/RotateAroundPoint.js#L9
Since: 3.0.0

RotateAroundXY

staticRotateAroundXY(line, x, y, angle)

Description:

Rotate a line around the given coordinates by the given angle in radians.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Line - The rotated line.

Source: src/geom/line/RotateAroundXY.js#L7
Since: 3.0.0

SetToAngle

staticSetToAngle(line, x, y, angle, length)

Description:

Set a line to a given position, angle and length.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Line - The updated line.

Source: src/geom/line/SetToAngle.js#L7
Since: 3.0.0

Slope

staticSlope(line)

Description:

Calculate the slope of the given line.

Parameters:

Returns: number - The slope of the line.

Source: src/geom/line/Slope.js#L7
Since: 3.0.0

Width

staticWidth(line)

Description:

Calculate the width of the given line.

Parameters:

Returns: number - The width of the line.

Source: src/geom/line/Width.js#L7
Since: 3.0.0

Phaser.Geom.Mesh

GenerateGridVerts

staticGenerateGridVerts(config)

Description:

Creates a grid of vertices based on the given configuration object and optionally adds it to a Mesh.

The size of the grid is given in pixels. An example configuration may be:

{ width: 256, height: 256, widthSegments: 2, heightSegments: 2, tile: true }

This will create a grid 256 x 256 pixels in size, split into 2 x 2 segments, with

the texture tiling across the cells.

You can split the grid into segments both vertically and horizontally. This will

generate two faces per grid segment as a result.

The tile parameter allows you to control if the tile will repeat across the grid

segments, or be displayed in full.

If adding this grid to a Mesh you can offset the grid via the x and y properties.

UV coordinates are generated based on the given texture and frame in the config. For

example, no frame is given, the UVs will be in the range 0 to 1. If a frame is given,

such as from a texture atlas, the UVs will be generated within the range of that frame.

Parameters:

Returns: Phaser.Types.Geom.Mesh.GenerateGridVertsResult - A Grid Result object, containing the generated vertices and indicies.

Source: src/geom/mesh/GenerateGridVerts.js#L17
Since: 3.50.0

GenerateObjVerts

staticGenerateObjVerts(data, [mesh], [scale], [x], [y], [z], [rotateX], [rotateY], [rotateZ], [zIsUp])

Description:

This method will return an object containing Face and Vertex instances, generated

from the parsed triangulated OBJ Model data given to this function.

The obj data should have been parsed in advance via the ParseObj function:

var data = Phaser.Geom.Mesh.ParseObj(rawData, flipUV);



var results = GenerateObjVerts(data);

Alternatively, you can parse obj files loaded via the OBJFile loader:

preload ()

{

  this.load.obj('alien', 'assets/3d/alien.obj);

}



var results = GenerateObjVerts(this.cache.obj.get('alien));

Make sure your 3D package has triangulated the model data prior to exporting it.

You can use the data returned by this function to populate the vertices of a Mesh Game Object.

You may add multiple models to a single Mesh, although they will act as one when

moved or rotated. You can scale the model data, should it be too small (or large) to visualize.

You can also offset the model via the x, y and z parameters.

Parameters:

Returns: Phaser.Types.Geom.Mesh.GenerateVertsResult - The parsed Face and Vertex objects.

Source: src/geom/mesh/GenerateObjVerts.js#L16
Since: 3.50.0

GenerateVerts

staticGenerateVerts(vertices, uvs, [indicies], [containsZ], [normals], [colors], [alphas], [flipUV])

Description:

Generates a set of Face and Vertex objects by parsing the given data.

This method will take vertex data in one of two formats, based on the containsZ parameter.

If your vertex data are x, y pairs, then containsZ should be false (this is the default)

If your vertex data is groups of x, y and z values, then the containsZ parameter must be true.

The uvs parameter is a numeric array consisting of u and v pairs.

The normals parameter is a numeric array consisting of x, y vertex normal values and, if containsZ is true, z values as well.

The indicies parameter is an optional array that, if given, is an indexed list of vertices to be added.

The colors parameter is an optional array, or single value, that if given sets the color of each vertex created.

The alphas parameter is an optional array, or single value, that if given sets the alpha of each vertex created.

When providing indexed data it is assumed that all of the arrays are indexed, not just the vertices.

The following example will create a 256 x 256 sized quad using an index array:

const vertices = [

  -128, 128,

  128, 128,

  -128, -128,

  128, -128

];



const uvs = [

  0, 1,

  1, 1,

  0, 0,

  1, 0

];



const indices = [ 0, 2, 1, 2, 3, 1 ];



GenerateVerts(vertices, uvs, indicies);

If the data is not indexed, it's assumed that the arrays all contain sequential data.

Parameters:

Returns: Phaser.Types.Geom.Mesh.GenerateVertsResult - The parsed Face and Vertex objects.

Source: src/geom/mesh/GenerateVerts.js#L10
Since: 3.50.0

ParseObj

staticParseObj(data, [flipUV])

Description:

Parses a Wavefront OBJ File, extracting the models from it and returning them in an array.

The model data must be triangulated for a Mesh Game Object to be able to render it.

Parameters:

Returns: Phaser.Types.Geom.Mesh.OBJData - The parsed model and material data.

Source: src/geom/mesh/ParseObj.js#L226
Since: 3.50.0

ParseObjMaterial

staticParseObjMaterial(mtl)

Description:

Takes a Wavefront Material file and extracts the diffuse reflectivity of the named

materials, converts them to integer color values and returns them.

This is used internally by the addOBJ and addModel methods, but is exposed for

public consumption as well.

Note this only works with diffuse values, specified in the Kd r g b format, where

g and b are optional, but r is required. It does not support spectral rfl files,

or any other material statement (such as Ka or Ks)

Parameters:

Returns: object - The parsed material colors, where each property of the object matches the material name.

Source: src/geom/mesh/ParseObjMaterial.js#L9
Since: 3.50.0

RotateFace

staticRotateFace(face, angle, [cx], [cy])

Description:

Rotates the vertices of a Face to the given angle.

The actual vertex positions are adjusted, not their transformed positions.

Therefore, this updates the vertex data directly.

Parameters:

Source: src/geom/mesh/RotateFace.js#L7
Since: 3.50.0

Phaser.Geom.Point

Ceil

staticCeil(point)

Description:

Apply Math.ceil() to each coordinate of the given Point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The Point with Math.ceil() applied to its coordinates.

Source: src/geom/point/Ceil.js#L7
Since: 3.0.0

Clone

staticClone(source)

Description:

Clone the given Point.

Parameters:

Returns: Phaser.Geom.Point - The cloned Point.

Source: src/geom/point/Clone.js#L9
Since: 3.0.0

CopyFrom

staticCopyFrom(source, dest)

Description:

Copy the values of one Point to a destination Point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The destination Point.

Source: src/geom/point/CopyFrom.js#L7
Since: 3.0.0

Equals

staticEquals(point, toCompare)

Description:

A comparison of two Point objects to see if they are equal.

Parameters:

Returns: boolean - Returns true if the both Point objects are equal.

Source: src/geom/point/Equals.js#L7
Since: 3.0.0

Floor

staticFloor(point)

Description:

Apply Math.ceil() to each coordinate of the given Point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The Point with Math.floor() applied to its coordinates.

Source: src/geom/point/Floor.js#L7
Since: 3.0.0

GetCentroid

staticGetCentroid(points, [out])

Description:

Get the centroid or geometric center of a plane figure (the arithmetic mean position of all the points in the figure).

Informally, it is the point at which a cutout of the shape could be perfectly balanced on the tip of a pin.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - A Point object representing the geometric center of the given points.

Source: src/geom/point/GetCentroid.js#L9
Since: 3.0.0

GetMagnitude

staticGetMagnitude(point)

Description:

Calculate the magnitude of the point, which equivalent to the length of the line from the origin to this point.

Parameters:

Returns: number - The resulting magnitude

Source: src/geom/point/GetMagnitude.js#L7
Since: 3.0.0

GetMagnitudeSq

staticGetMagnitudeSq(point)

Description:

Calculates the square of magnitude of given point.(Can be used for fast magnitude calculation of point)

Parameters:

Returns: number - Returns square of the magnitude of given point.

Source: src/geom/point/GetMagnitudeSq.js#L7
Since: 3.0.0

GetRectangleFromPoints

staticGetRectangleFromPoints(points, [out])

Description:

Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - A Rectangle object holding the AABB values for the given points.

Source: src/geom/point/GetRectangleFromPoints.js#L9
Since: 3.0.0

Interpolate

staticInterpolate(pointA, pointB, [t], [out])

Description:

Returns the linear interpolation point between the two given points, based on t.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - Either the object from the out argument with the properties x and y set to the result of the interpolation or a newly created Point object.

Source: src/geom/point/Interpolate.js#L9
Since: 3.0.0

Invert

staticInvert(point)

Description:

Swaps the X and the Y coordinate of a point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The modified point.

Source: src/geom/point/Invert.js#L7
Since: 3.0.0

Negative

staticNegative(point, [out])

Description:

Inverts a Point's coordinates.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The modified out Point, or a new Point if none was provided.

Source: src/geom/point/Negative.js#L9
Since: 3.0.0

Project

staticProject(pointA, pointB, [out])

Description:

Calculates the vector projection of pointA onto the nonzero pointB. This is the

orthogonal projection of pointA onto a straight line parallel to pointB.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - A Point object holding the coordinates of the vector projection of pointA onto pointB.

Source: src/geom/point/Project.js#L10
Since: 3.0.0

ProjectUnit

staticProjectUnit(pointA, pointB, [out])

Description:

Calculates the vector projection of pointA onto the nonzero pointB. This is the

orthogonal projection of pointA onto a straight line paralle to pointB.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - A unit Point object holding the coordinates of the vector projection of pointA onto pointB.

Source: src/geom/point/ProjectUnit.js#L9
Since: 3.0.0

SetMagnitude

staticSetMagnitude(point, magnitude)

Description:

Changes the magnitude (length) of a two-dimensional vector without changing its direction.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The modified Point.

Source: src/geom/point/SetMagnitude.js#L9
Since: 3.0.0

Phaser.Geom.Polygon

Clone

staticClone(polygon)

Description:

Create a new polygon which is a copy of the specified polygon

Parameters:

Returns: Phaser.Geom.Polygon - A new separate Polygon cloned from the specified polygon, based on the same points.

Source: src/geom/polygon/Clone.js#L9
Since: 3.0.0

Contains

staticContains(polygon, x, y)

Description:

Checks if a point is within the bounds of a Polygon.

Parameters:

Returns: boolean - true if the point is within the bounds of the Polygon, otherwise false.

Source: src/geom/polygon/Contains.js#L10
Since: 3.0.0

ContainsPoint

staticContainsPoint(polygon, point)

Description:

Checks the given Point again the Polygon to see if the Point lays within its vertices.

Parameters:

Returns: boolean - true if the Point is within the Polygon, otherwise false.

Source: src/geom/polygon/ContainsPoint.js#L9
Since: 3.0.0

Earcut

staticEarcut(data, [holeIndices], [dimensions])

Description:

This module implements a modified ear slicing algorithm, optimized by z-order curve hashing and extended to

handle holes, twisted polygons, degeneracies and self-intersections in a way that doesn't guarantee correctness

of triangulation, but attempts to always produce acceptable results for practical data.

Example:

const triangles = Phaser.Geom.Polygon.Earcut([10,0, 0,50, 60,60, 70,10]); // returns [1,0,3, 3,2,1]

Each group of three vertex indices in the resulting array forms a triangle.

// triangulating a polygon with a hole

earcut([0,0, 100,0, 100,100, 0,100,  20,20, 80,20, 80,80, 20,80], [4]);

// [3,0,4, 5,4,0, 3,4,7, 5,0,1, 2,3,7, 6,5,1, 2,7,6, 6,1,2]



// triangulating a polygon with 3d coords

earcut([10,0,1, 0,50,2, 60,60,3, 70,10,4], null, 3);

// [1,0,3, 3,2,1]

If you pass a single vertex as a hole, Earcut treats it as a Steiner point.

If your input is a multi-dimensional array (e.g. GeoJSON Polygon), you can convert it to the format

expected by Earcut with Phaser.Geom.Polygon.Earcut.flatten:

var data = earcut.flatten(geojson.geometry.coordinates);

var triangles = earcut(data.vertices, data.holes, data.dimensions);

After getting a triangulation, you can verify its correctness with Phaser.Geom.Polygon.Earcut.deviation:

var deviation = earcut.deviation(vertices, holes, dimensions, triangles);

Returns the relative difference between the total area of triangles and the area of the input polygon.

0 means the triangulation is fully correct.

For more information see https://github.com/mapbox/earcut

Parameters:

Returns: Array.<number> - An array of triangulated data.

Source: src/geom/polygon/Earcut.js#L7
Since: 3.50.0

GetAABB

staticGetAABB(polygon, [out])

Description:

Calculates the bounding AABB rectangle of a polygon.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle, object - The resulting rectangle or object that is passed in with position and dimensions of the polygon's AABB.

Source: src/geom/polygon/GetAABB.js#L9
Since: 3.0.0

GetNumberArray

staticGetNumberArray(polygon, [output])

Description:

Stores all of the points of a Polygon into a flat array of numbers following the sequence [ x,y, x,y, x,y ],

i.e. each point of the Polygon, in the order it's defined, corresponds to two elements of the resultant

array for the point's X and Y coordinate.

Tags:

• generic

Parameters:

Returns: array, Array.<number> - The modified output array, or a new array if none was given.

Source: src/geom/polygon/GetNumberArray.js#L9
Since: 3.0.0

GetPoints

staticGetPoints(polygon, quantity, [stepRate], [output])

Description:

Returns an array of Point objects containing the coordinates of the points around the perimeter of the Polygon,

based on the given quantity or stepRate values.

Parameters:

Returns: Array.<Phaser.Geom.Point> - An array of Point objects pertaining to the points around the perimeter of the Polygon.

Source: src/geom/polygon/GetPoints.js#L11
Since: 3.12.0

Perimeter

staticPerimeter(polygon)

Description:

Returns the perimeter of the given Polygon.

Parameters:

Returns: number - The perimeter of the Polygon.

Source: src/geom/polygon/Perimeter.js#L10
Since: 3.12.0

Reverse

staticReverse(polygon)

Description:

Reverses the order of the points of a Polygon.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Polygon - The modified Polygon.

Source: src/geom/polygon/Reverse.js#L7
Since: 3.0.0

Simplify

staticSimplify(polygon, [tolerance], [highestQuality])

Description:

Takes a Polygon object and simplifies the points by running them through a combination of

Douglas-Peucker and Radial Distance algorithms. Simplification dramatically reduces the number of

points in a polygon while retaining its shape, giving a huge performance boost when processing

it and also reducing visual noise.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Polygon - The input polygon.

Source: src/geom/polygon/Simplify.js#L160
Since: 3.50.0

Smooth

staticSmooth(polygon)

Description:

Takes a Polygon object and applies Chaikin's smoothing algorithm on its points.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Polygon - The input polygon.

Source: src/geom/polygon/Smooth.js#L19
Since: 3.13.0

Translate

staticTranslate(polygon, x, y)

Description:

Tranlates the points of the given Polygon.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Polygon - The modified Polygon.

Source: src/geom/polygon/Translate.js#L7
Since: 3.50.0

Phaser.Geom.Rectangle

Area

staticArea(rect)

Description:

Calculates the area of the given Rectangle object.

Parameters:

Returns: number - The area of the Rectangle object.

Source: src/geom/rectangle/Area.js#L7
Since: 3.0.0

Ceil

staticCeil(rect)

Description:

Rounds a Rectangle's position up to the smallest integer greater than or equal to each current coordinate.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The adjusted Rectangle.

Source: src/geom/rectangle/Ceil.js#L7
Since: 3.0.0

CeilAll

staticCeilAll(rect)

Description:

Rounds a Rectangle's position and size up to the smallest integer greater than or equal to each respective value.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The modified Rectangle.

Source: src/geom/rectangle/CeilAll.js#L7
Since: 3.0.0

CenterOn

staticCenterOn(rect, x, y)

Description:

Moves the top-left corner of a Rectangle so that its center is at the given coordinates.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The centered rectangle.

Source: src/geom/rectangle/CenterOn.js#L7
Since: 3.0.0

Clone

staticClone(source)

Description:

Creates a new Rectangle which is identical to the given one.

Parameters:

Returns: Phaser.Geom.Rectangle - The newly created Rectangle, which is separate from the given one.

Source: src/geom/rectangle/Clone.js#L9
Since: 3.0.0

Contains

staticContains(rect, x, y)

Description:

Checks if a given point is inside a Rectangle's bounds.

Parameters:

Returns: boolean - true if the point is within the Rectangle's bounds, otherwise false.

Source: src/geom/rectangle/Contains.js#L7
Since: 3.0.0

ContainsPoint

staticContainsPoint(rect, point)

Description:

Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.

Parameters:

Returns: boolean - A value of true if the Rectangle object contains the specified point, otherwise false.

Source: src/geom/rectangle/ContainsPoint.js#L9
Since: 3.0.0

ContainsRect

staticContainsRect(rectA, rectB)

Description:

Tests if one rectangle fully contains another.

Parameters:

Returns: boolean - True only if rectA fully contains rectB.

Source: src/geom/rectangle/ContainsRect.js#L7
Since: 3.0.0

CopyFrom

staticCopyFrom(source, dest)

Description:

Copy the values of one Rectangle to a destination Rectangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The destination Rectangle.

Source: src/geom/rectangle/CopyFrom.js#L7
Since: 3.0.0

Decompose

staticDecompose(rect, [out])

Description:

Create an array of points for each corner of a Rectangle

If an array is specified, each point object will be added to the end of the array, otherwise a new array will be created.

Parameters:

Returns: array - Will return the array you specified or a new array containing the points of the Rectangle.

Source: src/geom/rectangle/Decompose.js#L7
Since: 3.0.0

Equals

staticEquals(rect, toCompare)

Description:

Compares the x, y, width and height properties of two rectangles.

Parameters:

Returns: boolean - true if the rectangles' properties are an exact match, otherwise false.

Source: src/geom/rectangle/Equals.js#L7
Since: 3.0.0

FitInside

staticFitInside(target, source)

Description:

Adjusts the target rectangle, changing its width, height and position,

so that it fits inside the area of the source rectangle, while maintaining its original

aspect ratio.

Unlike the FitOutside function, there may be some space inside the source area not covered.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The modified target rectangle instance.

Source: src/geom/rectangle/FitInside.js#L9
Since: 3.0.0

FitOutside

staticFitOutside(target, source)

Description:

Adjusts the target rectangle, changing its width, height and position,

so that it fully covers the area of the source rectangle, while maintaining its original

aspect ratio.

Unlike the FitInside function, the target rectangle may extend further out than the source.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The modified target rectangle instance.

Source: src/geom/rectangle/FitOutside.js#L9
Since: 3.0.0

Floor

staticFloor(rect)

Description:

Rounds down (floors) the top left X and Y coordinates of the given Rectangle to the largest integer less than or equal to them

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The rectangle that was passed to this function with its coordinates floored.

Source: src/geom/rectangle/Floor.js#L7
Since: 3.0.0

FloorAll

staticFloorAll(rect)

Description:

Rounds a Rectangle's position and size down to the largest integer less than or equal to each current coordinate or dimension.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The adjusted Rectangle.

Source: src/geom/rectangle/FloorAll.js#L7
Since: 3.0.0

FromPoints

staticFromPoints(points, [out])

Description:

Constructs new Rectangle or repositions and resizes an existing Rectangle so that all of the given points are on or within its bounds.

The points parameter is an array of Point-like objects:

const points = [

    [100, 200],

    [200, 400],

    { x: 30, y: 60 }

]

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The adjusted out Rectangle, or a new Rectangle if none was provided.

Source: src/geom/rectangle/FromPoints.js#L10
Since: 3.0.0

FromXY

staticFromXY(x1, y1, x2, y2, [out])

Description:

Create the smallest Rectangle containing two coordinate pairs.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The adjusted out Rectangle, or a new Rectangle if none was provided.

Source: src/geom/rectangle/FromXY.js#L9
Since: 3.23.0

GetAspectRatio

staticGetAspectRatio(rect)

Description:

Calculates the width/height ratio of a rectangle.

Parameters:

Returns: number - The width/height ratio of the rectangle.

Source: src/geom/rectangle/GetAspectRatio.js#L7
Since: 3.0.0

GetCenter

staticGetCenter(rect, [out])

Description:

Returns the center of a Rectangle as a Point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - The modified out object, or a new Point if none was provided.

Source: src/geom/rectangle/GetCenter.js#L9
Since: 3.0.0

GetPoint

staticGetPoint(rectangle, position, [out])

Description:

Calculates the coordinates of a point at a certain position on the Rectangle's perimeter.

The position is a fraction between 0 and 1 which defines how far into the perimeter the point is.

A value of 0 or 1 returns the point at the top left corner of the rectangle, while a value of 0.5 returns the point at the bottom right corner of the rectangle. Values between 0 and 0.5 are on the top or the right side and values between 0.5 and 1 are on the bottom or the left side.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The updated output object, or a new Point if no output object was given.

Source: src/geom/rectangle/GetPoint.js#L10
Since: 3.0.0

GetPoints

staticGetPoints(rectangle, step, quantity, [out])

Description:

Return an array of points from the perimeter of the rectangle, each spaced out based on the quantity or step required.

Tags:

• generic

Parameters:

Returns: array, Array.<Phaser.Geom.Point> - An array of Points from the perimeter of the rectangle.

Source: src/geom/rectangle/GetPoints.js#L10
Since: 3.0.0

GetSize

staticGetSize(rect, [out])

Description:

Returns the size of the Rectangle, expressed as a Point object.

With the value of the width as the x property and the height as the y property.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point object where x holds the width and y holds the height of the Rectangle.

Source: src/geom/rectangle/GetSize.js#L9
Since: 3.0.0

Inflate

staticInflate(rect, x, y)

Description:

Increases the size of a Rectangle by a specified amount.

The center of the Rectangle stays the same. The amounts are added to each side, so the actual increase in width or height is two times bigger than the respective argument.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The inflated Rectangle.

Source: src/geom/rectangle/Inflate.js#L9
Since: 3.0.0

Intersection

staticIntersection(rectA, rectB, [out])

Description:

Takes two Rectangles and first checks to see if they intersect.

If they intersect it will return the area of intersection in the out Rectangle.

If they do not intersect, the out Rectangle will have a width and height of zero.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The intersection result. If the width and height are zero, no intersection occurred.

Source: src/geom/rectangle/Intersection.js#L10
Since: 3.11.0

MarchingAnts

staticMarchingAnts(rect, [step], [quantity], [out])

Description:

Returns an array of points from the perimeter of the Rectangle, where each point is spaced out based

on either the step value, or the quantity.

Tags:

• generic

Parameters:

Returns: array, Array.<Phaser.Geom.Point> - An array containing the perimeter points from the Rectangle.

Source: src/geom/rectangle/MarchingAnts.js#L10
Since: 3.0.0

MergePoints

staticMergePoints(target, points)

Description:

Merges a Rectangle with a list of points by repositioning and/or resizing it such that all points are located on or within its bounds.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The modified Rectangle.

Source: src/geom/rectangle/MergePoints.js#L7
Since: 3.0.0

MergeRect

staticMergeRect(target, source)

Description:

Merges the source rectangle into the target rectangle and returns the target.

Neither rectangle should have a negative width or height.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - Modified target rectangle that contains source rectangle.

Source: src/geom/rectangle/MergeRect.js#L7
Since: 3.0.0

MergeXY

staticMergeXY(target, x, y)

Description:

Merges a Rectangle with a point by repositioning and/or resizing it so that the point is on or within its bounds.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The modified target Rectangle.

Source: src/geom/rectangle/MergeXY.js#L7
Since: 3.0.0

Offset

staticOffset(rect, x, y)

Description:

Nudges (translates) the top left corner of a Rectangle by a given offset.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The adjusted Rectangle.

Source: src/geom/rectangle/Offset.js#L7
Since: 3.0.0

OffsetPoint

staticOffsetPoint(rect, point)

Description:

Nudges (translates) the top-left corner of a Rectangle by the coordinates of a point (translation vector).

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The adjusted Rectangle.

Source: src/geom/rectangle/OffsetPoint.js#L7
Since: 3.0.0

Overlaps

staticOverlaps(rectA, rectB)

Description:

Checks if two Rectangles overlap. If a Rectangle is within another Rectangle, the two will be considered overlapping. Thus, the Rectangles are treated as "solid".

Parameters:

Returns: boolean - true if the two Rectangles overlap, false otherwise.

Source: src/geom/rectangle/Overlaps.js#L7
Since: 3.0.0

Perimeter

staticPerimeter(rect)

Description:

Calculates the perimeter of a Rectangle.

Parameters:

Returns: number - The perimeter of the Rectangle, equal to (width * 2) + (height * 2).

Source: src/geom/rectangle/Perimeter.js#L7
Since: 3.0.0

PerimeterPoint

staticPerimeterPoint(rectangle, angle, [out])

Description:

Returns a Point from the perimeter of a Rectangle based on the given angle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - A Point object holding the coordinates of the Rectangle perimeter.

Source: src/geom/rectangle/PerimeterPoint.js#L10
Since: 3.0.0

Random

staticRandom(rect, out)

Description:

Returns a random point within a Rectangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - The modified out object, or a new Point if none was provided.

Source: src/geom/rectangle/Random.js#L9
Since: 3.0.0

RandomOutside

staticRandomOutside(outer, inner, [out])

Description:

Calculates a random point that lies within the outer Rectangle, but outside of the inner Rectangle.

The inner Rectangle must be fully contained within the outer rectangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - A Point object containing the random values in its x and y properties.

Source: src/geom/rectangle/RandomOutside.js#L11
Since: 3.10.0

SameDimensions

staticSameDimensions(rect, toCompare)

Description:

Determines if the two objects (either Rectangles or Rectangle-like) have the same width and height values under strict equality.

Parameters:

Returns: boolean - true if the objects have equivalent values for the width and height properties, otherwise false.

Source: src/geom/rectangle/SameDimensions.js#L7
Since: 3.15.0

Scale

staticScale(rect, x, y)

Description:

Scales the width and height of this Rectangle by the given amounts.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The rectangle object with updated width and height properties as calculated from the scaling factor(s).

Source: src/geom/rectangle/Scale.js#L7
Since: 3.0.0

Union

staticUnion(rectA, rectB, [out])

Description:

Creates a new Rectangle or repositions and/or resizes an existing Rectangle so that it encompasses the two given Rectangles, i.e. calculates their union.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Rectangle - The modified out Rectangle, or a new Rectangle if none was provided.

Source: src/geom/rectangle/Union.js#L9
Since: 3.0.0

Phaser.Geom.Triangle

Area

staticArea(triangle)

Description:

Returns the area of a Triangle.

Parameters:

Returns: number - The area of the Triangle, always non-negative.

Source: src/geom/triangle/Area.js#L9
Since: 3.0.0

BuildEquilateral

staticBuildEquilateral(x, y, length)

Description:

Builds an equilateral triangle. In the equilateral triangle, all the sides are the same length (congruent) and all the angles are the same size (congruent).

The x/y specifies the top-middle of the triangle (x1/y1) and length is the length of each side.

Parameters:

Returns: Phaser.Geom.Triangle - The Triangle object of the given size.

Source: src/geom/triangle/BuildEquilateral.js#L9
Since: 3.0.0

BuildFromPolygon

staticBuildFromPolygon(data, [holes], [scaleX], [scaleY], [out])

Description:

Takes an array of vertex coordinates, and optionally an array of hole indices, then returns an array

of Triangle instances, where the given vertices have been decomposed into a series of triangles.

Tags:

• generic

Parameters:

Returns: array, Array.<Phaser.Geom.Triangle> - An array of Triangle instances, where each triangle is based on the decomposed vertices data.

Source: src/geom/triangle/BuildFromPolygon.js#L10
Since: 3.0.0

BuildRight

staticBuildRight(x, y, width, height)

Description:

Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles.

Parameters:

Returns: Phaser.Geom.Triangle - The constructed right Triangle.

Source: src/geom/triangle/BuildRight.js#L13
Since: 3.0.0

CenterOn

staticCenterOn(triangle, x, y, [centerFunc])

Description:

Positions the Triangle so that it is centered on the given coordinates.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Triangle - The Triangle that was centered.

Source: src/geom/triangle/CenterOn.js#L18
Since: 3.0.0

Centroid

staticCentroid(triangle, [out])

Description:

Calculates the position of a Triangle's centroid, which is also its center of mass (center of gravity).

The centroid is the point in a Triangle at which its three medians (the lines drawn from the vertices to the bisectors of the opposite sides) meet. It divides each one in a 2:1 ratio.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - The out object with modified x and y properties, or a new Point if none was provided.

Source: src/geom/triangle/Centroid.js#L13
Since: 3.0.0

CircumCenter

staticCircumCenter(triangle, [out])

Description:

Computes the circumcentre of a triangle. The circumcentre is the centre of

the circumcircle, the smallest circle which encloses the triangle. It is also

the common intersection point of the perpendicular bisectors of the sides of

the triangle, and is the only point which has equal distance to all three

vertices of the triangle.

Tags:

• generic

Parameters:

Returns: Phaser.Math.Vector2 - A Vector2 object holding the coordinates of the circumcenter of the Triangle.

Source: src/geom/triangle/CircumCenter.js#L30
Since: 3.0.0

CircumCircle

staticCircumCircle(triangle, [out])

Description:

Finds the circumscribed circle (circumcircle) of a Triangle object. The circumcircle is the circle which touches all of the triangle's vertices.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Circle - The updated out Circle, or a new Circle if none was provided.

Source: src/geom/triangle/CircumCircle.js#L11
Since: 3.0.0

Clone

staticClone(source)

Description:

Clones a Triangle object.

Parameters:

Returns: Phaser.Geom.Triangle - A new Triangle identical to the given one but separate from it.

Source: src/geom/triangle/Clone.js#L9
Since: 3.0.0

Contains

staticContains(triangle, x, y)

Description:

Checks if a point (as a pair of coordinates) is inside a Triangle's bounds.

Parameters:

Returns: boolean - true if the point is inside the Triangle, otherwise false.

Source: src/geom/triangle/Contains.js#L9
Since: 3.0.0

ContainsArray

staticContainsArray(triangle, points, [returnFirst], [out])

Description:

Filters an array of point-like objects to only those contained within a triangle.

If returnFirst is true, will return an array containing only the first point in the provided array that is within the triangle (or an empty array if there are no such points).

Parameters:

Returns: Array.<Phaser.Geom.Point> - An array containing all the points from points that are within the triangle, if an array was provided as out, points will be appended to that array and it will also be returned here.

Source: src/geom/triangle/ContainsArray.js#L13
Since: 3.0.0

ContainsPoint

staticContainsPoint(triangle, point)

Description:

Tests if a triangle contains a point.

Parameters:

Returns: boolean - true if the point is within the triangle, otherwise false.

Source: src/geom/triangle/ContainsPoint.js#L9
Since: 3.0.0

CopyFrom

staticCopyFrom(source, dest)

Description:

Copy the values of one Triangle to a destination Triangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Triangle - The destination Triangle.

Source: src/geom/triangle/CopyFrom.js#L7
Since: 3.0.0

Decompose

staticDecompose(triangle, [out])

Description:

Decomposes a Triangle into an array of its points.

Parameters:

Returns: array - The provided out array, or a new array if none was provided, with three objects with x and y properties representing each point of the Triangle appended to it.

Source: src/geom/triangle/Decompose.js#L7
Since: 3.0.0

Equals

staticEquals(triangle, toCompare)

Description:

Returns true if two triangles have the same coordinates.

Parameters:

Returns: boolean - true if the two given triangles have the exact same coordinates, otherwise false.

Source: src/geom/triangle/Equals.js#L7
Since: 3.0.0

GetPoint

staticGetPoint(triangle, position, [out])

Description:

Returns a Point from around the perimeter of a Triangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point, object - A Point object containing the given position from the perimeter of the triangle.

Source: src/geom/triangle/GetPoint.js#L10
Since: 3.0.0

GetPoints

staticGetPoints(triangle, quantity, stepRate, [out])

Description:

Returns an array of evenly spaced points on the perimeter of a Triangle.

Tags:

• generic

Parameters:

Returns: array, Array.<Phaser.Geom.Point> - The modified out array, or a new array if none was provided.

Source: src/geom/triangle/GetPoints.js#L10
Since: 3.0.0

InCenter

staticInCenter(triangle, [out])

Description:

Calculates the position of the incenter of a Triangle object. This is the point where its three angle bisectors meet and it's also the center of the incircle, which is the circle inscribed in the triangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - Point (x, y) of the center pixel of the triangle.

Source: src/geom/triangle/InCenter.js#L21
Since: 3.0.0

Offset

staticOffset(triangle, x, y)

Description:

Moves each point (vertex) of a Triangle by a given offset, thus moving the entire Triangle by that offset.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Triangle - The modified Triangle.

Source: src/geom/triangle/Offset.js#L7
Since: 3.0.0

Perimeter

staticPerimeter(triangle)

Description:

Gets the length of the perimeter of the given triangle.

Calculated by adding together the length of each of the three sides.

Parameters:

Returns: number - The length of the Triangle.

Source: src/geom/triangle/Perimeter.js#L9
Since: 3.0.0

Random

staticRandom(triangle, [out])

Description:

Returns a random Point from within the area of the given Triangle.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Point - A Point object holding the coordinates of a random position within the Triangle.

Source: src/geom/triangle/Random.js#L9
Since: 3.0.0

Rotate

staticRotate(triangle, angle)

Description:

Rotates a Triangle about its incenter, which is the point at which its three angle bisectors meet.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Triangle - The rotated Triangle.

Source: src/geom/triangle/Rotate.js#L10
Since: 3.0.0

RotateAroundPoint

staticRotateAroundPoint(triangle, point, angle)

Description:

Rotates a Triangle at a certain angle about a given Point or object with public x and y properties.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Triangle - The rotated Triangle.

Source: src/geom/triangle/RotateAroundPoint.js#L9
Since: 3.0.0

RotateAroundXY

staticRotateAroundXY(triangle, x, y, angle)

Description:

Rotates an entire Triangle at a given angle about a specific point.

Tags:

• generic

Parameters:

Returns: Phaser.Geom.Triangle - The rotated Triangle.

Source: src/geom/triangle/RotateAroundXY.js#L7
Since: 3.0.0