Face

Describes a part of a surface limited by wires. Face resides on a geometrical surface and is bounded by one or several wires. A face must always have at least one explicit outer wire even if it corresponds to a naturally bounded surface (e.g. torus or a sphere).

Extends

• Shape

Constructors

new Face()

‍new Face(surface, outerWire): Face

Parameters

surface

Surface

Surface of the face.

outerWire

Wire

Outer boundary of the surface.

Returns

Face

Overrides

Shape.constructor

Properties

triangulation

‍triangulation: null | FaceTriangulation = null

Polygonal representation of face.

Accessors

id

Get Signature

‍get id(): bigint

Returns object id.

Returns

bigint

Inherited from

Shape.id

---

name

Get Signature

‍get name(): null | string

Returns name of the Shape. null if the element has no name (by default).

Returns

null | string

Set Signature

‍set name(name): void

Sets name of the Shape.

Parameters

name

Name of the Shape.

null | string

Returns

void

Inherited from

Shape.name

---

outerWire

Get Signature

‍get outerWire(): Wire

Returns outer wire.

Returns

Wire

---

surface

Get Signature

‍get surface(): Surface

Returns underlying surface.

Returns

Surface

---

type

Get Signature

‍get type(): ShapeType

Type of the topological object.

Returns

ShapeType

Inherited from

Shape.type

Methods

append()

‍append(wire): boolean

Appends new wire to the face.

Returns true if wire was added, false otherwise (i.e. if wire already presented in this face).

Parameters

wire

Wire

Appended wire.

Returns

boolean