Class HobbyPath

Classdesc

A HobbyCurve/HobbyPath calculation class: compute a set of optimal cubic Bézier curves from a sequence of vertices.

Requires

CubicBezierCurve

Requires

Vertex

Index

Constructors

constructor

new HobbyPath(vertices?): HobbyPath
Parameters
- Optional vertices: Vertex[]
Returns HobbyPath
Name
HobbyPath
- Defined in plotboilerplate/src/ts/utils/algorithms/HobbyPath.ts:50

Properties

`Private` vertices

vertices: Vertex[]

Member

vertices

Memberof

HobbyPath

Instance

`Static` utils

utils: {
    normalize: ((vec) => Vertex);
    rho: ((a, b) => number);
    rotate: ((vert, sin, cos) => Vertex);
    rotateAngle: ((vert, alpha) => Vertex);
    sherman: ((a, b, c, d, s, t) => number[]);
    thomas: ((a, b, c, d) => number[]);
} = ...

Type declaration

normalize: ((vec) => Vertex)
- - (vec): Vertex
  - Parameters
    - vec: Vertex
    Returns Vertex
rho: ((a, b) => number)
- - (a, b): number
  - Parameters
    - a: number
    - b: number
    Returns number
rotate: ((vert, sin, cos) => Vertex)
- - (vert, sin, cos): Vertex
  - Parameters
    - vert: Vertex
    - sin: number
    - cos: number
    Returns Vertex
rotateAngle: ((vert, alpha) => Vertex)
- - (vert, alpha): Vertex
  - Parameters
    - vert: Vertex
    - alpha: number
    Returns Vertex
sherman: ((a, b, c, d, s, t) => number[])
- - (a, b, c, d, s, t): number[]
  - Parameters
    - a: number[]
    - b: number[]
    - c: number[]
    - d: number[]
    - s: number
    - t: number
    Returns number[]
thomas: ((a, b, c, d) => number[])
- - (a, b, c, d): number[]
  - Parameters
    - a: number[]
    - b: number[]
    - c: number[]
    - d: number[]
    Returns number[]

Methods

addPoint

addPoint(p): void
Add a new point to the end of the vertex sequence.
Parameters
- p: Vertex
  The vertex (point) to add.
Returns void
Name
addPoint

Memberof
HobbyPath

Instance
- Defined in plotboilerplate/src/ts/utils/algorithms/HobbyPath.ts:63

generateCurve

generateCurve(circular?, omega?): CubicBezierCurve[]
Generate a sequence of cubic Bézier curves from the point set.
Parameters
- Optional circular: boolean
  Specify if the path should be closed.
- Optional omega: number
  (default=0) An optional tension parameter.
Returns CubicBezierCurve[]
Array

Name
generateCurve

Memberof
HobbyPath

Instance
- Defined in plotboilerplate/src/ts/utils/algorithms/HobbyPath.ts:78

`Private` hobbyControls

hobbyControls(circular?, omega?): IControlPoints
Computes the control point coordinates for a Hobby curve through the points given.
Parameters
- Optional circular: boolean
  If true, then the path will be closed.
- Optional omega: number
  The 'curl' or the path.
Returns IControlPoints
An object with two members: startControlPoints and endControlPoints (Array).

Name
hobbyControls

Memberof
HobbyPath

Instance
- Defined in plotboilerplate/src/ts/utils/algorithms/HobbyPath.ts:121

Class HobbyPath

Classdesc

Requires

Requires

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HobbyPath

Name

Properties

Private vertices

Member

Memberof

Instance

Static utils

Type declaration

normalize: ((vec) => Vertex)

Parameters

Returns Vertex

rho: ((a, b) => number)

Parameters

Returns number

rotate: ((vert, sin, cos) => Vertex)

Parameters

Returns Vertex

rotateAngle: ((vert, alpha) => Vertex)

Parameters

Returns Vertex

sherman: ((a, b, c, d, s, t) => number[])

Parameters

Returns number[]

thomas: ((a, b, c, d) => number[])

Parameters

Returns number[]

Methods

addPoint

Parameters

Returns void

Name

Memberof

Instance

generateCurve

Parameters

Returns CubicBezierCurve[]

Name

Memberof

Instance

Private hobbyControls

Parameters

Returns IControlPoints

Name

Memberof

Instance

On This Page

`Private` vertices

`Static` utils

`Private` hobbyControls