Class Triangle

A triangle is a plane created by connecting three points. The first two arguments specify the first point, the middle two arguments specify the second point, and the last two arguments specify the third point.

Constructors

constructor

new Triangle(
    x1?: number,
    y1?: number,
    x2?: number,
    y2?: number,
    x3?: number,
    y3?: number,
): Geom.Triangle
Parameters
- Optionalx1: number
  x coordinate of the first point. Default 0.
- Optionaly1: number
  y coordinate of the first point. Default 0.
- Optionalx2: number
  x coordinate of the second point. Default 0.
- Optionaly2: number
  y coordinate of the second point. Default 0.
- Optionalx3: number
  x coordinate of the third point. Default 0.
- Optionaly3: number
  y coordinate of the third point. Default 0.
Returns Geom.Triangle
- Defined in types/phaser.d.ts:62011

Properties

bottom

bottom: number

Bottom most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.

left

left: number

Left most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.

right

right: number

Right most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.

top

top: number

Top most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.

`Readonly`type

type: number

The geometry constant type of this object: GEOM_CONST.TRIANGLE. Used for fast type comparisons.

x1

x1: number

x coordinate of the first point.

x2

x2: number

x coordinate of the second point.

x3

x3: number

x coordinate of the third point.

y1

y1: number

y coordinate of the first point.

y2

y2: number

y coordinate of the second point.

y3

y3: number

y coordinate of the third point.

Methods

contains

contains(x: number, y: number): boolean
Checks whether a given points lies within the triangle.
Parameters
- x: number
  The x coordinate of the point to check.
- y: number
  The y coordinate of the point to check.
Returns boolean
- Defined in types/phaser.d.ts:62252

getLineA

getLineA<O extends Geom.Line>(line?: O): O
Returns a Line object that corresponds to Line A of this Triangle.
Type Parameters
- O extends Geom.Line
Parameters
- Optionalline: O
  A Line object to set the results in. If undefined a new Line will be created.
Returns O
- Defined in types/phaser.d.ts:62290

getLineB

getLineB<O extends Geom.Line>(line?: O): O
Returns a Line object that corresponds to Line B of this Triangle.
Type Parameters
- O extends Geom.Line
Parameters
- Optionalline: O
  A Line object to set the results in. If undefined a new Line will be created.
Returns O
- Defined in types/phaser.d.ts:62296

getLineC

getLineC<O extends Geom.Line>(line?: O): O
Returns a Line object that corresponds to Line C of this Triangle.
Type Parameters
- O extends Geom.Line
Parameters
- Optionalline: O
  A Line object to set the results in. If undefined a new Line will be created.
Returns O
- Defined in types/phaser.d.ts:62302

getPoint

getPoint<O extends Math.Vector2>(position: number, output?: O): O
Returns a specific point on the triangle.
Type Parameters
- O extends Math.Vector2
Parameters
- position: number
  Position as float within 0 and 1. 0 equals the first point.
- Optionaloutput: O
  Optional Vector2 point that the calculated point will be written to.
Returns O
- Defined in types/phaser.d.ts:62259

getPoints

getPoints<O extends Math.Vector2[]>(
    quantity: number,
    stepRate?: number,
    output?: O,
): O
Calculates a list of evenly distributed points on the triangle. It is either possible to pass an amount of points to be generated (quantity) or the distance between two points (stepRate).
Type Parameters
- O extends Math.Vector2[]
Parameters
- quantity: number
  Number of points to be generated. Can be falsey when stepRate should be used. All points have the same distance along the triangle.
- OptionalstepRate: number
  Distance between two points. Will only be used when quantity is falsey.
- Optionaloutput: O
  Optional array of Vector2 points for writing the calculated points into. Otherwise a new array will be created.
Returns O
- Defined in types/phaser.d.ts:62267

getRandomPoint

getRandomPoint<O extends Math.Vector2>(vec?: Math.Vector2): O
Returns a random point along the triangle.
Type Parameters
- O extends Math.Vector2
Parameters
- Optionalvec: Math.Vector2
  Optional Vector2 point that will be modified. Otherwise a new one will be created.
Returns O
- Defined in types/phaser.d.ts:62273

setTo

setTo(
    x1?: number,
    y1?: number,
    x2?: number,
    y2?: number,
    x3?: number,
    y3?: number,
): this
Sets all three points of the triangle. Leaving out any coordinate sets it to be 0.
Parameters
- Optionalx1: number
  x coordinate of the first point. Default 0.
- Optionaly1: number
  y coordinate of the first point. Default 0.
- Optionalx2: number
  x coordinate of the second point. Default 0.
- Optionaly2: number
  y coordinate of the second point. Default 0.
- Optionalx3: number
  x coordinate of the third point. Default 0.
- Optionaly3: number
  y coordinate of the third point. Default 0.
Returns this
- Defined in types/phaser.d.ts:62284

`Static`Area

Area(triangle: Geom.Triangle): number
Returns the area of a Triangle.
Parameters
- triangle: Geom.Triangle
  The Triangle to use.
Returns number
- Defined in types/phaser.d.ts:62017

`Static`BuildEquilateral

BuildEquilateral(x: number, y: number, length: number): Geom.Triangle
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
- x: number
  x coordinate of the top point of the triangle.
- y: number
  y coordinate of the top point of the triangle.
- length: number
  Length of each side of the triangle.
Returns Geom.Triangle
- Defined in types/phaser.d.ts:62026

`Static`BuildFromPolygon

BuildFromPolygon<O extends Geom.Triangle[]>(
    data: any[],
    holes?: any[],
    scaleX?: number,
    scaleY?: number,
    out?: O,
): O
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.
Type Parameters
- O extends Geom.Triangle[]
Parameters
- data: any[]
  A flat array of vertex coordinates like [x0,y0, x1,y1, x2,y2, ...]
- Optionalholes: any[]
  An array of hole indices if any (e.g. [5, 8] for a 12-vertex input would mean one hole with vertices 5–7 and another with 8–11). Default null.
- OptionalscaleX: number
  Horizontal scale factor to multiply the resulting points by. Default 1.
- OptionalscaleY: number
  Vertical scale factor to multiply the resulting points by. Default 1.
- Optionalout: O
  An array to store the resulting Triangle instances in. If not provided, a new array is created.
Returns O
- Defined in types/phaser.d.ts:62037

`Static`BuildRight

BuildRight(x: number, y: number, width: number, height: number): Geom.Triangle
Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles.
Parameters
- x: number
  The X coordinate of the right angle, which will also be the first X coordinate of the constructed Triangle.
- y: number
  The Y coordinate of the right angle, which will also be the first Y coordinate of the constructed Triangle.
- width: number
  The length of the side which is to the left or to the right of the right angle.
- height: number
  The length of the side which is above or below the right angle.
Returns Geom.Triangle
- Defined in types/phaser.d.ts:62046

`Static`CenterOn

CenterOn<O extends Geom.Triangle>(
    triangle: O,
    x: number,
    y: number,
    centerFunc?: CenterFunction,
): O
Positions the Triangle so that it is centered on the given coordinates.
Type Parameters
- O extends Geom.Triangle
Parameters
- triangle: O
  The triangle to be positioned.
- x: number
  The horizontal coordinate to center on.
- y: number
  The vertical coordinate to center on.
- OptionalcenterFunc: CenterFunction
  The function used to center the triangle. Defaults to Centroid centering.
Returns O
- Defined in types/phaser.d.ts:62055

`Static`Centroid

Centroid<O extends Math.Vector2>(triangle: Geom.Triangle, out?: O): O
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.
Type Parameters
- O extends Math.Vector2
Parameters
- triangle: Geom.Triangle
  The Triangle to use.
- Optionalout: O
  A Vector2 object to store the coordinates in.
Returns O
- Defined in types/phaser.d.ts:62064

`Static`CircumCenter

CircumCenter<O extends Math.Vector2>(triangle: Geom.Triangle, out?: O): O
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.

Adapted from http://bjornharrtell.github.io/jsts/doc/api/jsts_geom_Triangle.js.html
Type Parameters
- O extends Math.Vector2
Parameters
- triangle: Geom.Triangle
  The Triangle to get the circumcenter of.
- Optionalout: O
  The Vector2 object to store the position in. If not given, a new Vector2 instance is created.
Returns O
- Defined in types/phaser.d.ts:62077

`Static`CircumCircle

CircumCircle<O extends Circle>(triangle: Geom.Triangle, out?: O): O
Finds the circumscribed circle (circumcircle) of a Triangle object. The circumcircle is the circle which touches all of the triangle's vertices.

Adapted from https://gist.github.com/mutoo/5617691
Type Parameters
- O extends Circle
Parameters
- triangle: Geom.Triangle
  The Triangle to use as input.
- Optionalout: O
  An optional Circle to store the result in.
Returns O
- Defined in types/phaser.d.ts:62086

`Static`Clone

Clone(source: Geom.Triangle): Geom.Triangle
Clones a Triangle object.
Parameters
- source: Geom.Triangle
  The Triangle to clone.
Returns Geom.Triangle
- Defined in types/phaser.d.ts:62092

`Static`Contains

Contains(triangle: Geom.Triangle, x: number, y: number): boolean
Checks if a point (as a pair of coordinates) is inside a Triangle's bounds.
Parameters
- triangle: Geom.Triangle
  The Triangle to check.
- x: number
  The X coordinate of the point to check.
- y: number
  The Y coordinate of the point to check.
Returns boolean
- Defined in types/phaser.d.ts:62100

`Static`ContainsArray

ContainsArray(
    triangle: Geom.Triangle,
    points: Math.Vector2[],
    returnFirst?: boolean,
    out?: any[],
): Math.Vector2[]
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
- triangle: Geom.Triangle
  The triangle that the points are being checked in.
- points: Math.Vector2[]
  An array of Vector2 objects to check if they are within the triangle.
- OptionalreturnFirst: boolean
  If true, return an array containing only the first point found that is within the triangle. Default false.
- Optionalout: any[]
  If provided, the points that are within the triangle will be appended to this array instead of being added to a new array. If returnFirst is true, only the first point found within the triangle will be appended. This array will also be returned by this function.
Returns Math.Vector2[]
- Defined in types/phaser.d.ts:62111

`Static`ContainsPoint

ContainsPoint(triangle: Geom.Triangle, vec: Math.Vector2): boolean
Tests if a triangle contains a point.
Parameters
- triangle: Geom.Triangle
  The triangle.
- vec: Math.Vector2
  The Vector2 point to test if it's within the triangle.
Returns boolean
- Defined in types/phaser.d.ts:62118

`Static`CopyFrom

CopyFrom<O extends Geom.Triangle>(source: Geom.Triangle, dest: O): O
Copy the values of one Triangle to a destination Triangle.
Type Parameters
- O extends Geom.Triangle
Parameters
- source: Geom.Triangle
  The source Triangle to copy the values from.
- dest: O
  The destination Triangle to copy the values to.
Returns O
- Defined in types/phaser.d.ts:62125

`Static`Decompose

Decompose(triangle: Geom.Triangle, out?: any[]): any[]
Decomposes a Triangle into an array of its points.
Parameters
- triangle: Geom.Triangle
  The Triangle to decompose.
- Optionalout: any[]
  An array to store the points into.
Returns any[]
- Defined in types/phaser.d.ts:62132

`Static`Equals

Equals(triangle: Geom.Triangle, toCompare: Geom.Triangle): boolean
Returns true if two triangles have the same coordinates.
Parameters
- triangle: Geom.Triangle
  The first triangle to check.
- toCompare: Geom.Triangle
  The second triangle to check.
Returns boolean
- Defined in types/phaser.d.ts:62139

`Static`GetPoint

GetPoint<O extends Math.Vector2>(
    triangle: Geom.Triangle,
    position: number,
    out?: O,
): O
Returns a Vector2 point from around the perimeter of a Triangle.
Type Parameters
- O extends Math.Vector2
Parameters
- triangle: Geom.Triangle
  The Triangle to get the point on its perimeter from.
- position: number
  The position along the perimeter of the triangle. A value between 0 and 1.
- Optionalout: O
  An optional Vector2 point to store the value in. If not given a new Vector2 will be created.
Returns O
- Defined in types/phaser.d.ts:62147

`Static`GetPoints

GetPoints<O extends Math.Vector2>(
    triangle: Geom.Triangle,
    quantity: number,
    stepRate: number,
    out?: O,
): O
Returns an array of evenly spaced points on the perimeter of a Triangle.
Type Parameters
- O extends Math.Vector2
Parameters
- triangle: Geom.Triangle
  The Triangle to get the points from.
- quantity: number
  The number of evenly spaced points to return. Set to 0 to return an arbitrary number of points based on the stepRate.
- stepRate: number
  If quantity is 0, the distance between each returned point.
- Optionalout: O
  An array to which the points should be appended.
Returns O
- Defined in types/phaser.d.ts:62156

`Static`InCenter

InCenter<O extends Math.Vector2>(triangle: Geom.Triangle, out?: O): O
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.
Type Parameters
- O extends Math.Vector2
Parameters
- triangle: Geom.Triangle
  The Triangle to find the incenter of.
- Optionalout: O
  An optional Vector2 point in which to store the coordinates.
Returns O
- Defined in types/phaser.d.ts:62163

`Static`Offset

Offset<O extends Geom.Triangle>(triangle: O, x: number, y: number): O
Moves each point (vertex) of a Triangle by a given offset, thus moving the entire Triangle by that offset.
Type Parameters
- O extends Geom.Triangle
Parameters
- triangle: O
  The Triangle to move.
- x: number
  The horizontal offset (distance) by which to move each point. Can be positive or negative.
- y: number
  The vertical offset (distance) by which to move each point. Can be positive or negative.
Returns O
- Defined in types/phaser.d.ts:62171

`Static`Perimeter

Perimeter(triangle: Geom.Triangle): number
Gets the length of the perimeter of the given triangle. Calculated by adding together the length of each of the three sides.
Parameters
- triangle: Geom.Triangle
  The Triangle to get the length from.
Returns number
- Defined in types/phaser.d.ts:62178

`Static`Random

Random<O extends Math.Vector2>(triangle: Geom.Triangle, out?: O): O
Returns a random Point from within the area of the given Triangle.
Type Parameters
- O extends Math.Vector2
Parameters
- triangle: Geom.Triangle
  The Triangle to get a random point from.
- Optionalout: O
  The Vector2 point object to store the position in. If not given, a new Vector2 instance is created.
Returns O
- Defined in types/phaser.d.ts:62185

`Static`Rotate

Rotate<O extends Geom.Triangle>(triangle: O, angle: number): O
Rotates a Triangle about its incenter, which is the point at which its three angle bisectors meet.
Type Parameters
- O extends Geom.Triangle
Parameters
- triangle: O
  The Triangle to rotate.
- angle: number
  The angle by which to rotate the Triangle, in radians.
Returns O
- Defined in types/phaser.d.ts:62192

`Static`RotateAroundPoint

RotateAroundPoint<O extends Geom.Triangle>(
    triangle: O,
    point: Math.Vector2,
    angle: number,
): O
Rotates a Triangle at a certain angle about a given Vector2 point.
Type Parameters
- O extends Geom.Triangle
Parameters
- triangle: O
  The Triangle to rotate.
- point: Math.Vector2
  The Vector2 point to rotate the Triangle around.
- angle: number
  The angle by which to rotate the Triangle, in radians.
Returns O
- Defined in types/phaser.d.ts:62200

`Static`RotateAroundXY

RotateAroundXY<O extends Geom.Triangle>(
    triangle: O,
    x: number,
    y: number,
    angle: number,
): O
Rotates an entire Triangle at a given angle about a specific point.
Type Parameters
- O extends Geom.Triangle
Parameters
- triangle: O
  The Triangle to rotate.
- x: number
  The X coordinate of the point to rotate the Triangle about.
- y: number
  The Y coordinate of the point to rotate the Triangle about.
- angle: number
  The angle by which to rotate the Triangle, in radians.
Returns O
- Defined in types/phaser.d.ts:62209

Class Triangle

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Geom.Triangle

Properties

bottom

left

right

top

Readonlytype

x1

x2

x3

y1

y2

y3

Methods

contains

Parameters

Returns boolean

getLineA

Type Parameters

Parameters

Returns O

getLineB

Type Parameters

Parameters

Returns O

getLineC

Type Parameters

Parameters

Returns O

getPoint

Type Parameters

Parameters

Returns O

getPoints

Type Parameters

Parameters

Returns O

getRandomPoint

Type Parameters

Parameters

Returns O

setTo

Parameters

Returns this

StaticArea

Parameters

Returns number

StaticBuildEquilateral

Parameters

Returns Geom.Triangle

StaticBuildFromPolygon

Type Parameters

Parameters

Returns O

StaticBuildRight

Parameters

Returns Geom.Triangle

StaticCenterOn

Type Parameters

Parameters

Returns O

StaticCentroid

Type Parameters

Parameters

Returns O

StaticCircumCenter

Type Parameters

Parameters

Returns O

StaticCircumCircle

Type Parameters

Parameters

`Readonly`type

`Static`Area

`Static`BuildEquilateral

`Static`BuildFromPolygon

`Static`BuildRight

`Static`CenterOn

`Static`Centroid

`Static`CircumCenter

`Static`CircumCircle

`Static`Clone

`Static`Contains

`Static`ContainsArray

`Static`ContainsPoint

`Static`CopyFrom

`Static`Decompose

`Static`Equals

`Static`GetPoint

`Static`GetPoints

`Static`InCenter

`Static`Offset

`Static`Perimeter

`Static`Random

`Static`Rotate

`Static`RotateAroundPoint

`Static`RotateAroundXY