Class: Spline

Phaser.Curves. Spline

[description]


new Spline( [points])

Parameters:
Name Type Argument Description
points Array.<Phaser.Math.Vector2> <optional>

[description]

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 14)

Extends

Members


active :boolean

[description]

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • true
Source: src/curves/Curve.js (Line 80)

arcLengthDivisions :integer

The quantity of arc length divisions within the curve.

Type:
  • integer
Since: 3.0.0
Inherited From:
Default Value:
  • 100
Source: src/curves/Curve.js (Line 50)

cacheArcLengths :Array.<number>

An array of cached arc length values.

Type:
  • Array.<number>
Since: 3.0.0
Inherited From:
Default Value:
  • []
Source: src/curves/Curve.js (Line 60)

defaultDivisions :integer

The default number of divisions within the curve.

Type:
  • integer
Since: 3.0.0
Inherited From:
Default Value:
  • 5
Source: src/curves/Curve.js (Line 40)

needsUpdate :boolean

Does the data of this curve need updating?

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • true
Source: src/curves/Curve.js (Line 70)

points :Array.<Phaser.Math.Vector2>

[description]

Type:
Since: 3.0.0
Default Value:
  • []
Source: src/curves/SplineCurve.js (Line 38)

type :string

String based identifier for the type of curve.

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

Methods


<static> fromJSON(data)

[description]

Parameters:
Name Type Description
data Phaser.Types.Curves.JSONCurve

The JSON object containing this curve data.

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 204)
Returns:

[description]

Type
Phaser.Curves.Spline

addPoint(x, y)

[description]

Parameters:
Name Type Description
x number

[description]

y number

[description]

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 91)
Returns:

[description]

Type
Phaser.Math.Vector2

addPoints(points)

[description]

Parameters:
Name Type Description
points Array.<Phaser.Math.Vector2> | Array.<number> | Array.<Array.<number>>

[description]

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 51)
Returns:

This curve object.

Type
Phaser.Curves.Spline

draw(graphics [, pointsTotal])

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 Argument Default Description
graphics Phaser.GameObjects.Graphics

The Graphics instance onto which this curve will be drawn.

pointsTotal integer <optional>
32

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

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 111)
Returns:

The Graphics object to which the curve was drawn.

Type
Phaser.GameObjects.Graphics

getBounds( [out] [, accuracy])

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 Argument Default Description
out Phaser.Geom.Rectangle <optional>

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

accuracy integer <optional>
16

The accuracy of the bounds calculations.

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 135)
Returns:

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

Type
Phaser.Geom.Rectangle

getDistancePoints(distance)

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 integer

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

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 169)
Returns:

An Array of Point objects.

Type
Array.<Phaser.Geom.Point>

getEndPoint( [out])

[description]

Parameters:
Name Type Argument Description
out Phaser.Math.Vector2 <optional>

Optional Vector object to store the result in.

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 189)
Returns:

Vector2 containing the coordinates of the curves end point.

Type
Phaser.Math.Vector2

getLength()

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 208)
Returns:

[description]

Type
number

getLengths( [divisions])

[description]

Parameters:
Name Type Argument Description
divisions integer <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 225)
Returns:

[description]

Type
Array.<number>

getPoint(t [, out])

Get point at relative position in curve according to length.

Parameters:
Name Type Argument Description
t number

The position along the curve to return. Where 0 is the start and 1 is the end.

out Phaser.Math.Vector2 <optional>

A Vector2 object to store the result in. If not given will be created.

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 145)
Returns:

The coordinates of the point on the curve. If an out object was given this will be returned.

Type
Phaser.Math.Vector2

getPointAt(u [, out])

[description]

Parameters:
Name Type Argument Description
u number

[description]

out Phaser.Math.Vector2 <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 273)
Returns:

[description]

Type
Phaser.Math.Vector2

getPoints( [divisions])

[description]

Parameters:
Name Type Argument Description
divisions integer <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 295)
Returns:

[description]

Type
Array.<Phaser.Math.Vector2>

getRandomPoint( [out])

[description]

Parameters:
Name Type Argument Description
out Phaser.Math.Vector2 <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 319)
Returns:

[description]

Type
Phaser.Math.Vector2

getResolution(divisions)

[description]

Parameters:
Name Type Description
divisions number

[description]

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 130)
Returns:

[description]

Type
number

getSpacedPoints( [divisions])

[description]

Parameters:
Name Type Argument Description
divisions integer <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 340)
Returns:

[description]

Type
Array.<Phaser.Math.Vector2>

getStartPoint( [out])

Gets the starting point on the curve.

Parameters:
Name Type Argument Description
out Phaser.Math.Vector2 <optional>

A Vector2 object to store the result in. If not given will be created.

Since: 3.0.0
Overrides:
Source: src/curves/SplineCurve.js (Line 111)
Returns:

The coordinates of the point on the curve. If an out object was given this will be returned.

Type
Phaser.Math.Vector2

getTangent(t [, out])

[description]

Parameters:
Name Type Argument Description
t number

[description]

out Phaser.Math.Vector2 <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 390)
Returns:

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

Type
Phaser.Math.Vector2

getTangentAt(u [, out])

[description]

Parameters:
Name Type Argument Description
u number

[description]

out Phaser.Math.Vector2 <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 429)
Returns:

[description]

Type
Phaser.Math.Vector2

getTFromDistance(distance [, divisions])

[description]

Parameters:
Name Type Argument Description
distance integer

[description]

divisions integer <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 450)
Returns:

[description]

Type
number

getUtoTmapping(u, distance [, divisions])

[description]

Parameters:
Name Type Argument Description
u number

[description]

distance integer

[description]

divisions integer <optional>

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 473)
Returns:

[description]

Type
number

toJSON()

[description]

Since: 3.0.0
Source: src/curves/SplineCurve.js (Line 178)
Returns:

The JSON object containing this curve data.

Type
Phaser.Types.Curves.JSONCurve

updateArcLengths()

[description]

Since: 3.0.0
Inherited From:
Source: src/curves/Curve.js (Line 554)