M3D / M3D / Shapes / PMI

Class: PMI

M3D.Shapes.PMI

Memberof

M3D.Shapes

Description

PMI

Author

SS

Date

2022-1-12

Version

1.0

Copyright

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

Hierarchy

• Shape

  ↳ PMI

Table of contents

Constructors

• constructor

Properties

• comTexts
• fontSize
• id
• isFixScreenflg
• isParallelScreen
• name
• outFrameMatrix
• outramLocation
• pmiType
• polyLines
• protoTypeID
• showText
• source
• PMI_FixScreen
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• fromJson
• getAlpha
• getBoundingBox
• getColor
• getComtexts
• getDrawables
• getEffect
• getEvents
• getId
• getIsFrontShow
• getLocalTransform
• getName
• getNeedClip
• getObjectId
• getOrigVisible
• getOriginId
• getOutFrameMatrix
• getPMIJson
• getParentModel
• getPmiId
• getPolylines
• getPosition
• getProperties
• getProto
• getRenderShapes
• getRenderWorldMatrix
• getRotation
• getScene
• getShapeType
• getTextHeight
• getWorldBoundingBox
• getWorldMatrix
• getWorldTransform
• isPreSelected
• isSelected
• isVisible
• markDefinePlaneDirty
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setColor
• setEffect
• setFrontShow
• setId
• setName
• setNeedClip
• setObjectId
• setOrigVisible
• setOriginId
• setPMIJson
• setParentModel
• setPosition
• setRenderWorldMatrix
• setScene
• setSelected
• setShapeType
• setVisible
• setWorldTransform
• update

Constructors

constructor

• new PMI(): PMI

Returns

PMI

Description

构造函数

Overrides

Shape.constructor

• new PMI(value): PMI

Parameters

Name	Type
value	string

Returns

PMI

Description

构造函数

Overrides

Shape.constructor

Properties

comTexts

• comTexts: ComText[]

---

fontSize

• fontSize: number

---

id

• id: number

Inherited from

Shape.id

---

isFixScreenflg

• isFixScreenflg: boolean

---

isParallelScreen

• isParallelScreen: boolean

---

name

• name: string

Overrides

Shape.name

---

outFrameMatrix

• outFrameMatrix: Matrix4

---

outramLocation

• outramLocation: Vector3

---

pmiType

• pmiType: number

---

polyLines

• polyLines: PolyLine[]

---

protoTypeID

• protoTypeID: number

---

showText

• showText: string

---

source

• source: number

---

PMI_FixScreen

▪ Static PMI_FixScreen: number

---

count

▪ Static count: number

Inherited from

Shape.count

---

isProto

▪ Static isProto: string

Inherited from

Shape.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

Shape.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

Shape.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

Shape.isProto

Methods

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

Shape.addEffect

---

fromJson

▸ fromJson(pmiJson): void

Parameters

Name	Type
pmiJson	any

Returns

void

Description

pmi Json数据解析

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

Shape.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取PMI包围盒

Overrides

Shape.getBoundingBox

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

Shape.getColor

---

getComtexts

▸ getComtexts(): RenderableShape[]

Returns

RenderableShape[]

Description

获取文本对象列表

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

Shape.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

Shape.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Shape.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Shape.getId

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

Shape.getIsFrontShow

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

Shape.getLocalTransform

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

Shape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

Shape.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

Shape.getObjectId

---

getOrigVisible

▸ getOrigVisible(): boolean

Returns

boolean

Description

获取原始可见性

---

getOriginId

▸ getOriginId(): number

Returns

number

Description

获取原始id

---

getOutFrameMatrix

▸ getOutFrameMatrix(camera): Matrix4

Parameters

Name	Type
camera	Camera

Returns

Matrix4

Description

获取外框矩阵

---

getPMIJson

▸ getPMIJson(): any

Returns

any

---

getParentModel

▸ getParentModel(): Model

Returns

Model

Description

获取父级模型

---

getPmiId

▸ getPmiId(): number

Returns

number

Description

获取PMI id

---

getPolylines

▸ getPolylines(): RenderableShape[]

Returns

RenderableShape[]

Description

获取折线列表

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

Shape.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

Shape.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

Shape.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制模型

Overrides

Shape.getRenderShapes

---

getRenderWorldMatrix

▸ getRenderWorldMatrix(): Matrix4

Returns

Matrix4

Description

获取绘制时所需的世界矩阵

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

Shape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

Shape.getScene

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

Shape.getShapeType

---

getTextHeight

▸ getTextHeight(): number

Returns

number

Description

获取文字高度

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取PMI世界包围盒

Overrides

Shape.getWorldBoundingBox

---

getWorldMatrix

▸ getWorldMatrix(mvMatrix, viewport, center, allowTran, allowRotate, allowScale): Matrix4

Parameters

Name	Type
mvMatrix	Matrix4
viewport	Viewport
center	Vector3
allowTran	boolean
allowRotate	boolean
allowScale	boolean

Returns

Matrix4

Description

获取世界矩阵

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取变换矩阵

Overrides

Shape.getWorldTransform

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

Shape.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

Shape.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

Name	Type	Description
orginVisible?	boolean	是否获取原始可见性

Returns

boolean

Description

获取可见性

Inherited from

Shape.isVisible

---

markDefinePlaneDirty

▸ markDefinePlaneDirty(): void

Returns

void

Description

平面设置脏标记

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Shape.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Shape.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

Shape.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Shape.removeEvent

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Shape.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

Shape.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

Shape.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

Shape.setAlpha

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Inherited from

Shape.setColor

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

设置效果，包括高亮、轮廓等

Inherited from

Shape.setEffect

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

Shape.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Shape.setId

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

Shape.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

Shape.setNeedClip

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

Shape.setObjectId

---

setOrigVisible

▸ setOrigVisible(arg0): void

Parameters

Name	Type
arg0	boolean

Returns

void

Description

设置原始可见性

---

setOriginId

▸ setOriginId(originId): void

Parameters

Name	Type
originId	number

Returns

void

Description

设置原始id

---

setPMIJson

▸ setPMIJson(json): void

Parameters

Name	Type
json	any

Returns

void

---

setParentModel

▸ setParentModel(parentModel): void

Parameters

Name	Type
parentModel	Model

Returns

void

Description

设置父级模型

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

Shape.setPosition

---

setRenderWorldMatrix

▸ setRenderWorldMatrix(worldMatrix): void

Parameters

Name	Type
worldMatrix	Matrix4

Returns

void

Description

设置绘制时所需的世界矩阵

---

setScene

▸ setScene(scene): void

Parameters

Name	Type
scene	Scene

Returns

void

Description

设置场景

Overrides

Shape.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

Shape.setSelected

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

Shape.setShapeType

---

setVisible

▸ setVisible(visible): void

Parameters

Name	Type
visible	boolean

Returns

void

Description

设置可见性

Overrides

Shape.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

Shape.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

Shape.update