Filter
Constructor:
new Line(p0, [p1])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| p0 | Array.<number> | Phaser.Math.Vector2 |
The first endpoint. |
|
| p1 | Phaser.Math.Vector2 | <optional> |
The second endpoint. |
Extends
Members
Description:
For a curve on a Path, false means the Path will ignore this curve.
Type:
Description:
The quantity of arc length divisions within the curve.
Type:
Description:
An array of cached arc length values.
Type:
Description:
The default number of divisions within the curve.
Type:
Description:
Does the data of this curve need updating?
Type:
Description:
The first endpoint.
Type:
Description:
The second endpoint.
Type:
Description:
String based identifier for the type of curve.
Type:
Methods
Description:
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.
Parameters:
| name | type | description |
|---|---|---|
| graphics | Phaser.GameObjects.Graphics |
The Graphics instance onto which this curve will be drawn. |
Returns:
Description:
The Graphics object to which the curve was drawn.
Description:
Returns a Rectangle where the position and dimensions match the bounds of this Curve.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| out | Phaser.Geom.Rectangle | <optional> |
A Rectangle object to store the bounds in. If not given a new Rectangle will be created. |
Returns:
Description:
A Rectangle object holding the bounds of this curve. If out was given it will be this object.
Type:
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:
- Array.<Phaser.Geom.Point>
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.
Type:
Description:
Get total curve arc length
Returns:
Description:
The total length of the curve.
Type:
- number
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.<number>
Description:
Get point at relative position in curve according to length.
Parameters:
| name | type | arguments | 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. |
Returns:
Description:
The coordinates of the point on the curve. If an out object was given this will be returned.
Type:
Description:
Gets a point at a given position on the line.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| u | 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. |
Returns:
Description:
The coordinates of the point on the curve. If an out object was given this will be returned.
Type:
Description:
Get a sequence of evenly spaced points from the curve.
You can pass divisions, stepRate, or neither.
The number of divisions will be
-
divisions, ifdivisions> 0; or -
this.getLength / stepRate, ifstepRate> 0; or -
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 |
| 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:
- array
- Array.<Phaser.Math.Vector2>
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.
Type:
Description:
Gets the resolution of the line.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| divisions | number | <optional> | 1 |
The number of divisions to consider. |
Returns:
Description:
The resolution. Equal to the number of divisions.
Type:
- number
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:
- Array.<Phaser.Math.Vector2>
Description:
Gets the starting point on the curve.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| out | Phaser.Math.Vector2 | <optional> |
A Vector2 object to store the result in. If not given will be created. |
Returns:
Description:
The coordinates of the point on the curve. If an out object was given this will be returned.
Type:
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
Description:
Gets the slope of the line as a unit vector.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| t | number | <optional> |
The relative position on the line, [0..1]. |
| out | Phaser.Math.Vector2 | <optional> |
A vector to store the result in. |
Returns:
Description:
The tangent vector.
Type:
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.
Type:
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
Description:
Gets a JSON representation of the line.
Returns:
Description:
The JSON object containing this curve data.
Description:
Calculate and cache the arc lengths.
Description:
Configures this line from a JSON representation.
Parameters:
| name | type | description |
|---|---|---|
| data | Phaser.Types.Curves.JSONCurve |
The JSON object containing this curve data. |
Returns:
Description:
A new LineCurve object.
Type: