M3D / M3D / Shapes / ModelView

Class: ModelView

M3D.Shapes.ModelView

Memberof

M3D.Shapes

Description

视图

Date

2022-1-12

Version

1.0

Copyright

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

Hierarchy

• Shape

  ↳ ModelView

Table of contents

Constructors

• constructor

Properties

• id
• name
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• addModelboardsId
• addNoteId
• addPMIId
• addSectionPlaneId
• clearNoteDataList
• clearProperties
• clearSectionPlaneId
• deleteProperty
• getAlpha
• getBoundingBox
• getCamera
• getCameraStr
• getColor
• getDrawables
• getEffect
• getEvents
• getExplosivePercent
• getExplosiveType
• getGestureNotePolyLineColors
• getId
• getImageFile
• getInstanceAttributeMap
• getInstanceAttributeStr
• getIsFrontShow
• getIsInitView
• getIsReverseClipping
• getLocalTransform
• getMeasures
• getModelBoardsIDList
• getName
• getNeedClip
• getNoteDataList
• getNoteList
• getObjectId
• getPMIList
• getPosition
• getProperties
• getProperty
• getProto
• getProtoId
• getRenderShapes
• getRotation
• getScene
• getSectionPlaneDirection
• getSectionPlaneIDList
• getSectionPlanePercentage
• getShapeType
• getShowClipSectionPlane
• getSvlType
• getUpDataCameraState
• getUpDataModelState
• getViewType
• getWorldBoundingBox
• getWorldTransform
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setCamera
• setCameraStr
• setColor
• setEffect
• setExplosivePercent
• setExplosiveType
• setFrontShow
• setGestureNotePolyLineColors
• setId
• setImageFile
• setInstanceAttributeMap
• setInstanceAttributeStr
• setIsInitView
• setModelView
• setName
• setNeedClip
• setNoteDataList
• setNoteIds
• setObjectId
• setPMIIds
• setPosition
• setProperty
• setProtoId
• setReverseClipping
• setScene
• setSectionPlaneDirection
• setSectionPlaneDirectionAndPercentage
• setSectionPlaneIDList
• setSectionPlanePercentage
• setSelected
• setShapeType
• setShowClipSectionPlane
• setShowSectionCappingPlane
• setSvlType
• setUpDataCamera
• setUpDataModel
• setViewType
• setVisible
• setWorldTransform
• update
• updateCameraUpDir
• create

Constructors

constructor

• new ModelView(): ModelView

Returns

ModelView

Description

构造函数

Overrides

Shape.constructor

• new ModelView(modelView): ModelView

Parameters

Name	Type	Description
modelView	ModelView	视图

Returns

ModelView

Description

构造函数

Overrides

Shape.constructor

Properties

id

• id: number

Inherited from

Shape.id

---

name

• name: string

Overrides

Shape.name

---

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

---

addModelboardsId

▸ addModelboardsId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

添加看板id

---

addNoteId

▸ addNoteId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

添加批注对象Id

---

addPMIId

▸ addPMIId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

添加PMI对象Id

---

addSectionPlaneId

▸ addSectionPlaneId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

添加剖切面Id

---

clearNoteDataList

▸ clearNoteDataList(): void

Returns

void

Description

清空数据列表Map

---

clearProperties

▸ clearProperties(): void

Returns

void

Description

清空属性

---

clearSectionPlaneId

▸ clearSectionPlaneId(): void

Returns

void

Description

清空剖切Id

---

deleteProperty

▸ deleteProperty(key): boolean

Parameters

Name	Type
key	string

Returns

boolean

Description

删除属性

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

Shape.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

Shape.getBoundingBox

---

getCamera

▸ getCamera(): Camera

Returns

Camera

相机

Description

获取相机对象

---

getCameraStr

▸ getCameraStr(): string

Returns

string

Description

获取相机字符串信息

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

Shape.getColor

---

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

---

getExplosivePercent

▸ getExplosivePercent(): number

Returns

number

Description

获取爆炸百分比

---

getExplosiveType

▸ getExplosiveType(): number

Returns

number

Description

获取爆炸方向

---

getGestureNotePolyLineColors

▸ getGestureNotePolyLineColors(): Color[]

Returns

Color[]

Description

获取手势线颜色

---

getId

▸ getId(): number

Returns

number

Description

获取Id

Overrides

Shape.getId

---

getImageFile

▸ getImageFile(): Blob

Returns

Blob

图片文件

Description

获得图片文件

---

getInstanceAttributeMap

▸ getInstanceAttributeMap(): Map<string, InstanceAttribute>

Returns

Map<string, InstanceAttribute>

Description

获取模型的当前矩阵信息map

---

getInstanceAttributeStr

▸ getInstanceAttributeStr(): string

Returns

string

Description

获取模型的当前矩阵信息map --初次解析，按照字符串形式存储

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

Shape.getIsFrontShow

---

getIsInitView

▸ getIsInitView(): boolean

Returns

boolean

Description

获取是否是默认视图

---

getIsReverseClipping

▸ getIsReverseClipping(): boolean

Returns

boolean

剖切面反面显示表示

Description

获取剖切面反面显示表示

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

Shape.getLocalTransform

---

getMeasures

▸ getMeasures(): number[]

Returns

number[]

Description

获取测量列表

---

getModelBoardsIDList

▸ getModelBoardsIDList(): number[]

Returns

number[]

Description

获取看板id列表

---

getName

▸ getName(): string

Returns

string

Description

获取名称

Overrides

Shape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

Shape.getNeedClip

---

getNoteDataList

▸ getNoteDataList(key): string[]

Parameters

Name	Type	Description
key	ShapeType	Shape类型

Returns

string[]

Description

获取数据列表Map

---

getNoteList

▸ getNoteList(): number[]

Returns

number[]

Description

获取批注列表

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

Shape.getObjectId

---

getPMIList

▸ getPMIList(): number[]

Returns

number[]

Description

获取pmi id列表

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

Shape.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

Shape.getProperties

---

getProperty

▸ getProperty(key): string

Parameters

Name	Type
key	string

Returns

string

Description

获取属性

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

Shape.getProto

---

getProtoId

▸ getProtoId(): number

Returns

number

Description

获取原型Id

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

Shape.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

Shape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

Shape.getScene

---

getSectionPlaneDirection

▸ getSectionPlaneDirection(): number

Returns

number

Description

获取剖切面剖切方向

---

getSectionPlaneIDList

▸ getSectionPlaneIDList(): number[]

Returns

number[]

Description

获取剖切面Id列表

---

getSectionPlanePercentage

▸ getSectionPlanePercentage(): number

Returns

number

Description

获取剖切面剖切比例

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

Shape.getShapeType

---

getShowClipSectionPlane

▸ getShowClipSectionPlane(): boolean

Returns

boolean

Description

获取剖切面显示标示

---

getSvlType

▸ getSvlType(): StkViewUsageEnum

Returns

StkViewUsageEnum

Description

从svl中读取到的type

---

getUpDataCameraState

▸ getUpDataCameraState(): boolean

Returns

boolean

Description

获取是否更新相机

---

getUpDataModelState

▸ getUpDataModelState(): boolean

Returns

boolean

Description

获取是否更新模型

---

getViewType

▸ getViewType(): ViewTypeEnum

Returns

ViewTypeEnum

当前视图类型

Description

获取当前视图类型

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

Shape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

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

---

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

---

setCamera

▸ setCamera(camera): void

Parameters

Name	Type
camera	Camera

Returns

void

Description

设置相加

---

setCameraStr

▸ setCameraStr(cameraStr): void

Parameters

Name	Type
cameraStr	string

Returns

void

Description

设置相机字符串信息

---

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

---

setExplosivePercent

▸ setExplosivePercent(percent): void

Parameters

Name	Type
percent	number

Returns

void

Description

设置爆炸百分比

---

setExplosiveType

▸ setExplosiveType(type): void

Parameters

Name	Type
type	number

Returns

void

Description

设置爆炸方向

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

Shape.setFrontShow

---

setGestureNotePolyLineColors

▸ setGestureNotePolyLineColors(pLineColors): void

Parameters

Name	Type	Description
pLineColors	Color[]	手势线颜色

Returns

void

Description

设置手势线颜色

---

setId

▸ setId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置Id，可能由ModelView自动生成Id，也可能从外部传入Id

Overrides

Shape.setId

---

setImageFile

▸ setImageFile(image): void

Parameters

Name	Type
image	Blob

Returns

void

Description

设置图片文件

---

setInstanceAttributeMap

▸ setInstanceAttributeMap(instanceAttributeMap): void

Parameters

Name	Type
instanceAttributeMap	Map<string, InstanceAttribute>

Returns

void

Description

设置模型的当前矩阵信息map

---

setInstanceAttributeStr

▸ setInstanceAttributeStr(instanceAttributeStr): void

Parameters

Name	Type
instanceAttributeStr	string

Returns

void

Description

设置模型的当前矩阵信息map --初次解析，按照字符串形式存储

---

setIsInitView

▸ setIsInitView(bInit): void

Parameters

Name	Type
bInit	boolean

Returns

void

Description

设置是否是默认视图

---

setModelView

▸ setModelView(id, name, type, camera, pmiList, noteList, sectionPlanIDlist, instanceAttributeMap): void

Parameters

Name	Type	Description
id	number	视图id
name	string	视图名称
type	ViewTypeEnum	视图类型
camera	Camera	相机
pmiList	number[]	PMI 列表
noteList	number[]	note列表
sectionPlanIDlist	number[]	剖面 id列表
instanceAttributeMap	Map<string, InstanceAttribute>	模型的当前ins信息map

Returns

void

Description

设置视图信息

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置名称

Overrides

Shape.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

Shape.setNeedClip

---

setNoteDataList

▸ setNoteDataList(key, noteDataList): void

Parameters

Name	Type
key	ShapeType
noteDataList	string[]

Returns

void

Description

设置数据列表Map

---

setNoteIds

▸ setNoteIds(ids): void

Parameters

Name	Type
ids	number[]

Returns

void

Description

设置批注对象Id

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

Shape.setObjectId

---

setPMIIds

▸ setPMIIds(ids): void

Parameters

Name	Type
ids	number[]

Returns

void

Description

设置PMI对象Id

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

Shape.setPosition

---

setProperty

▸ setProperty(key, value): void

Parameters

Name	Type
key	string
value	string

Returns

void

Description

设置属性

---

setProtoId

▸ setProtoId(protoId): void

Parameters

Name	Type
protoId	number

Returns

void

Description

设置原型Id

---

setReverseClipping

▸ setReverseClipping(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切面反面显示表示

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

Shape.setScene

---

setSectionPlaneDirection

▸ setSectionPlaneDirection(direction): void

Parameters

Name	Type
direction	number

Returns

void

Description

设置剖切面剖切方向

---

setSectionPlaneDirectionAndPercentage

▸ setSectionPlaneDirectionAndPercentage(directionX, directionY, directionZ, percentageX, percentageY, percentageZ): void

Parameters

Name	Type
directionX	number
directionY	number
directionZ	number
percentageX	number
percentageY	number
percentageZ	number

Returns

void

Description

设置剖切面剖切方向

---

setSectionPlaneIDList

▸ setSectionPlaneIDList(sectionPlanList): void

Parameters

Name	Type
sectionPlanList	number[]

Returns

void

Description

设置剖切面Id列表

---

setSectionPlanePercentage

▸ setSectionPlanePercentage(percentage): void

Parameters

Name	Type
percentage	number

Returns

void

Description

设置剖切面剖切比例

---

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

---

setShowClipSectionPlane

▸ setShowClipSectionPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切面显示标示

---

setShowSectionCappingPlane

▸ setShowSectionCappingPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切盖面显示标示

---

setSvlType

▸ setSvlType(svlType): void

Parameters

Name	Type
svlType	StkViewUsageEnum

Returns

void

Description

设置从svl中读取到的type

---

setUpDataCamera

▸ setUpDataCamera(state): void

Parameters

Name	Type
state	boolean

Returns

void

Description

设置是否更新相机

---

setUpDataModel

▸ setUpDataModel(state): void

Parameters

Name	Type
state	boolean

Returns

void

Description

设置是否更新模型

---

setViewType

▸ setViewType(type): void

Parameters

Name	Type
type	ViewTypeEnum

Returns

void

Description

设置当前视图类型

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

Name	Type	Description
visible	boolean	是否可见 boolean类型
originVisible?	boolean	-

Returns

void

Description

设置是否可见

Inherited from

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

---

updateCameraUpDir

▸ updateCameraUpDir(dir, boxCenter): void

Parameters

Name	Type
dir	Vector3
boxCenter	Vector3

Returns

void

Description

更新视图相机方向矩阵

---

create

▸ create(): ModelView

Returns

ModelView

视图

Description

创建视图