KFace

kds-plugin-document / Exports / KFace

Interface: KFace

酷大师图形实体：造型面 它对应于一个Brep数据结构的面 (Face)

The KFace class represents the BRep face.

Hierarchy

• KEntity

• KTopoFace

  ↳ KFace

Table of contents

Methods

• area
• deleteCustomProperty
• getContinuousFaceGroup
• getCustomProperty
• getEdges
• getHalfEdges
• getInnerLoops
• getKey
• getOuterLoop
• getShell
• getSurface
• getType
• getVertices
• isReversed
• isVisible
• setCustomProperty

Methods

area

▸ area(): number

Retrieve the area of a face.

Returns

number

The area of a face in square millimeters.

Inherited from

KTopoFace.area

Defined in

api.d.ts:155

---

deleteCustomProperty

▸ deleteCustomProperty(key): Object

删除业务数据

Delete custom property data.

Parameters

Name	Type	Description
key	string	: unique key for this kind of custom.

Returns

Object

Name	Type
isSuccess	boolean

Defined in

api.d.ts:2806

---

getContinuousFaceGroup

▸ getContinuousFaceGroup(): KContinuousFaceGroup

Deprecated

该接口即将下线

Retrieve the continuous face which the face belongs to.

Returns

KContinuousFaceGroup

The continuous face if successful, otherwise null.

Defined in

api.d.ts:2781

---

getCustomProperty

▸ getCustomProperty(key): string

获取业务数据

Get custom property data.

Parameters

Name	Type	Description
key	string	: unique key for this kind of custom.

Returns

string

Defined in

api.d.ts:2798

---

getEdges

▸ getEdges(): KEdge[]

获取所有包含的边

Retrieve all the involved edges of this face.

Returns

KEdge[]

The array of edges.

Overrides

KTopoFace.getEdges

Defined in

api.d.ts:2737

---

getHalfEdges

▸ getHalfEdges(): KHalfEdge[]

获取所有包含的半边

Retrieve all the involved half edges of this face.

Returns

KHalfEdge[]

The array of half edges.

Overrides

KTopoFace.getHalfEdges

Defined in

api.d.ts:2755

---

getInnerLoops

▸ getInnerLoops(): KLoop[]

获取所含的内环

Retrieve face's inner loops.

Returns

KLoop[]

The inner loops.

Overrides

KTopoFace.getInnerLoops

Defined in

api.d.ts:2773

---

getKey

▸ getKey(): string

Get a unique key assigned to a face.

Returns

string

The unique key.

Inherited from

KTopoFace.getKey

Defined in

api.d.ts:114

---

getOuterLoop

▸ getOuterLoop(): KLoop

获取所含的外环

Retrieve face's outer loop.

Returns

KLoop

The outer loop if successful, otherwise null.

Overrides

KTopoFace.getOuterLoop

Defined in

api.d.ts:2764

---

getShell

▸ getShell(): KShell

获取所从属的壳体

Get the shell that the face belongs to.

Returns

KShell

The shell if successful, otherwise null.

Overrides

KTopoFace.getShell

Defined in

api.d.ts:2728

---

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.

Inherited from

KTopoFace.getSurface

Defined in

api.d.ts:150

---

getType

▸ getType(): KTopoType

获取图形实体类型

Get the entity's type.

Returns

KTopoType

The entity's type.

Overrides

KTopoFace.getType

Defined in

api.d.ts:2719

---

getVertices

▸ getVertices(): KVertex[]

获取所有包含的顶点

Retrieve all the involved vertices of this face.

Returns

KVertex[]

The array of vertices.

Overrides

KTopoFace.getVertices

Defined in

api.d.ts:2746

---

isReversed

▸ isReversed(): boolean

Check whether the face is reversed to its underlying surface.

Returns

boolean

true if reversed, false if the orientations are same.

Inherited from

KTopoFace.isReversed

Defined in

api.d.ts:160

---

isVisible

▸ isVisible(): boolean

获取该面是否可见

Get the face property of it is visible or not.

Returns

boolean

Defined in

api.d.ts:2814

---

setCustomProperty

▸ setCustomProperty(key, value): Object

添加业务数据

Set custom property data.

Parameters

Name	Type	Description
key	string	: key of custom
value	string	: support string type

Returns

Object

Name	Type
isSuccess	boolean

Defined in

api.d.ts:2790