CatmullRomPath | plotboilerplate

classdesc

Compute the Catmull-Rom spline path from a sequence of points (vertices).

For comparison to the HobbyCurve I wanted to add a Catmull-Rom path (to show that the HobbyCurve is smoother).

This demo implementation was inspired by this Codepen by Blake Bowen https://codepen.io/osublake/pen/BowJed

requires

CubicBezierCurve

requires

Vertex

Hierarchy

CatmullRomPath

Index

Constructors

constructor

Properties

vertices

Methods

Constructors

constructor

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

- Defined in src/ts/utils/algorithms/CatmullRomPath.ts:35
name

CatmullRomPath

Parameters
- Optional vertices: Array<Vertex>
Returns CatmullRomPath

Properties

Private vertices

vertices: Array<Vertex>

member: {Array} vertices
memberof: CatmullRomPath
instance

Methods

addPoint

addPoint(p: Vertex): void

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

name

addPoint

memberof

CatmullRomPath

instance

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

generateCurve

generateCurve(circular?: boolean, tension?: number): CubicBezierCurve[]

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

name

generateCurve

memberof

CatmullRomPath

instance

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

Array

Private solveClosed

solveClosed(k: number): Array<CubicBezierCurve>

- Defined in src/ts/utils/algorithms/CatmullRomPath.ts:98
Parameters
- k: number
Returns Array<CubicBezierCurve>

Private solveOpen

solveOpen(k: number): Array<CubicBezierCurve>

- Defined in src/ts/utils/algorithms/CatmullRomPath.ts:81
Parameters
- k: number
Returns Array<CubicBezierCurve>

Generated using TypeDoc