KShell
kds-plugin-document / Exports / KShell
Interface: KShell
壳体
壳体是一组面的集合。它代表一个 Brep 数据结构的壳体（Shell）
酷大师会尽最大可能将相互连接的面放置在一个壳体中。 但这并不永远成立，有可能一个壳体会包含一些互不相连的面。插件开发者最好不要依赖于这一假设来写业务逻辑
The KShell class represents the BRep shell.
Hierarchy
↳
KShell
Table of contents
Methods
- getAllCustomProperties
- getCustomProperty
- getEdges
- getFaces
- getType
- getVertices
- getWires
- isVisible
- setCustomProperty
Methods
getAllCustomProperties
▸ getAllCustomProperties(): Object
获取所有业务自定义属性
Retrieves all custom property key-value pairs set on this shell.
Returns
Object
一个包含所有自定义属性的对象，键为属性名，值为属性值。
Defined in
api.d.ts:5058
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:5066
getEdges
▸ getEdges(): KEdge[]
获取所包含的边
Retrieve all the involved Edges of this Shell.
Returns
KEdge[]
The array of Edges.
Overrides
Defined in
api.d.ts:5017
getFaces
▸ getFaces(): KFace[]
获取所包含的面
Retrieve all the involved Faces of this Shell.
Returns
KFace[]
The array of Faces.
Overrides
Defined in
api.d.ts:5008
getType
▸ getType(): KTopoType
获取酷大师图形实体类型
Get the entity's type.
Returns
The entity's type.
Overrides
Defined in
api.d.ts:4999
getVertices
▸ getVertices(): KVertex[]
获取所包含的顶点
Returns
KVertex[]
The array of Vertices.
Defined in
api.d.ts:5025
getWires
▸ getWires(): KWire[]
获取所包含的线集合
Returns
KWire[]
The array of Wires.
Overrides
Defined in
api.d.ts:5041
isVisible
▸ isVisible(): boolean
获取所包含的面和边是否全部可见
Get whether all the faces and edges contained within shell are visible.
Returns
boolean
Defined in
api.d.ts:5033
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:5050