Class: Face

Defined in: shapes.ts:826

Extends

• Shape<TopoDS_Face>

Constructors

Constructor

new Face(ocShape): Face;

Defined in: shapes.ts:229

Parameters

ocShape

TopoDS_Face

Returns

Face

Inherited from

Shape.constructor

Other

boundingBox

Get Signature

get boundingBox(): BoundingBox;

Defined in: shapes.ts:416

Returns

BoundingBox

Inherited from

Shape.boundingBox

---

center

Get Signature

get center(): Vector;

Defined in: shapes.ts:919

Returns

Vector

---

edges

Get Signature

get edges(): Edge[];

Defined in: shapes.ts:404

Returns

Edge[]

Inherited from

Shape.edges

---

faces

Get Signature

get faces(): Face[];

Defined in: shapes.ts:408

Returns

Face[]

Inherited from

Shape.faces

---

geomType

Get Signature

get geomType(): SurfaceType;

Defined in: shapes.ts:846

Returns

SurfaceType

---

hashCode

Get Signature

get hashCode(): number;

Defined in: shapes.ts:242

Returns

number

Inherited from

Shape.hashCode

---

isNull

Get Signature

get isNull(): boolean;

Defined in: shapes.ts:246

Returns

boolean

Inherited from

Shape.isNull

---

orientation

Get Signature

get orientation(): "forward" | "backward";

Defined in: shapes.ts:835

Returns

"forward" | "backward"

---

surface

Get Signature

get surface(): Surface;

Defined in: shapes.ts:831

Returns

Surface

---

UVBounds

Get Signature

get UVBounds(): object;

Defined in: shapes.ts:853

Returns

object

uMax

uMax: number;

uMin

uMin: number;

vMax

vMax: number;

vMin

vMin: number;

---

wires

Get Signature

get wires(): Wire[];

Defined in: shapes.ts:412

Returns

Wire[]

Inherited from

Shape.wires

---

wrapped

Get Signature

get wrapped(): Type;

Defined in: register.ts:41

Returns

Type

Set Signature

set wrapped(newWrapped): void;

Defined in: register.ts:46

Parameters

newWrapped

Type

Returns

void

Inherited from

Shape.wrapped

---

asShape3D()

asShape3D(): Shape3D;

Defined in: shapes.ts:265

Asserts that this shape is a 3D shape (Shell, Solid, CompSolid, or Compound) and returns it typed as Shape3D. Throws if the shape is not 3D.

Useful for chaining after operations that return a generic shape type.

Returns

Shape3D

Inherited from

Shape.asShape3D

---

clone()

clone(): this;

Defined in: shapes.ts:233

Returns

this

Inherited from

Shape.clone

---

delete()

delete(): void;

Defined in: register.ts:58

Returns

void

Inherited from

Shape.delete

---

flipOrientation()

flipOrientation(): Face;

Defined in: shapes.ts:841

Returns

Face

---

innerWires()

innerWires(): Wire[];

Defined in: shapes.ts:934

Returns

Wire[]

---

isEqual()

isEqual(other): boolean;

Defined in: shapes.ts:254

Parameters

other

AnyShape

Returns

boolean

Inherited from

Shape.isEqual

---

isSame()

isSame(other): boolean;

Defined in: shapes.ts:250

Parameters

other

AnyShape

Returns

boolean

Inherited from

Shape.isSame

---

normalAt()

normalAt(locationVector?): Vector;

Defined in: shapes.ts:895

Parameters

locationVector?

Point

Returns

Vector

---

outerWire()

outerWire(): Wire;

Defined in: shapes.ts:928

Returns

Wire

---

pointOnSurface()

pointOnSurface(u, v): Vector;

Defined in: shapes.ts:863

Parameters

u

number

v

number

Returns

Vector

---

serialize()

serialize(): string;

Defined in: shapes.ts:237

Returns

string

Inherited from

Shape.serialize

---

simplify()

simplify(): this;

Defined in: shapes.ts:275

Simplifies the shape by removing unnecessary edges and faces

Returns

this

Inherited from

Shape.simplify

---

triangulation()

triangulation(index0?): FaceTriangulation | null;

Defined in: shapes.ts:945

Parameters

index0?

number = 0

Returns

FaceTriangulation | null

---

uvCoordinates()

uvCoordinates(point): [number, number];

Defined in: shapes.ts:879

Parameters

point

Point

Returns

[number, number]

Shape Export

blobSTEP()

blobSTEP(): Blob;

Defined in: shapes.ts:547

Exports the current shape as a STEP file as a Blob

Returns

Blob

Inherited from

Shape.blobSTEP

---

blobSTL()

blobSTL(__namedParameters?): Blob;

Defined in: shapes.ts:588

Exports the current shape as a STL file as a Blob

In order to create a STL file, the shape needs to be meshed. The tolerances correspond to the values used to mesh the shape.

Parameters

__namedParameters?

angularTolerance?

number = 0.1

binary?

boolean = false

tolerance?

number = 1e-3

Returns

Blob

Inherited from

Shape.blobSTL

---

mesh()

mesh(__namedParameters?): ShapeMesh;

Defined in: shapes.ts:437

Exports the current shape as a set of triangle. These can be used by threejs for instance to represent the the shape

Parameters

__namedParameters?

angularTolerance?

number = 0.1

tolerance?

number = 1e-3

Returns

ShapeMesh

Inherited from

Shape.mesh

---

meshEdges()

meshEdges(__namedParameters?): object;

Defined in: shapes.ts:501

Exports the current shape as a set of lines. These can be used by threejs for instance to represent the edges of the shape

Parameters

__namedParameters?

angularTolerance?

number = 0.1

tolerance?

number = 1e-3

Returns

object

edgeGroups

edgeGroups: object[];

lines

lines: number[];

Inherited from

Shape.meshEdges

Shape Transformations

mirror()

mirror(inputPlane?, origin?): this;

Defined in: shapes.ts:367

Mirrors the shape through a plane

Parameters

inputPlane?

| Point | Plane | PlaneName

origin?

Point

Returns

this

Inherited from

Shape.mirror

---

rotate()

rotate(
   angle, 
   position?, 
   direction?): this;

Defined in: shapes.ts:348

Rotates the shape

Parameters

angle

number

position?

Point = ...

direction?

Point = ...

Returns

this

Inherited from

Shape.rotate

---

scale()

scale(scale, center?): this;

Defined in: shapes.ts:383

Returns a scaled version of the shape

Parameters

scale

number

center?

Point = ...

Returns

this

Inherited from

Shape.scale

---

translate()

Call Signature

translate(
   xDist, 
   yDist, 
   zDist): this;

Defined in: shapes.ts:299

Translates the shape of an arbitrary vector

Parameters

xDist

number

yDist

number

zDist

number

Returns

this

Inherited from

Shape.translate

Call Signature

translate(vector): this;

Defined in: shapes.ts:300

Translates the shape of an arbitrary vector

Parameters

vector

Point

Returns

this

Inherited from

Shape.translate

---

translateX()

translateX(distance): this;

Defined in: shapes.ts:321

Translates the shape on the X axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateX

---

translateY()

translateY(distance): this;

Defined in: shapes.ts:330

Translates the shape on the Y axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateY

---

translateZ()

translateZ(distance): this;

Defined in: shapes.ts:339

Translates the shape on the Z axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateZ