Hide menu
Loading...
Searching...
No Matches
Face

Defines a face.

A face is a topological part of a surface bounded by one or more wires. A face should have an explicit outer wire even if it corresponds to a naturally bounded surface such as a torus or a sphere.

Extends

Constructors

Constructor

new Face(surface, outerWire?): Face

Creates a face on the given surface with an optional outer wire.

Parameters

surface

Surface

Surface of the face.

outerWire?

Wire

Optional outer boundary wire of the face.

Returns

Face

Overrides

Shape.constructor

Properties

triangulation

triangulation: FaceTriangulation | null = null

Polygonal representation of the face.

The default value is null.

Accessors

id

Get Signature

get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

Shape.id


name

Get Signature

get name(): string | null

Name of the shape.

The default value is null.

Returns

string | null

Set Signature

set name(name): void

Sets the name of the shape.

Parameters

name

string | null

Shape name.

Returns

void

Inherited from

Shape.name


outerWire

Get Signature

get outerWire(): Wire

Outer wire of the face.

Returns an empty wire if the face has no wires.

Returns

Wire


surface

Get Signature

get surface(): Surface

Underlying surface of the face.

Returns

Surface


type

Get Signature

get type(): ShapeType

Type of the shape.

Returns

ShapeType

Inherited from

Shape.type

Methods

append()

Call Signature

append(wire): boolean

Appends a wire to the face.

Returns true if wire was added, or false if it is already present in the face.

Parameters

wire

Wire

Wire to append.

Returns

boolean

Call Signature

append(wires): boolean

Appends wires to the face.

Returns true if all provided wires were added, or false if one or more wires are already present in the face. Already present wires are skipped.

Parameters

wires

Wire[]

Wires to append.

Returns

boolean