API / SView / ShapeSet

Class: ShapeSet

SView.ShapeSet

Memberof

SView

Description

选择集相关类

Export

Author

YW

Implements

Implements

Hierarchy

• Array<M3D.Shapes.Shape>

  ↳ ShapeSet

Implements

• Subscriber
• Publisher

Table of contents

Constructors

• constructor

Methods

• addShape
• addShapes
• getId
• getName
• removeShape
• removeShapes
• setName

Constructors

constructor

• new ShapeSet(name, id?): ShapeSet

Creates an instance of ShapeSet.

Parameters

Name	Type	Description
name	string	选择集名称
id?	number	选择集ID 可选参数 默认在当前已有选择集的最大值基础上自增1

Returns

ShapeSet

Overrides

Array&lt;M3D.Shapes.Shape&gt;.constructor

Methods

addShape

▸ addShape(shape): void

Parameters

Name	Type	Description
shape	Shape	shape对象

Returns

void

Description

添加Shape对象

---

addShapes

▸ addShapes(shapes): void

Parameters

Name	Type	Description
shapes	Shape[]	shape对象的数组

Returns

void

Description

添加多个shape

---

getId

▸ getId(): number

Returns

number

Description

获取选择集的ID

---

getName

▸ getName(): string

Returns

string

Description

获取选择集名称

---

removeShape

▸ removeShape(shape): void

Parameters

Name	Type	Description
shape	Shape	shape对象

Returns

void

Description

删除shape

---

removeShapes

▸ removeShapes(shapes): void

Parameters

Name	Type	Description
shapes	Shape[]	shape对象的数组

Returns

void

Description

删除多个shape

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置选择集名称