module:extras/curvetube.CurveTube

Back to documentation index.

new module:extras/curvetube.CurveTube(func, [thickness], [sweptCurve])

A surface evaluator object for a tube extruded from a parametric curve.

This class is considered a supplementary class to the Public Domain HTML 3D Library and is not considered part of that library.

Parameters

• func (Type: Object)
  A curve evaluator object that describes the 3-dimensional curve to extrude a tube from. For best results, the curve should be continuous and smooth.
• thickness (Type: number) (optional)
  Radius of the extruded tube. If this parameter is null, undefined, or omitted, the default is 0.125.
• sweptCurve (Type: Object) (optional)
  A curve evaluator object that describes a two-dimensional curve to serve as the cross section of the extruded shape. The curve need not be closed. If this parameter is null, undefined, or omitted, uses a circular cross section in which the V coordinate ranges from 0 through 1. The cross section will generally have a radius of 1 unit; bigger or smaller cross sections will affect the meaning of the "thickness" parameter.

Methods

• endPoints
  Returns the starting and ending U and V coordinates of this surface.
• evaluate
  Generates a point on the extruded tube from the given u and V coordinates.

module:extras/curvetube~CurveTube#endPoints()

Returns the starting and ending U and V coordinates of this surface.

Return Value

A four-element array. The first and second elements are the starting and ending U coordinates, respectively, of the surface, and the third and fourth elements are its starting and ending V coordinates. The starting and ending U coordinates will be the extruded curve's end points (or [0, 1] if it doesn't implement an endPoints method). The starting and ending V coordinates are [0, π] by default, but if a cross section curve is defined, those V coordinates will be that curve's end points (or [0, 1] if it doesn't implement an endPoints method).

module:extras/curvetube~CurveTube#evaluate(u, v)

Generates a point on the extruded tube from the given u and V coordinates.

Parameters

• u (Type: number)
  U coordinate. This will run the length of the curve.
• v (Type: number)
  V coordinate. This will sweep around the extruded tube.

Return Value

A 3-element array specifying a 3D point. (Type: Array.<number>)

Back to documentation index.