Class: Wire

Source: modeling/wire.js, line 14

Members

edges

Retrieves all edges of the wire.

Source: modeling/wire.js, line 36

isClosed

Checks if the wire is closed.

Source: modeling/wire.js, line 52

vertices

Retrieves all vertices of the wire.

Source: modeling/wire.js, line 44

Methods

offset(parameters) → {Face}

Offsets the wire by a specified distance.

Parameters:

Name Type Description

parameters

Object

Offset parameters.

Properties

Name	Type	Attributes	Default	Description
`distance`	number			The offset distance.
`joinType`	'arc' \| 'tangent' \| 'intersection'	<optional>	"tangent"	The join type for the offset.

Source: modeling/wire.js, line 97

Returns:

A new Wire object representing the offset wire.

Type:: Face

sweep(parameters) → {Solid}

Sweeps the specified profile along this wire to create a 3D solid. If the wire has sharp edges use transitionMode = "right". If the wire is C1 continuous use transitionMode = "transformed".

Parameters:

Name Type Description

parameters

Object

Sweep parameters.

Properties

Name	Type	Attributes	Default	Description
`profile`	Face \| Wire			Profile to sweep along the wire.
`rail`	Wire	<optional>	null	The guiding rail for the sweep.
`transitionMode`	'transformed' \| 'right' \| 'round'	<optional>	"right"	The transition mode for the sweep.

Source: modeling/wire.js, line 66

Returns:

A new Solid object representing the swept result.

Type:: Solid

sweepMultiple(parameters) → {Solid}

Sweeps the specified profiles along this wire to create a 3D solid. If the wire has sharp edges use transitionMode = "right". If the wire is C1 continuous use transitionMode = "transformed".

Parameters:

Name Type Description

parameters

Object

Sweep parameters.

Properties

Name	Type	Attributes	Default	Description
`profiles`	Array.<Wire>			Profiles to sweep along the wire.
`rail`	Wire	<optional>	null	The guiding rail for the sweep.
`transitionMode`	'transformed' \| 'right' \| 'round'	<optional>	"right"	The transition mode for the sweep.

Source: modeling/wire.js, line 86

Returns:

A new Solid object representing the swept result.

Type:: Solid

(static) fromEdges(…edges) → {Wire}

Creates a new Wire from the provided edges.

Parameters:

Name	Type	Attributes	Description
`edges`	Edge	<repeatable>	The edges to create the wire from.

Source: modeling/wire.js, line 145

Returns:

A new Wire object created from the provided edges.

Type:: Wire

(static) loft(parameters) → {Solid}

Creates a loft between the wires or points to form a 3D solid.

Parameters:

Name Type Description

parameters

Object

Loft parameters.

Properties

Name	Type	Attributes	Description
`start`	Vector	<optional>	The starting point of the loft.
`wires`	Array.<Face>		Wires to include in the loft.
`end`	Vector	<optional>	The ending point of the loft.

Source: modeling/wire.js, line 161

Returns:

A new Solid object representing the lofted result.

Type:: Solid