Class: Solid

Source: modeling/solid.js, line 16

Members

centerOfMass

Computes the center of mass of the solid.

Source: modeling/solid.js, line 63

edges

Retrieves all edges of the solid.

Source: modeling/solid.js, line 47

faces

Retrieves all faces of the solid.

Source: modeling/solid.js, line 39

vertices

Retrieves all vertices of the solid.

Source: modeling/solid.js, line 55

volume

Computes the volume of the solid.

Source: modeling/solid.js, line 76

Methods

chamfer(parameters) → {Solid}

Applies a chamfer (beveled edge) to selected edges of the solid.

Parameters:

Name Type Description

parameters

Object

Chamfer parameters.

Properties

Name	Type	Description
`selector`	function	A function to select edges for the chamfer.
`distance`	number	The distance of the chamfer.

Source: modeling/solid.js, line 191

Returns:

A new Solid object with the chamfer applied.

Type:: Solid

cut(…tools) → {Array.<Solid>}

Cuts the solid using one or more tools (other solids).

Parameters:

Name	Type	Attributes	Description
`tools`	Solid	<repeatable>	One or more `Solid` objects to use as cutting tools.

Source: modeling/solid.js, line 135

Returns:

An array of Solid objects representing the result.

Type:: Array.<Solid>

fillet(parameters) → {Solid}

Applies a fillet (rounded edge) to selected edges of the solid.

Parameters:

Name Type Description

parameters

Object

Fillet parameters.

Properties

Name	Type	Description
`selector`	function	A function to select edges for the fillet.
`radius`	number	The radius of the fillet.

Source: modeling/solid.js, line 176

Returns:

A new Solid object with the fillet applied.

Type:: Solid

intersect(…tools) → {Array.<Solid>}

Intersects the solid with one or more tools (other solids).

Parameters:

Name	Type	Attributes	Description
`tools`	Solid	<repeatable>	One or more `Solid` objects to intersect with.

Source: modeling/solid.js, line 148

Returns:

An array of Solid objects representing the result.

Type:: Array.<Solid>

join(…tools) → {Array.<Solid>}

Joins the solid with one or more tools (other solids).

Parameters:

Name	Type	Attributes	Description
`tools`	Solid	<repeatable>	One or more `Solid` objects to join with.

Source: modeling/solid.js, line 161

Returns:

An array of Solid objects representing the result.

Type:: Array.<Solid>

mirror(plane) → {Solid}

Mirrors the solid across a specified plane.

Parameters:

Name	Type	Description
`plane`	Plane	The plane to mirror across.

Source: modeling/solid.js, line 105

Returns:

A new Solid object representing the mirrored solid.

Type:: Solid

rotate(parameters) → {Solid}

Rotates the solid around a specified axis by a given angle.

Parameters:

Name Type Description

parameters

Object

Rotation parameters.

Properties

Name	Type	Description
`axis`	Axis	The axis to rotate around.
`angle`	number	The rotation angle in radians.

Source: modeling/solid.js, line 96

Returns:

A new Solid object representing the rotated solid.

Type:: Solid

scale(factor) → {Solid}

Scales the solid by a specified factor.

Parameters:

Name	Type	Description
`factor`	number	The scaling factor.

Source: modeling/solid.js, line 114

Returns:

A new Solid object representing the scaled solid.

Type:: Solid

shell(parameters) → {Solid}

Creates a hollow version of the solid by offsetting its faces by a specified thickness.

Parameters:

Name Type Description

parameters

Object

Shell parameters.

Properties

Name	Type	Attributes	Default	Description
`selector`	function			A function to select faces for the shell.
`thickness`	number			The thickness of the shell. Positive value shells outwards, negative value shells inwards.
`joinType`	'arc' \| 'tangent' \| 'intersection'	<optional>	"intersection"	The join type for the shell.

Source: modeling/solid.js, line 207

Returns:

A new Solid object representing the shelled solid.

Type:: Solid

split(tool) → {Array.<Solid>}

Splits the solid into multiple parts using a specified tool.

Parameters:

Name	Type	Description
`tool`	Plane	The tool used to split the solid.

Source: modeling/solid.js, line 123

Returns:

An array of Solid objects representing the split parts.

Type:: Array.<Solid>

translate(offset) → {Solid}

Translates the solid by a specified offset.

Parameters:

Name	Type	Description
`offset`	Vector	The translation offset.

Source: modeling/solid.js, line 85

Returns:

A new Solid object representing the translated solid.

Type:: Solid

(static) fromFaces(…faces) → {Solid}

Creates a new solid from a set of faces.

Parameters:

Name	Type	Attributes	Description
`faces`	Face	<repeatable>	One or more `Face` objects to create the solid from.

Source: modeling/solid.js, line 249

Returns:

A new Solid object representing the created solid.

Type:: Solid