Class Line

A LineCurve is a "curve" comprising exactly two points (a line segment).

Hierarchy (View Summary)

Curves.Curve
- Line

Constructors

constructor

new Line(p0: Math.Vector2 | number[], p1?: Math.Vector2): Curves.Line
Parameters
- p0: Math.Vector2 | number[]
  The first endpoint.
- Optionalp1: Math.Vector2
  The second endpoint.
Returns Curves.Line
Overrides Curve.constructor
- Defined in types/phaser.d.ts:6911

Properties

active

active: boolean

For a curve on a Path, false means the Path will ignore this curve.

arcLengthDivisions

arcLengthDivisions: number

The quantity of arc length divisions within the curve.

cacheArcLengths

cacheArcLengths: number[]

An array of cached arc length values.

defaultDivisions

defaultDivisions: number

The default number of divisions within the curve.

needsUpdate

needsUpdate: boolean

Does the data of this curve need updating?

p0

p0: Math.Vector2

The first endpoint.

p1

p1: Math.Vector2

The second endpoint.

type

type: string

String based identifier for the type of curve.

Methods

draw

draw<G extends GameObjects.Graphics>(graphics: G): G
Draws this curve on the given Graphics object.

The curve is drawn using Graphics.lineBetween so will be drawn at whatever the present Graphics line color is. The Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.
Type Parameters
- G extends GameObjects.Graphics
Parameters
- graphics: G
  The Graphics instance onto which this curve will be drawn.
Returns G
Overrides Curve.draw
- Defined in types/phaser.d.ts:6982

getBounds

getBounds<O extends Geom.Rectangle>(out?: O): O
Returns a Rectangle where the position and dimensions match the bounds of this Curve.
Type Parameters
- O extends Geom.Rectangle
Parameters
- Optionalout: O
  A Rectangle object to store the bounds in. If not given a new Rectangle will be created.
Returns O
Overrides Curve.getBounds
- Defined in types/phaser.d.ts:6932

getDistancePoints

getDistancePoints(distance: number): Math.Vector2[]
Returns an array of points, spaced out X distance pixels apart. The smaller the distance, the larger the array will be.
Parameters
- distance: number
  The distance, in pixels, between each point along the curve.
Returns Math.Vector2[]
Inherited from Curve.getDistancePoints
- Defined in types/phaser.d.ts:6640

getEndPoint

getEndPoint(out?: Math.Vector2): Math.Vector2
Get a point at the end of the curve.
Parameters
- Optionalout: Math.Vector2
  Optional Vector object to store the result in.
Returns Math.Vector2
Inherited from Curve.getEndPoint
- Defined in types/phaser.d.ts:6646

getLength

getLength(): number
Get total curve arc length

Returns number
Inherited from Curve.getLength
- Defined in types/phaser.d.ts:6651

getLengths

getLengths(divisions?: number): number[]
Get a list of cumulative segment lengths.

These lengths are
- [0] 0
- [1] The first segment
- [2] The first and second segment
- ...
- [divisions] All segments
Parameters
- Optionaldivisions: number
  The number of divisions or segments.
Returns number[]
Inherited from Curve.getLengths
- Defined in types/phaser.d.ts:6665

getPoint

getPoint<O extends Math.Vector2>(t: number, out?: O): O
Get point at relative position in curve according to length.
Type Parameters
- O extends Math.Vector2
Parameters
- t: number
  The position along the curve to return. Where 0 is the start and 1 is the end.
- Optionalout: O
  A Vector2 object to store the result in. If not given will be created.
Returns O
- Defined in types/phaser.d.ts:6951

getPointAt

getPointAt<O extends Math.Vector2>(u: number, out?: O): O
Gets a point at a given position on the line.
Type Parameters
- O extends Math.Vector2
Parameters
- u: number
  The position along the curve to return. Where 0 is the start and 1 is the end.
- Optionalout: O
  A Vector2 object to store the result in. If not given will be created.
Returns O
Overrides Curve.getPointAt
- Defined in types/phaser.d.ts:6958

getPoints

getPoints<O extends Math.Vector2[]>(
    divisions?: number,
    stepRate?: number,
    out?: O,
): O
Get a sequence of evenly spaced points from the curve.

You can pass divisions, stepRate, or neither.

The number of divisions will be
1. divisions, if divisions > 0; or
2. this.getLength / stepRate, if stepRate > 0; or
3. this.defaultDivisions
1 + divisions points will be returned.
Type Parameters
- O extends Math.Vector2[]
Parameters
- Optionaldivisions: number
  The number of divisions to make.
- OptionalstepRate: number
  The curve distance between points, implying divisions.
- Optionalout: O
  An optional array to store the points in.
Returns O
Inherited from Curve.getPoints
- Defined in types/phaser.d.ts:6690

getRandomPoint

getRandomPoint<O extends Math.Vector2>(out?: O): O
Get a random point from the curve.
Type Parameters
- O extends Math.Vector2
Parameters
- Optionalout: O
  A point object to store the result in.
Returns O
Inherited from Curve.getRandomPoint
- Defined in types/phaser.d.ts:6696

getResolution

getResolution(divisions?: number): number
Gets the resolution of the line.
Parameters
- Optionaldivisions: number
  The number of divisions to consider. Default 1.
Returns number
- Defined in types/phaser.d.ts:6944

getSpacedPoints

getSpacedPoints(
    divisions?: number,
    stepRate?: number,
    out?: Math.Vector2[],
): Math.Vector2[]
Get a sequence of equally spaced points (by arc distance) from the curve.

1 + divisions points will be returned.
Parameters
- Optionaldivisions: number
  The number of divisions to make. Default this.defaultDivisions.
- OptionalstepRate: number
  Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.
- Optionalout: Math.Vector2[]
  An optional array to store the points in.
Returns Math.Vector2[]
Inherited from Curve.getSpacedPoints
- Defined in types/phaser.d.ts:6706

getStartPoint

getStartPoint<O extends Math.Vector2>(out?: O): O
Gets the starting point on the curve.
Type Parameters
- O extends Math.Vector2
Parameters
- Optionalout: O
  A Vector2 object to store the result in. If not given will be created.
Returns O
Overrides Curve.getStartPoint
- Defined in types/phaser.d.ts:6938

getTangent

getTangent<O extends Math.Vector2>(t?: number, out?: O): O
Gets the slope of the line as a unit vector.
Type Parameters
- O extends Math.Vector2
Parameters
- Optionalt: number
  The relative position on the line, [0..1].
- Optionalout: O
  A vector to store the result in.
Returns O
Overrides Curve.getTangent
- Defined in types/phaser.d.ts:6965

getTangentAt

getTangentAt<O extends Math.Vector2>(u: number, out?: O): O
Get a unit vector tangent at a relative position on the curve, by arc length.
Type Parameters
- O extends Math.Vector2
Parameters
- u: number
  The relative position on the curve, [0..1].
- Optionalout: O
  A vector to store the result in.
Returns O
Inherited from Curve.getTangentAt
- Defined in types/phaser.d.ts:6729

getTFromDistance

getTFromDistance(distance: number, divisions?: number): number
Given a distance in pixels, get a t to find p.
Parameters
- distance: number
  The distance, in pixels.
- Optionaldivisions: number
  Optional amount of divisions.
Returns number
Inherited from Curve.getTFromDistance
- Defined in types/phaser.d.ts:6736

getUtoTmapping

getUtoTmapping(u: number, distance: number, divisions?: number): number
Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.
Parameters
- u: number
  A float between 0 and 1.
- distance: number
  The distance, in pixels.
- Optionaldivisions: number
  Optional amount of divisions.
Returns number
Overrides Curve.getUtoTmapping
- Defined in types/phaser.d.ts:6973

toJSON

toJSON(): JSONCurve
Gets a JSON representation of the line.

Returns JSONCurve
- Defined in types/phaser.d.ts:6987

updateArcLengths

updateArcLengths(): void
Calculate and cache the arc lengths.

Returns void
Inherited from Curve.updateArcLengths
- Defined in types/phaser.d.ts:6749

`Static`fromJSON

fromJSON(data: JSONCurve): Curves.Line
Configures this line from a JSON representation.
Parameters
- data: JSONCurve
  The JSON object containing this curve data.
Returns Curves.Line
- Defined in types/phaser.d.ts:6993

Class Line

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Curves.Line

Properties

active

arcLengthDivisions

cacheArcLengths

defaultDivisions

needsUpdate

p0

p1

type

Methods

draw

Type Parameters

Parameters

Returns G

getBounds

Type Parameters

Parameters

Returns O

getDistancePoints

Parameters

Returns Math.Vector2[]

getEndPoint

Parameters

Returns Math.Vector2

getLength

Returns number

getLengths

Parameters

Returns number[]

getPoint

Type Parameters

Parameters

Returns O

getPointAt

Type Parameters

Parameters

Returns O

getPoints

Type Parameters

Parameters

Returns O

getRandomPoint

Type Parameters

Parameters

Returns O

getResolution

Parameters

Returns number

getSpacedPoints

Parameters

Returns Math.Vector2[]

getStartPoint

Type Parameters

Parameters

Returns O

getTangent

Type Parameters

Parameters

Returns O

getTangentAt

Type Parameters

Parameters

Returns O

getTFromDistance

Parameters

Returns number

getUtoTmapping

Parameters

Returns number

toJSON

`Static`fromJSON