Class: CubicBezier

Phaser.Curves. CubicBezier

A higher-order Bézier curve constructed of four points.


new CubicBezier(p0, p1, p2, p3)

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

Start point, or an array of point pairs.

p1 Phaser.Math.Vector2

Control Point 1.

p2 Phaser.Math.Vector2

Control Point 2.

p3 Phaser.Math.Vector2

End Point.

Since: 3.0.0
Source: src/curves/CubicBezierCurve.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)

p0 :Phaser.Math.Vector2

The start point of this curve.

Type:
Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 47)

p1 :Phaser.Math.Vector2

The first control point of this curve.

Type:
Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 56)

p2 :Phaser.Math.Vector2

The second control point of this curve.

Type:
Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 65)

p3 :Phaser.Math.Vector2

The end point of this curve.

Type:
Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 74)

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)

Generates a curve from a JSON object.

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

The JSON object containing this curve data.

Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 199)
Returns:

The curve generated from the JSON object.

Type
Phaser.Curves.CubicBezier

draw(graphics [, pointsTotal])

Draws this curve to the specified graphics object.

Parameters:
Name Type Argument Default Description
graphics Phaser.GameObjects.Graphics

The graphics object this curve should be drawn to.

pointsTotal integer <optional>
32

The number of intermediary points that make up this curve. A higher number of points will result in a smoother curve.

Since: 3.0.0
Overrides:
Source: src/curves/CubicBezierCurve.js (Line 143)
Returns:

The graphics object this curve was drawn to. Useful for method chaining.

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/CubicBezierCurve.js (Line 118)
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)

Returns the resolution of this curve.

Parameters:
Name Type Description
divisions number

The amount of divisions used by this curve.

Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 103)
Returns:

The resolution of the curve.

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/CubicBezierCurve.js (Line 84)
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()

Returns a JSON object that describes this curve.

Since: 3.0.0
Source: src/curves/CubicBezierCurve.js (Line 176)
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)