Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Curves . Curve

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Curves . Curve

A Base Curve class, which all other curve types extend.

Based on the three.js Curve classes created by zz85

Constructor:

new Curve(type)

Parameters:

name type description
type string

The curve type.

Since: 3.0.0
Source: src/curves/Curve.js (Line 12)

Members

<private> _tmpVec2A: Phaser.Math.Vector2
Focus
Focus

Description:

A temporary calculation Vector.

Type:
Since: 3.0.0
Source: src/curves/Curve.js (Line 90)
Focus
Focus
<private> _tmpVec2B: Phaser.Math.Vector2
Focus
Focus

Description:

A temporary calculation Vector.

Type:
Since: 3.0.0
Source: src/curves/Curve.js (Line 100)
Focus
Focus
active: boolean
Focus
Focus

Description:

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

Type:
boolean
Default: true
Since: 3.0.0
Source: src/curves/Curve.js (Line 80)
Focus
Focus
arcLengthDivisions: number
Focus
Focus

Description:

The quantity of arc length divisions within the curve.

Type:
number
Default: 100
Since: 3.0.0
Source: src/curves/Curve.js (Line 50)
Focus
Focus
cacheArcLengths: Array.<number>
Focus
Focus

Description:

An array of cached arc length values.

Type:
Array.<number>
Default: []
Since: 3.0.0
Source: src/curves/Curve.js (Line 60)
Focus
Focus
defaultDivisions: number
Focus
Focus

Description:

The default number of divisions within the curve.

Type:
number
Default: 5
Since: 3.0.0
Source: src/curves/Curve.js (Line 40)
Focus
Focus
needsUpdate: boolean
Focus
Focus

Description:

Does the data of this curve need updating?

Type:
boolean
Default: true
Since: 3.0.0
Source: src/curves/Curve.js (Line 70)
Focus
Focus
type: string
Focus
Focus

Description:

String based identifier for the type of curve.

Type:
string
Since: 3.0.0
Source: src/curves/Curve.js (Line 31)
Focus
Focus

Methods

draw(graphics, [pointsTotal])
Focus
Focus

Description:

Draws this curve on the given Graphics object.

The curve is drawn using Graphics.strokePoints so will be drawn at whatever the present Graphics stroke 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.

Parameters:

name type arguments Default description
graphics Phaser.GameObjects.Graphics

The Graphics instance onto which this curve will be drawn.

pointsTotal number <optional> 32

The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.

Returns:
Description:

The Graphics object to which the curve was drawn.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 111)
Focus
Focus
getBounds([out], [accuracy])
Focus
Focus

Description:

Returns a Rectangle where the position and dimensions match the bounds of this Curve.

You can control the accuracy of the bounds. The value given is used to work out how many points to plot across the curve. Higher values are more accurate at the cost of calculation speed.

Parameters:

name type arguments Default description
out Phaser.Geom.Rectangle <optional>

The Rectangle to store the bounds in. If falsey a new object will be created.

accuracy number <optional> 16

The accuracy of the bounds calculations.

Returns:
Description:

A Rectangle object holding the bounds of this curve. If out was given it will be this object.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 135)
Focus
Focus
getDistancePoints(distance)
Focus
Focus

Description:

Returns an array of points, spaced out X distance pixels apart. The smaller the distance, the larger the array will be.

Parameters:

name type description
distance number

The distance, in pixels, between each point along the curve.

Returns:
Description:

An Array of Point objects.

Type:
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 169)
Focus
Focus
getEndPoint([out])
Focus
Focus

Description:

Get a point at the end of the curve.

Parameters:

name type arguments description
out Phaser.Math.Vector2 <optional>

Optional Vector object to store the result in.

Returns:
Description:

Vector2 containing the coordinates of the curves end point.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 189)
Focus
Focus
getLength()
Focus
Focus

Description:

Get total curve arc length

Returns:
Description:

The total length of the curve.

Type:
  • number
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 206)
Focus
Focus
getLengths([divisions])
Focus
Focus

Description:

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:

name type arguments description
divisions number <optional>

The number of divisions or segments.

Returns:
Description:

An array of cumulative lengths.

Type:
  • Array.
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 222)
Focus
Focus
getPointAt(u, [out])
Focus
Focus

Description:

Get a point at a relative position on the curve, by arc length.

Parameters:

name type arguments description
u number

The relative position, [0..1].

out Phaser.Math.Vector2 <optional>

A point to store the result in.

Returns:
Description:

The point.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 278)
Focus
Focus
getPoints([divisions], [stepRate], [out])
Focus
Focus

Description:

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.

Parameters:

name type arguments description
divisions number <optional>

The number of divisions to make.

stepRate number <optional>

The curve distance between points, implying divisions.

out array | Array.<Phaser.Math.Vector2> <optional>

An optional array to store the points in.

Returns:
Description:

An array of Points from the curve.

Type:
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 300)
Focus
Focus
getRandomPoint([out])
Focus
Focus

Description:

Get a random point from the curve.

Parameters:

name type arguments description
out Phaser.Math.Vector2 <optional>

A point object to store the result in.

Returns:
Description:

The point.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 349)
Focus
Focus
getSpacedPoints([divisions], [stepRate], [out])
Focus
Focus

Description:

Get a sequence of equally spaced points (by arc distance) from the curve.

1 + divisions points will be returned.

Parameters:

name type arguments Default description
divisions number <optional> this.defaultDivisions

The number of divisions to make.

stepRate number <optional>

Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.

out array | Array.<Phaser.Math.Vector2> <optional>

An optional array to store the points in.

Returns:
Description:

An array of points.

Type:
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 370)
Focus
Focus
getStartPoint([out])
Focus
Focus

Description:

Get a point at the start of the curve.

Parameters:

name type arguments description
out Phaser.Math.Vector2 <optional>

A point to store the result in.

Returns:
Description:

The point.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 411)
Focus
Focus
getTFromDistance(distance, [divisions])
Focus
Focus

Description:

Given a distance in pixels, get a t to find p.

Parameters:

name type arguments description
distance number

The distance, in pixels.

divisions number <optional>

Optional amount of divisions.

Returns:
Description:

The distance.

Type:
  • number
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 492)
Focus
Focus
getTangent(t, [out])
Focus
Focus

Description:

Get a unit vector tangent at a relative position on the curve. In case any sub curve does not implement its tangent derivation, 2 points a small delta apart will be used to find its gradient which seems to give a reasonable approximation

Parameters:

name type arguments description
t number

The relative position on the curve, [0..1].

out Phaser.Math.Vector2 <optional>

A vector to store the result in.

Returns:
Description:

Vector approximating the tangent line at the point t (delta +/- 0.0001)

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 430)
Focus
Focus
getTangentAt(u, [out])
Focus
Focus

Description:

Get a unit vector tangent at a relative position on the curve, by arc length.

Parameters:

name type arguments description
u number

The relative position on the curve, [0..1].

out Phaser.Math.Vector2 <optional>

A vector to store the result in.

Returns:
Description:

The tangent vector.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 472)
Focus
Focus
getUtoTmapping(u, distance, [divisions])
Focus
Focus

Description:

Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.

Parameters:

name type arguments description
u number

A float between 0 and 1.

distance number

The distance, in pixels.

divisions number <optional>

Optional amount of divisions.

Returns:
Description:

The equidistant value.

Type:
  • number
Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 513)
Focus
Focus
updateArcLengths()
Focus
Focus

Description:

Calculate and cache the arc lengths.

Examples:
Since: 3.0.0
Source: src/curves/Curve.js (Line 594)
Focus
Focus