Class: Face

Source: modeling/face.js, line 16

Members

centerOfMass

Computes the center of mass of the face.

Source: modeling/face.js, line 94

edges

Retrieves all edges of the face.

Source: modeling/face.js, line 40

innerWires

Retrieves all inner wires (holes) of the face.

Source: modeling/face.js, line 64

normal

Computes the normal vector of the face.

Source: modeling/face.js, line 74

orientation

Determines the orientation of the face.

Source: modeling/face.js, line 170

outerWire

Retrieves the outer wire (boundry) of the face.

Source: modeling/face.js, line 56

surfaceArea

Computes the surface area of the face.

Source: modeling/face.js, line 107

type

Determines the type of the face's surface.

Source: modeling/face.js, line 137

vertices

Retrieves all vertices of the face.

Source: modeling/face.js, line 48

xDirection

Computes the x-direction vector of the face.

Source: modeling/face.js, line 115

Methods

chamfer(parameters) → {Face}

Applies a chamfer (beveled edge) to selected vertices of the face.

Parameters:

Name Type Description

parameters

Object

Chamfer parameters.

Properties

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

Source: modeling/face.js, line 293

Returns:

A new Face object with the chamfer applied.

Type:: Face

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

Cuts the face using one or more tools (other faces).

Parameters:

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

Source: modeling/face.js, line 238

Returns:

An array of Face objects representing the result.

Type:: Array.<Face>

extrude(distance) → {Solid}

Extrudes the face by a specified distance to create a 3D solid.

Parameters:

Name	Type	Description
`distance`	number	The extrusion distance.

Source: modeling/face.js, line 308

Returns:

A new Solid object representing the extruded face.

Type:: Solid

fillet(parameters) → {Face}

Applies a fillet (rounded edge) to selected vertices of the face.

Parameters:

Name Type Description

parameters

Object

Fillet parameters.

Properties

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

Source: modeling/face.js, line 279

Returns:

A new Face object with the fillet applied.

Type:: Face

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

Intersects the face with one or more tools (other faces).

Parameters:

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

Source: modeling/face.js, line 251

Returns:

An array of Face objects representing the result.

Type:: Array.<Face>

isParallel(direction) → {boolean|undefined}

Checks if the face is parallel to the given direction. Only applicable for planar faces.

Parameters:

Name	Type	Description
`direction`	Vector	The direction vector to test.

Source: modeling/face.js, line 364

Returns:

true if the face is parallel to the direction, false otherwise, or undefined if not a planar face.

Type:: boolean | undefined

isPerpendicular(direction) → {boolean|undefined}

Checks if the face is perpendicular to the given direction. Only applicable for planar faces.

Parameters:

Name	Type	Description
`direction`	Vector	The direction vector to test.

Source: modeling/face.js, line 373

Returns:

true if the face is perpendicular to the direction, false otherwise, or undefined if not a planar face.

Type:: boolean | undefined

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

Joins the face with one or more tools (other faces).

Parameters:

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

Source: modeling/face.js, line 264

Returns:

An array of Face objects representing the result.

Type:: Array.<Face>

mirror(plane) → {Face}

Mirrors the face across a specified plane.

Parameters:

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

Source: modeling/face.js, line 208

Returns:

A new Face object representing the mirrored face.

Type:: Face

offset(parameters) → {Face}

Offsets the face's outline by a specified distance. Face holes are also offset by a specified distance.

Parameters:

Name Type Description

parameters

Object

Offset parameters.

Properties

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

Source: modeling/face.js, line 334

Returns:

A new Face object representing the offset face.

Type:: Face

reverse() → {Face}

Reverses the orientation of the face.

Source: modeling/face.js, line 355

Returns:

A new Face object with the reversed orientation.

Type:: Face

revolve(parameters) → {Solid}

Revolves the face around a specified axis by a given angle to create a 3D solid.

Parameters:

Name Type Description

parameters

Object

Revolution parameters.

Properties

Name	Type	Description
`axis`	Axis	The axis to revolve around.
`angle`	number	The revolution angle in radians.

Source: modeling/face.js, line 321

Returns:

A new Solid object representing the revolved face.

Type:: Solid

rotate(parameters) → {Face}

Rotates the face 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/face.js, line 199

Returns:

A new Face object representing the rotated face.

Type:: Face

scale(factor) → {Face}

Scales the face by a specified factor.

Parameters:

Name	Type	Description
`factor`	number	The scaling factor.

Source: modeling/face.js, line 217

Returns:

A new Face object representing the scaled face.

Type:: Face

split(plane) → {Array.<Face>}

Splits the face into multiple parts using a specified plane.

Parameters:

Name	Type	Description
`plane`	Plane	The plane to split the face with.

Source: modeling/face.js, line 226

Returns:

An array of Face objects representing the split parts.

Type:: Array.<Face>

translate(offset) → {Face}

Translates the face by a specified offset.

Parameters:

Name	Type	Description
`offset`	Vector	The translation offset.

Source: modeling/face.js, line 188

Returns:

A new Face object representing the translated face.

Type:: Face

(static) fromWire(wire) → {Face}

Creates a Face object from a wire. The wire must be closed and form a valid boundary for the face.

Parameters:

Name	Type	Description
`wire`	Wire	The wire to create the face from.

Source: modeling/face.js, line 407

Returns:

a new Face object created from the given wire.

Type:: Face