Skip to main content

Face

Hierarchy

  • Shape<TopoDS_Face>

    Face

Constructors

constructor

new Face(ocShape)

Parameters

NameType
ocShapeTopoDS_Face

Inherited from

Shape.constructor

Defined in

shapes.ts:151

Accessors

UVBounds

get UVBounds(): Object

Returns

Object

NameType
uMaxnumber
uMinnumber
vMaxnumber
vMinnumber

Defined in

shapes.ts:784


boundingBox

get boundingBox(): BoundingBox

Returns

BoundingBox

Inherited from

Shape.boundingBox

Defined in

shapes.ts:309


center

get center(): Vector

Returns

Vector

Defined in

shapes.ts:857


edges

get edges(): Edge[]

Returns

Edge[]

Inherited from

Shape.edges

Defined in

shapes.ts:297


faces

get faces(): Face[]

Returns

Face[]

Inherited from

Shape.faces

Defined in

shapes.ts:301


geomType

get geomType(): SurfaceType

Returns

SurfaceType

Defined in

shapes.ts:777


hashCode

get hashCode(): number

Returns

number

Inherited from

Shape.hashCode

Defined in

shapes.ts:159


isNull

get isNull(): boolean

Returns

boolean

Inherited from

Shape.isNull

Defined in

shapes.ts:163


orientation

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

Returns

"forward" | "backward"

Defined in

shapes.ts:771


surface

get surface(): Surface

Returns

Surface

Defined in

shapes.ts:767


wires

get wires(): Wire[]

Returns

Wire[]

Inherited from

Shape.wires

Defined in

shapes.ts:305


wrapped

get wrapped(): Type

Returns

Type

Inherited from

Shape.wrapped

Defined in

register.ts:39

set wrapped(newWrapped): void

Parameters

NameType
newWrappedType

Returns

void

Inherited from

Shape.wrapped

Defined in

register.ts:44

Other Methods

clone

clone(): Face

Returns

Face

Inherited from

Shape.clone

Defined in

shapes.ts:155


delete

delete(): void

Returns

void

Inherited from

Shape.delete

Defined in

register.ts:54


innerWires

innerWires(): Wire[]

Returns

Wire[]

Defined in

shapes.ts:872


isEqual

isEqual(other): boolean

Parameters

NameType
otherAnyShape

Returns

boolean

Inherited from

Shape.isEqual

Defined in

shapes.ts:171


isSame

isSame(other): boolean

Parameters

NameType
otherAnyShape

Returns

boolean

Inherited from

Shape.isSame

Defined in

shapes.ts:167


normalAt

normalAt(locationVector?): Vector

Parameters

NameType
locationVector?Point

Returns

Vector

Defined in

shapes.ts:817


outerWire

outerWire(): Wire

Returns

Wire

Defined in

shapes.ts:866


pointOnSurface

pointOnSurface(u, v): Vector

Parameters

NameType
unumber
vnumber

Returns

Vector

Defined in

shapes.ts:801


simplify

simplify(): Face

Simplifies the shape by removing unnecessary edges and faces

Returns

Face

Inherited from

Shape.simplify

Defined in

shapes.ts:178


triangulation

triangulation(index0?): null | FaceTriangulation

Parameters

NameTypeDefault value
index0number0

Returns

null | FaceTriangulation

Defined in

shapes.ts:883


Shape Export Methods

blobSTEP

blobSTEP(): Blob

Exports the current shape as a STEP file as a Blob

Returns

Blob

Inherited from

Shape.blobSTEP

Defined in

shapes.ts:485


blobSTL

blobSTL(«destructured»?): Blob

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

NameType
«destructured»Object
› angularToleranceundefined | number
› binaryundefined | boolean
› toleranceundefined | number

Returns

Blob

Inherited from

Shape.blobSTL

Defined in

shapes.ts:527


mesh

mesh(«destructured»?): ShapeMesh

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

Parameters

NameType
«destructured»Object
› angularToleranceundefined | number
› toleranceundefined | number

Returns

ShapeMesh

Inherited from

Shape.mesh

Defined in

shapes.ts:331


meshEdges

meshEdges(«destructured»?): Object

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

NameType
«destructured»Object
› angularToleranceundefined | number
› toleranceundefined | number

Returns

Object

NameType
edgeGroups{ count: number ; edgeId: number ; start: number }[]
linesnumber[]

Inherited from

Shape.meshEdges

Defined in

shapes.ts:368


Shape Transformations Methods

mirror

mirror(inputPlane, origin): Face

Mirrors the shape through a plane

Parameters

NameType
inputPlanePoint | Plane | PlaneName
originPoint

Returns

Face

Inherited from

Shape.mirror

Defined in

shapes.ts:264


rotate

rotate(angle, position?, direction?): Face

Rotates the shape

Parameters

NameType
anglenumber
positionPoint
directionPoint

Returns

Face

Inherited from

Shape.rotate

Defined in

shapes.ts:247


scale

scale(scale, center?): Face

Returns a scaled version of the shape

Parameters

NameType
scalenumber
centerPoint

Returns

Face

Inherited from

Shape.scale

Defined in

shapes.ts:278


translate

translate(xDist, yDist, zDist): Face

Translates the shape of an arbitrary vector

Parameters

NameType
xDistnumber
yDistnumber
zDistnumber

Returns

Face

Inherited from

Shape.translate

Defined in

shapes.ts:200

translate(vector): Face

Parameters

NameType
vectorPoint

Returns

Face

Inherited from

Shape.translate

Defined in

shapes.ts:201


translateX

translateX(distance): Face

Translates the shape on the X axis

Parameters

NameType
distancenumber

Returns

Face

Inherited from

Shape.translateX

Defined in

shapes.ts:220


translateY

translateY(distance): Face

Translates the shape on the Y axis

Parameters

NameType
distancenumber

Returns

Face

Inherited from

Shape.translateY

Defined in

shapes.ts:229


translateZ

translateZ(distance): Face

Translates the shape on the Z axis

Parameters

NameType
distancenumber

Returns

Face

Inherited from

Shape.translateZ

Defined in

shapes.ts:238