Class Ellipse

An Elliptical Curve derived from the Base Curve class.

See https://en.wikipedia.org/wiki/Elliptic_curve for more details.

Hierarchy (View Summary)

Curves.Curve
- Ellipse

Constructors

constructor

new Ellipse(
    x?: number | EllipseCurveConfig,
    y?: number,
    xRadius?: number,
    yRadius?: number,
    startAngle?: number,
    endAngle?: number,
    clockwise?: boolean,
    rotation?: number,
): Curves.Ellipse
Parameters
- Optionalx: number | EllipseCurveConfig
  The x coordinate of the ellipse, or an Ellipse Curve configuration object. Default 0.
- Optionaly: number
  The y coordinate of the ellipse. Default 0.
- OptionalxRadius: number
  The horizontal radius of ellipse. Default 0.
- OptionalyRadius: number
  The vertical radius of ellipse. Default 0.
- OptionalstartAngle: number
  The start angle of the ellipse, in degrees. Default 0.
- OptionalendAngle: number
  The end angle of the ellipse, in degrees. Default 360.
- Optionalclockwise: boolean
  Whether the ellipse angles are given as clockwise (true) or counter-clockwise (false). Default false.
- Optionalrotation: number
  The rotation of the ellipse, in degrees. Default 0.
Returns Curves.Ellipse
Overrides Curve.constructor
- Defined in types/phaser.d.ts:6770

Properties

active

active: boolean

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

angle

angle: number

The rotation of the ellipse, relative to the center, in degrees.

arcLengthDivisions

arcLengthDivisions: number

The quantity of arc length divisions within the curve.

cacheArcLengths

cacheArcLengths: number[]

An array of cached arc length values.

clockwise

clockwise: boolean

true if the ellipse rotation is clockwise or false if anti-clockwise.

defaultDivisions

defaultDivisions: number

The default number of divisions within the curve.

endAngle

endAngle: number

The end angle of the ellipse in degrees.

needsUpdate

needsUpdate: boolean

Does the data of this curve need updating?

p0

p0: Math.Vector2

The center point of the ellipse. Used for calculating rotation.

rotation

rotation: number

The rotation of the ellipse, relative to the center, in radians.

startAngle

startAngle: number

The start angle of the ellipse in degrees.

type

type: string

String based identifier for the type of curve.

x

x: number

The x coordinate of the center of the ellipse.

xRadius

xRadius: number

The horizontal radius of the ellipse.

y

y: number

The y coordinate of the center of the ellipse.

yRadius

yRadius: number

The vertical radius of the ellipse.

Methods

draw

draw<G extends GameObjects.Graphics>(graphics: G, pointsTotal?: number): G
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.
Type Parameters
- G extends GameObjects.Graphics
Parameters
- graphics: G
  The Graphics instance onto which this curve will be drawn.
- OptionalpointsTotal: number
  The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance. Default 32.
Returns G
Inherited from Curve.draw
- Defined in types/phaser.d.ts:6623

getBounds

getBounds(out?: Geom.Rectangle, accuracy?: number): Geom.Rectangle
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
- Optionalout: Geom.Rectangle
  The Rectangle to store the bounds in. If falsey a new object will be created.
- Optionalaccuracy: number
  The accuracy of the bounds calculations. Default 16.
Returns Geom.Rectangle
Inherited from Curve.getBounds
- Defined in types/phaser.d.ts:6633

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:6794

getPointAt

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

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
Get the resolution of the curve.
Parameters
- divisions: number
  Optional divisions value.
Returns number
- Defined in types/phaser.d.ts:6787

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:6781

getTangent

getTangent<O extends Math.Vector2>(t: number, out?: O): O
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
Type Parameters
- O extends Math.Vector2
Parameters
- t: number
  The relative position on the curve, [0..1].
- Optionalout: O
  A vector to store the result in.
Returns O
Inherited from Curve.getTangent
- Defined in types/phaser.d.ts:6722

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
Inherited from Curve.getUtoTmapping
- Defined in types/phaser.d.ts:6744

setClockwise

setClockwise(value: boolean): this
Sets if this curve extends clockwise or anti-clockwise.
Parameters
- value: boolean
  The clockwise state of this curve.
Returns this
- Defined in types/phaser.d.ts:6836

setEndAngle

setEndAngle(value: number): this
Sets the end angle of this curve.
Parameters
- value: number
  The end angle of this curve, in radians.
Returns this
- Defined in types/phaser.d.ts:6830

setHeight

setHeight(value: number): this
Sets the height of this curve.
Parameters
- value: number
  The height of this curve.
Returns this
- Defined in types/phaser.d.ts:6818

setRotation

setRotation(value: number): this
Sets the rotation of this curve.
Parameters
- value: number
  The rotation of this curve, in radians.
Returns this
- Defined in types/phaser.d.ts:6842

setStartAngle

setStartAngle(value: number): this
Sets the start angle of this curve.
Parameters
- value: number
  The start angle of this curve, in radians.
Returns this
- Defined in types/phaser.d.ts:6824

setWidth

setWidth(value: number): this
Sets the width of this curve.
Parameters
- value: number
  The width of this curve.
Returns this
- Defined in types/phaser.d.ts:6812

setXRadius

setXRadius(value: number): this
Sets the horizontal radius of this curve.
Parameters
- value: number
  The horizontal radius of this curve.
Returns this
- Defined in types/phaser.d.ts:6800

setYRadius

setYRadius(value: number): this
Sets the vertical radius of this curve.
Parameters
- value: number
  The vertical radius of this curve.
Returns this
- Defined in types/phaser.d.ts:6806

toJSON

toJSON(): JSONEllipseCurve
JSON serialization of the curve.

Returns JSONEllipseCurve
- Defined in types/phaser.d.ts:6892

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: JSONEllipseCurve): Curves.Ellipse
Creates a curve from the provided Ellipse Curve Configuration object.
Parameters
- data: JSONEllipseCurve
  The JSON object containing this curve data.
Returns Curves.Ellipse
- Defined in types/phaser.d.ts:6898

Class Ellipse

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Curves.Ellipse

Properties

active

angle

arcLengthDivisions

cacheArcLengths

clockwise

defaultDivisions

endAngle

needsUpdate

p0

rotation

startAngle

type

x

xRadius

y

yRadius

Methods

draw

Type Parameters

Parameters

Returns G

getBounds

Parameters

Returns Geom.Rectangle

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

`Static`fromJSON