Class ArcCurve

Alias for EllipseCurve.

Hierarchy

EllipseCurve
- ArcCurve

Constructors

constructor

new ArcCurve(x?: number, y?: number, radius?: number, startAngle?: number, endAngle?: number, islockwise?: boolean): ArcCurve
Create a new instance.
Parameters
- Optional x: number
  
  – The X center of the ellipse. Default is 0.
- Optional y: number
  
  – The Y center of the ellipse. Default is 0.
- Optional radius: number
  
  – The radius of the ellipse in the x and y direction. Default is 1.
- Optional startAngle: number
  
  – The start angle of the curve in radians starting from the positive X axis. Default is 0.
- Optional endAngle: number
  
  – The end angle of the curve in radians starting from the positive X axis. Default is 2 x Math.PI.
- Optional islockwise: boolean
Returns ArcCurve
Overrides EllipseCurve.constructor
- Defined in curves/ArcCurve.d.ts:28

Properties

aClockwise

aClockwise: boolean

Whether the ellipse is drawn clockwise.

Default Value

false

aEndAngle

aEndAngle: number

The end angle of the curve in radians starting from the middle right side.

Default

2 * Math.PI

aRotation

aRotation: number

The rotation angle of the ellipse in radians, counterclockwise from the positive X axis

Default Value

aStartAngle

aStartAngle: number

The start angle of the curve in radians starting from the middle right side.

Default Value

aX

aX: number

The X center of the ellipse.

Default Value

aY

aY: number

The Y center of the ellipse.

Default Value

arcLengthDivisions

arcLengthDivisions: number

Determines the amount of divisions when calculating the cumulative segment lengths of a curve via .getLengths. To ensure precision when using methods like .getSpacedPoints, it is recommended to increase .arcLengthDivisions if the curve is very large.

Default

200

`Readonly` isArcCurve

isArcCurve: boolean

Default Value

true

`Readonly` isCatmullRomCurve3

isCatmullRomCurve3: boolean

subclass should override

Default Value

true

`Readonly` isCubicBezierCurve

isCubicBezierCurve: boolean

subclass should override

Default Value

false

`Readonly` isCubicBezierCurve3

isCubicBezierCurve3: boolean

subclass should override

Default Value

false

`Readonly` isEllipseCurve

isEllipseCurve: boolean

Default Value

true

`Readonly` isLineCurve

isLineCurve: boolean

subclass should override

Default Value

false

`Readonly` isLineCurve3

isLineCurve3: boolean

subclass should override

Default Value

false

`Readonly` isQuadraticBezierCurve

isQuadraticBezierCurve: boolean

subclass should override

Default Value

false

`Readonly` isQuadraticBezierCurve3

isQuadraticBezierCurve3: boolean

subclass should override

Default Value

false

`Readonly` isSplineCurve

isSplineCurve: boolean

subclass should override

Default Value

false

`Readonly` type

type: string

Default Value

'ArcCurve'

xRadius

xRadius: number

The radius of the ellipse in the x direction.

Default Value

yRadius

yRadius: number

The radius of the ellipse in the y direction.

Default Value

Methods

clone

clone(): Curve<Vector2>
Creates a new instance with same property values as this curve.

Returns
A new Curve instance exactly like this curve.

Returns Curve<Vector2>
Inherited from EllipseCurve.clone
- Defined in core/Curve.d.ts:134

computeFrenetFrames

computeFrenetFrames(segments: number, closed?: boolean): { binormals: Vector3[]; normals: Vector3[]; tangents: Vector3[] }
Generates the Frenet frames. Learn more at http://www.cs.indiana.edu/pub/techreports/TR425.pdf

Returns
An object with shape: { tangents: Vector3[]; normals: Vector3[]; binormals: Vector3[]; }
Parameters
- segments: number
  
  Number of segments
- Optional closed: boolean
  
  True if this curve is closed.
Returns { binormals: Vector3[]; normals: Vector3[]; tangents: Vector3[] }
- binormals: Vector3[]
- normals: Vector3[]
- tangents: Vector3[]
Inherited from EllipseCurve.computeFrenetFrames
- Defined in core/Curve.d.ts:121

copy

copy(source: Curve<Vector2>): ArcCurve
Copies another Curve object's properties to this instance.

Returns
This instance.
Parameters
- source: Curve<Vector2>
  
  The source curve.
Returns ArcCurve
Inherited from EllipseCurve.copy
- Defined in core/Curve.d.ts:141

fromJSON

fromJSON(json: object): ArcCurve
Copies the data from the given JSON object to this instance.

Returns
This instance.
Parameters
- json: object
  
  The source JSON object.
Returns ArcCurve
Inherited from EllipseCurve.fromJSON
- Defined in core/Curve.d.ts:154

getLength

getLength(): number
Get total curve arc length.

Returns
The total arc length.

Returns number
Inherited from EllipseCurve.getLength
- Defined in core/Curve.d.ts:64

getLengths

getLengths(divisions?: number): number[]
Get list of cumulative segment lengths.

Returns
Array of points
Parameters
- Optional divisions: number
Returns number[]
Inherited from EllipseCurve.getLengths
- Defined in core/Curve.d.ts:71

getPoint

getPoint(t: number, optionalTarget?: Vector2): Vector2
Find the point (vector) for point t of the curve where t is between 0 and 1.

Returns
The point.
Parameters
- t: number
  
  A position on the curve. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector2
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector2
Inherited from EllipseCurve.getPoint
- Defined in core/Curve.d.ts:35

getPointAt

getPointAt(u: number, optionalTarget?: Vector2): Vector2
Find a vector for point at relative position in curve according to arc length

Returns
The point.
Parameters
- u: number
  
  A position on the curve according to the arc length. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector2
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector2
Inherited from EllipseCurve.getPointAt
- Defined in core/Curve.d.ts:44

getPoints

getPoints(divisions?: number): Vector2[]
Compute a set of divisions + 1 points using getPoint( t ).

Returns
Array of point vectors.
Parameters
- Optional divisions: number
  
  number of pieces to divide the curve into. Default is 5.
Returns Vector2[]
Inherited from EllipseCurve.getPoints
- Defined in core/Curve.d.ts:51

getSpacedPoints

getSpacedPoints(divisions?: number): Vector2[]
Compute a set of divisions + 1 equi-spaced points using getPointAt( u ).

Returns
Array of point vectors.
Parameters
- Optional divisions: number
  
  number of pieces to divide the curve into. Default is 5.
Returns Vector2[]
Inherited from EllipseCurve.getSpacedPoints
- Defined in core/Curve.d.ts:58

getTangent

getTangent(t: number, optionalTarget?: Vector2): Vector2
Compute a unit vector tangent at t. If the subclassed curve do 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 getTangent(t: number, optionalTarget?: T): T;

Returns
A vector tangent to t.
Parameters
- t: number
  
  A position on the curve. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector2
  
  — (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector2
Inherited from EllipseCurve.getTangent
- Defined in core/Curve.d.ts:93

getTangentAt

getTangentAt(u: number, optionalTarget?: Vector2): Vector2
Compute the tangent at a point which is equidistant to the ends of the curve from the point given in getTangent().

Returns
a vector tangent to u.
Parameters
- u: number
  
  A position on the curve according to the arc length. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector2
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector2
Inherited from EllipseCurve.getTangentAt
- Defined in core/Curve.d.ts:108

getUtoTmapping

getUtoTmapping(u: number, distance: number): number
Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equi distance
Parameters
- u: number
- distance: number
Returns number
Inherited from EllipseCurve.getUtoTmapping
- Defined in core/Curve.d.ts:81

toJSON

toJSON(): object
Create a JSON object representation of this instance.

Returns
A JSON object

Returns object
Inherited from EllipseCurve.toJSON
- Defined in core/Curve.d.ts:147

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

Returns void
Inherited from EllipseCurve.updateArcLengths
- Defined in core/Curve.d.ts:76

Class ArcCurve

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional radius: number

Optional startAngle: number

Optional endAngle: number

Optional islockwise: boolean

Returns ArcCurve

Properties

aClockwise

Default Value

aEndAngle

Default

aRotation

Default Value

aStartAngle

Default Value

aX

Default Value

aY

Default Value

arcLengthDivisions

Default

Readonly isArcCurve

Default Value

Readonly isCatmullRomCurve3

Default Value

Readonly isCubicBezierCurve

Default Value

Readonly isCubicBezierCurve3

Default Value

Readonly isEllipseCurve

Default Value

Readonly isLineCurve

Default Value

Readonly isLineCurve3

Default Value

Readonly isQuadraticBezierCurve

Default Value

Readonly isQuadraticBezierCurve3

Default Value

Readonly isSplineCurve

Default Value

Readonly type

Default Value

xRadius

Default Value

yRadius

Default Value

Methods

clone

Returns

Returns Curve<Vector2>

computeFrenetFrames

Returns

Parameters

segments: number

Optional closed: boolean

Returns { binormals: Vector3[]; normals: Vector3[]; tangents: Vector3[] }

binormals: Vector3[]

normals: Vector3[]

tangents: Vector3[]

copy

Returns

Parameters

source: Curve<Vector2>

Returns ArcCurve

fromJSON

Returns

Parameters

json: object

Returns ArcCurve

`Optional` x: number

`Optional` y: number

`Optional` radius: number

`Optional` startAngle: number

`Optional` endAngle: number

`Optional` islockwise: boolean

`Readonly` isArcCurve

`Readonly` isCatmullRomCurve3

`Readonly` isCubicBezierCurve

`Readonly` isCubicBezierCurve3

`Readonly` isEllipseCurve

`Readonly` isLineCurve

`Readonly` isLineCurve3

`Readonly` isQuadraticBezierCurve

`Readonly` isQuadraticBezierCurve3

`Readonly` isSplineCurve

`Readonly` type

`Optional` closed: boolean

`Optional` divisions: number

`Optional` optionalTarget: Vector2

`Optional` optionalTarget: Vector2

`Optional` divisions: number

`Optional` divisions: number

`Optional` optionalTarget: Vector2

`Optional` optionalTarget: Vector2