M3D / M3D / ShapeSet

Class: ShapeSet

M3D.ShapeSet

Memberof

M3D

Implements

Utility.Subscriber

Implements

Utility.Publisher

Description

Shape对象管理类

Date

2022-1-17

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• M3DObject

  ↳ ShapeSet

Implements

• Subscriber
• Publisher

Table of contents

Constructors

• constructor

Properties

• id
• count

Methods

• addShape
• addShapes
• clearShapes
• getBodyByObjectId
• getEvents
• getId
• getModelByPath
• getModelByProtoId
• getModelBySVLPath
• getMultiInstance
• getNonInstance
• getPMIByPMIId
• getProtoMap
• getScene
• getShape
• getShapeByObjectId
• getShapeByPlcPath
• getShapes
• load
• post
• registerEvent
• removeEvent
• removeShape
• removeShapes
• send
• setAllShapesVisible
• setId
• setScene
• unload
• update
• updateShape

Constructors

constructor

• new ShapeSet(scene): ShapeSet

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

ShapeSet

Description

构造函数

Overrides

M3DObject.constructor

Properties

id

• id: number

Inherited from

M3DObject.id

---

count

▪ Static count: number

Inherited from

M3DObject.count

Methods

addShape

▸ addShape(v, immediately?): boolean

Parameters

Name	Type	Description
v	Shape	Shape对象
immediately?	boolean	是否需要立即添加

Returns

boolean

Description

添加可视化对象

---

addShapes

▸ addShapes(shapes, immediately?): boolean

Parameters

Name	Type	Description
shapes	Shape[]	shape对象
immediately?	boolean	是否需要立即添加

Returns

boolean

Description

添加多个shape

---

clearShapes

▸ clearShapes(): any

Returns

any

Description

清空可视化对象

▸ clearShapes(shapeType): boolean

Parameters

Name	Type
shapeType	ShapeType

Returns

boolean

Description

清空某类可视化对象

---

getBodyByObjectId

▸ getBodyByObjectId(bodyId): any

Parameters

Name	Type
bodyId	any

Returns

any

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

M3DObject.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

M3DObject.getId

---

getModelByPath

▸ getModelByPath(path): Model

Parameters

Name	Type	Description
path	string	装配路径

Returns

Model

Description

根据装配路径获取Model

---

getModelByProtoId

▸ getModelByProtoId(protoId): Model[]

Parameters

Name	Type
protoId	number

Returns

Model[]

Description

根据protoId获取model

---

getModelBySVLPath

▸ getModelBySVLPath(svlPath): Model

Parameters

Name	Type
svlPath	string

Returns

Model

Description

根据svlpath获取model

---

getMultiInstance

▸ getMultiInstance(): Map<Model, Model[]>

Returns

Map<Model, Model[]>

Description

获取存在多个实例的原型数据

---

getNonInstance

▸ getNonInstance(): Model[]

Returns

Model[]

Description

获取非多实例数组

---

getPMIByPMIId

▸ getPMIByPMIId(PMIId): PMI

Parameters

Name	Type
PMIId	number

Returns

PMI

Description

通过PMIId获取pmi

---

getProtoMap

▸ getProtoMap(): Map<Model, Model[]>

Returns

Map<Model, Model[]>

Description

获取原型与实例的关系映射表

---

getScene

▸ getScene(): Scene

Returns

Scene

Description

获取场景对象

---

getShape

▸ getShape(id): any

Parameters

Name	Type	Description
id	number	Shape对象id

Returns

any

Description

获取Shape对象

▸ getShape(id, shapeType): any

Parameters

Name	Type	Description
id	number	Shape对象id
shapeType	ShapeType	Shape对象类型

Returns

any

Description

获取Shape对象

---

getShapeByObjectId

▸ getShapeByObjectId(objectId, type?): Shape

Parameters

Name	Type
objectId	number
type?	ShapeType

Returns

Shape

Description

通过ObjectId获取shape

---

getShapeByPlcPath

▸ getShapeByPlcPath(plcPath): Shape

Parameters

Name	Type
plcPath	string

Returns

Shape

Description

根据plcPath获取Shape

---

getShapes

▸ getShapes(): Map<ShapeType, Map<number, Shape>>

Returns

Map<ShapeType, Map<number, Shape>>

Description

获取所有可视化对象

▸ getShapes(ids): Shape[]

Parameters

Name	Type
ids	number[]

Returns

Shape[]

Description

获取可视化对象

▸ getShapes(shapeType): Shape[]

Parameters

Name	Type
shapeType	ShapeType

Returns

Shape[]

Description

获取一个类型的所有可视化对象

---

load

▸ load(shape): void

Parameters

Name	Type	Description
shape	Shape	Shape对象

Returns

void

Description

加载某Shape对象

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Implementation of

Publisher.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

M3DObject.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

M3DObject.removeEvent

---

removeShape

▸ removeShape(id, immediately?): boolean

Parameters

Name	Type	Description
id	number	可视化对象id
immediately?	boolean	是否立即删除

Returns

boolean

Description

删除可视化对象

---

removeShapes

▸ removeShapes(ids, immediately?): boolean

Parameters

Name	Type
ids	number[]
immediately?	boolean

Returns

boolean

Description

删除某类型的可视化对象

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Implementation of

Publisher.send

---

setAllShapesVisible

▸ setAllShapesVisible(shapeType, visible): void

Parameters

Name	Type
shapeType	ShapeType
visible	boolean

Returns

void

Description

根据type设置shape的显隐;

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

M3DObject.setId

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

---

unload

▸ unload(shape): void

Parameters

Name	Type	Description
shape	Shape	Shape对象

Returns

void

Description

卸载某Shape对象

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Implementation of

Subscriber.update

---

updateShape

▸ updateShape(shape, immediately?): boolean

Parameters

Name	Type
shape	Shape
immediately?	boolean

Returns

boolean

Description

Shape对象更新