module:extras/derivedcurves

Back to documentation index.

module:extras/derivedcurves()

Additional curve evaluator and surface evaluator objects.

To import all symbols in this module, either of the following can be used:

import * from "extras/derivedcurves.js";
// -- or --
import * as CustomModuleName from "extras/derivedcurves.js";

Methods

• curveCatacaustic
  Creates a curve evaluator object for TODO: Not documented yet.
• curveEvolute
  Creates a curve evaluator object for the curve from which an involute curve is generated.
• curveInverse
  Creates a curve evaluator object for a curve with reciprocal (inverted) polar coordinates to that of another curve.
• curveInvolute
  Creates a curve evaluator object for a curve generated by the end of a string when it is wound up along another curve.
• curveOrthotomic
  Creates a curve evaluator object for TODO: Not documented yet.
• curvePedalCurve
  Creates a curve evaluator object for TODO: Not documented yet.
• curveRadialCurve
  Creates a curve evaluator object for TODO: Not documented yet.
• polarCurve
  Creates a curve evaluator object for a polar curve, a curve generated from its polar coordinates using a polar function, a function that determines a point's radius given its angle.
• ruledSurface
  Creates a surface evaluator object for TODO: Not documented yet.
• spiralCurve
  Creates a curve evaluator object for TODO: Not documented yet.

(static) module:extras/derivedcurves.curveCatacaustic(evaluator, ox, oy)

Creates a curve evaluator object for TODO: Not documented yet.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for TODO: Not documented yet.
• ox (Type: *)
• oy (Type: *)

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.curveEvolute(evaluator)

Creates a curve evaluator object for the curve from which an involute curve is generated.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for the involute curve.

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.curveInverse(evaluator, [ox], [oy], [radius])

Creates a curve evaluator object for a curve with reciprocal (inverted) polar coordinates to that of another curve.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for a curve from which an inverse curve is to be evaluated.
• ox (Type: number) (optional)
  X coordinate of the curve's polar coordinate origin (the inversion center) for the purpose of evaluating its inverse curve. If null, undefined, or omitted, the default is 0.
• oy (Type: number) (optional)
  Y coordinate of the inversion center. If null, undefined, or omitted, the default is 0.
• radius (Type: number) (optional)
  If null, undefined, or omitted, the default is 1. TODO: Not documented fully yet.

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.curveInvolute(evaluator)

Creates a curve evaluator object for a curve generated by the end of a string when it is wound up along another curve.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for the curve from which its involute (from the start of the curve) is generated.

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.curveOrthotomic(evaluator, ox, oy)

Creates a curve evaluator object for TODO: Not documented yet.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for TODO: Not documented yet.
• ox (Type: *)
• oy (Type: *)

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.curvePedalCurve(evaluator, ox, oy)

Creates a curve evaluator object for TODO: Not documented yet.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for TODO: Not documented yet.
• ox (Type: *)
• oy (Type: *)

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.curveRadialCurve(evaluator, ox, oy)

Creates a curve evaluator object for TODO: Not documented yet.

Parameters

• evaluator (Type: Curve | Object)
  A curve evaluator object for TODO: Not documented yet.
• ox (Type: *)
• oy (Type: *)

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.polarCurve(func, [phase])

Creates a curve evaluator object for a polar curve, a curve generated from its polar coordinates using a polar function, a function that determines a point's radius given its angle.

Parameters

• func (Type: function)
  Function that determines the radius of a point on the curve given its angle. It takes one parameter, angle, giving the angle in radians. angle can be any number and is not limited to the interval [-π, π) or [0, 2π).
• phase (Type: number) (optional)
  Starting polar angle of the curve. If null, undefined, or omitted, the default is 0.

Return Value

The resulting curve evaluator object. (Type: Object)

(static) module:extras/derivedcurves.ruledSurface(directrix, director)

Creates a surface evaluator object for TODO: Not documented yet.

Parameters

• directrix (Type: *)
• director (Type: *)

Return Value

The resulting surface evaluator object. (Type: Object)

(static) module:extras/derivedcurves.spiralCurve(radius, [phase])

Creates a curve evaluator object for TODO: Not documented yet.

Parameters

• radius (Type: *)
• phase (Type: number) (optional)
  TODO If null, undefined, or omitted, the default is 0.

Return Value

The resulting curve evaluator object. (Type: Object)

Back to documentation index.