Namespace: primitives-1D

Source: primitives-1d/index.js, line 1

Methods

BSplineCurve(parameters) → {Edge}

Creates a BSpline curve passing through a set of points.

Parameters:

Name Type Description

parameters

Object

The parameters for the BSpline curve.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the curve is constructed.
`points`	Array.<Vector>			The points through which the curve passes.
`minDegree`	number	<optional>	1	The minimum degree of the BSpline curve.
`maxDegree`	number	<optional>	6	The maximum degree of the BSpline curve.
`continuityType`	'c0' \| 'c1' \| 'c2' \| 'c3' \| 'cn' \| 'g1' \| 'g2'	<optional>	"c2"	The continuity type of the curve.

Source: primitives-1d/bspline-curve.js, line 18

Returns:

An Edge object representing the constructed BSpline curve.

Type:: Edge

BezierCurve(parameters) → {Edge}

Creates a Bezier curve from the given control points.

Parameters:

Name Type Description

parameters

Object

The parameters for the Bezier curve.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the curve is constructed.
`points`	Array.<Vector>			The control points for the Bezier curve.

Source: primitives-1d/bezier-curve.js, line 14

Returns:

An Edge object representing the constructed Bezier curve.

Type:: Edge

Line(parameters) → {Edge}

Creates a line based on the start and end points.

Parameters:

Name Type Description

parameters

Object

The parameters for the line.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the line is constructed.
`start`	Vector			The start point of the line.
`end`	Vector			The end point of the line.

Source: primitives-1d/line.js, line 15

Returns:

An Edge object representing the constructed line.

Type:: Edge

Polyline(parameters) → {Wire}

Creates a polyline that connects all points into a single object.

Parameters:

Name Type Description

parameters

Object

The parameters for the polyline.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the polyline is constructed.
`points`	Array.<Vector>			The points connected by the polyline.

Source: primitives-1d/polyline.js, line 14

Returns:

An Wire object representing the constructed Polyline.

Type:: Wire

TangentArc(parameters) → {Edge}

Creates an arc between the start and end points with a specified tangent vector at the start point.

Parameters:

Name Type Description

parameters

Object

The parameters for the arc.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the arc is constructed.
`start`	Vector			The start point of the arc.
`tangent`	Vector			The tangent vector at the start point.
`end`	Vector			The end point of the arc.

Source: primitives-1d/tangent-arc.js, line 16

Returns:

An Edge object representing the constructed arc.

Type:: Edge

ThreePointsArc(parameters) → {Edge}

Creates an arc between the start and end points that goes through the through point.

Parameters:

Name Type Description

parameters

Object

The parameters for the arc.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the arc is constructed.
`start`	Vector			The start point of the arc.
`through`	Vector			The point through which the arc must pass.
`end`	Vector			The end point of the arc.

Source: primitives-1d/three-points-arc.js, line 16

Returns:

An Edge object representing the constructed arc.

Type:: Edge