HobbyPath | plotboilerplate

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

Hierarchy

HobbyPath

Index

Constructors

constructor

Properties

vertices

Methods

Object literals

utils

Constructors

constructor

new HobbyPath(vertices?: Array<Vertex>): HobbyPath

- Defined in src/ts/utils/algorithms/HobbyPath.ts:43
name

HobbyPath

Parameters
- Optional vertices: Array<Vertex>
Returns HobbyPath

Properties

Private vertices

vertices: Array<Vertex>

member: {Array} vertices
memberof: HobbyPath
instance

Methods

addPoint

addPoint(p: Vertex): void

- Defined in src/ts/utils/algorithms/HobbyPath.ts:63
Add a new point to the end of the vertex sequence.

name

addPoint

memberof

HobbyPath

instance

Parameters
- p: Vertex
  
  The vertex (point) to add.
Returns void

generateCurve

generateCurve(circular?: boolean, omega?: number): Array<CubicBezierCurve>

- Defined in src/ts/utils/algorithms/HobbyPath.ts:78
Generate a sequence of cubic Bézier curves from the point set.

name

generateCurve

memberof

HobbyPath

instance

Parameters
- Optional circular: boolean
  
  Specify if the path should be closed.
- Optional omega: number
  
  (default=0) An optional tension parameter.
Returns Array<CubicBezierCurve>

Array

Private hobbyControls

hobbyControls(circular?: boolean, omega?: number): IControlPoints

- Defined in src/ts/utils/algorithms/HobbyPath.ts:121
Computes the control point coordinates for a Hobby curve through the points given.

name

hobbyControls

memberof

HobbyPath

instance

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).

Object literals

Static utils

utils: object

normalize

normalize(vec: Vertex): Vertex

- Defined in src/ts/utils/algorithms/HobbyPath.ts:229
Parameters
- vec: Vertex
Returns Vertex

rho

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

- Defined in src/ts/utils/algorithms/HobbyPath.ts:240
Parameters
- a: number
- b: number
Returns number

rotate

rotate(vert: Vertex, sin: number, cos: number): Vertex

- Defined in src/ts/utils/algorithms/HobbyPath.ts:219
Parameters
- vert: Vertex
- sin: number
- cos: number
Returns Vertex

rotateAngle

rotateAngle(vert: Vertex, alpha: number): Vertex

- Defined in src/ts/utils/algorithms/HobbyPath.ts:225
Parameters
- vert: Vertex
- alpha: number
Returns Vertex

sherman

sherman(a: Array<number>, b: Array<number>, c: Array<number>, d: Array<number>, s: number, t: number): Array<number>

- Defined in src/ts/utils/algorithms/HobbyPath.ts:286
Parameters
- a: Array<number>
- b: Array<number>
- c: Array<number>
- d: Array<number>
- s: number
- t: number
Returns Array<number>

thomas

thomas(a: Array<number>, b: Array<number>, c: Array<number>, d: Array<number>): Array<number>

- Defined in src/ts/utils/algorithms/HobbyPath.ts:256
Parameters
- a: Array<number>
- b: Array<number>
- c: Array<number>
- d: Array<number>
Returns Array<number>

Generated using TypeDoc