Skip to main content

KTopoFace

kds-plugin-document / Exports / KTopoFace

Interface: KTopoFace

The KTopoFace class represents a BRep face. You may think a face is a patch of a surface with boundary edges.

Hierarchy​

Table of contents​

Methods​

Methods​

area​

▸ area(): number

Retrieve the area of a face.

Returns​

number

The area of a face in square millimeters.

Defined in​

api.d.ts:155

getEdges​

▸ getEdges(): KTopoEdge[]

Retrieve all the involved edges of this face.

Returns​

KTopoEdge[]

The array of edges.

Defined in​

api.d.ts:124

getHalfEdges​

▸ getHalfEdges(): KTopoHalfEdge[]

Retrieve all the involved half edges of this face.

Returns​

KTopoHalfEdge[]

The array of half edges.

Defined in​

api.d.ts:134

getInnerLoops​

▸ getInnerLoops(): KTopoLoop[]

Retrieve face's inner loops.

Returns​

KTopoLoop[]

The inner loops.

Defined in​

api.d.ts:144

getKey​

▸ getKey(): string

Get a unique key assigned to a face.

Returns​

string

The unique key.

Defined in​

api.d.ts:114

getOuterLoop​

▸ getOuterLoop(): KTopoLoop

Retrieve face's outer loop.

Returns​

KTopoLoop

The outer loop if successful, otherwise null.

Defined in​

api.d.ts:139

getShell​

▸ getShell(): KTopoShell

Get the shell that the face belongs to.

Returns​

KTopoShell

The shell if successful, otherwise null.

Defined in​

api.d.ts:119

getSurface​

▸ getSurface(): KSurface

Retrieve the surface that the face is on. NOTE: Now it is always the plane.

Returns​

KSurface

The surface if successful, otherwise null.

Defined in​

api.d.ts:150

getType​

▸ getType(): KTopoType

Get the entity's type.

Returns​

KTopoType

The entity's type.

Inherited from​

KTopoEntity.getType

Defined in​

api.d.ts:102

getVertices​

▸ getVertices(): KTopoVertex[]

Retrieve all the involved vertices of this face.

Returns​

KTopoVertex[]

The array of vertices.

Defined in​

api.d.ts:129

isReversed​

▸ isReversed(): boolean

Check whether the face is reversed to its underlying surface.

Returns​

boolean

true if reversed, false if the orientations are same.

Defined in​

api.d.ts:160