Class CubicBezierCurve

A smooth 2d cubic bezier curve, defined by a start point, endpoint and two control points.

Example

const curve = new CubicBezierCurve(
  new Vector2( -10, 0 ),
  new Vector2( -5, 15 ),
  new Vector2( 20, 15 ),
  new Vector2( 10, 0 )
);

const points = curve.getPoints( 50 );

Hierarchy

Curve<Vector2>
- CubicBezierCurve

Constructors

constructor

new CubicBezierCurve(v0?: Vector2, v1?: Vector2, v2?: Vector2, v3?: Vector2): CubicBezierCurve
Create a new instance.
Parameters
- Optional v0: Vector2
  
  The starting point.
- Optional v1: Vector2
  
  – The first control point.
- Optional v2: Vector2
  
  The second control point.
- Optional v3: Vector2
  
  The ending point.
Returns CubicBezierCurve
Overrides Curve.constructor
- Defined in curves/CubicBezierCurve.d.ts:62

Properties

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

subclass should override

Default Value

false

`Readonly` isCatmullRomCurve3

isCatmullRomCurve3: boolean

subclass should override

Default Value

true

`Readonly` isCubicBezierCurve

isCubicBezierCurve: boolean

Default Value

true

`Readonly` isCubicBezierCurve3

isCubicBezierCurve3: boolean

subclass should override

Default Value

false

`Readonly` isEllipseCurve

isEllipseCurve: boolean

subclass should override

Default Value

false

`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

'CubicBezierCurve'

v0

v0: Vector2

The starting point.

Default Value

new Vector2()

v1

v1: Vector2

The first control point.

Default Value

new Vector2()

v2

v2: Vector2

The second control point.

Default Value

new Vector2()

v3

v3: Vector2

The end point.

Default Value

new Vector2()

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 Curve.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 Curve.computeFrenetFrames
- Defined in core/Curve.d.ts:121

copy

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

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

fromJSON

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

Returns
This instance.
Parameters
- json: object
  
  The source JSON object.
Returns CubicBezierCurve
Inherited from Curve.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 Curve.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 Curve.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 Curve.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 Curve.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 Curve.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 Curve.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 Curve.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 Curve.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 Curve.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 Curve.toJSON
- Defined in core/Curve.d.ts:147

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

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

Class CubicBezierCurve

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional v0: Vector2

Optional v1: Vector2

Optional v2: Vector2

Optional v3: Vector2

Returns CubicBezierCurve

Properties

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

v0

Default Value

v1

Default Value

v2

Default Value

v3

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 CubicBezierCurve

fromJSON

Returns

Parameters

json: object

Returns CubicBezierCurve

getLength

Returns

Returns number

getLengths

Returns

Parameters

Optional divisions: number

Returns number[]

getPoint

`Optional` v0: Vector2

`Optional` v1: Vector2

`Optional` v2: Vector2

`Optional` v3: Vector2

`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