M3D / M3D / Reader / LocalSvlxReader

Class: LocalSvlxReader

M3D.Reader.LocalSvlxReader

Description

本地Svlx读取

Memberof

SView.Reader

Author

YW

Date

2022-1-17

Version

1.0

Hierarchy

• SvlxReader

  ↳ LocalSvlxReader

  ↳↳ WorkerReader

Table of contents

Constructors

• constructor

Properties

• center
• id
• parseMap
• count

Methods

• addFile
• cancel
• cancle
• getAnimation
• getAnimationRes
• getAnnotation
• getAnnotations
• getAttribute
• getCenter
• getDecals
• getEdges
• getEntities
• getEntitiesFile
• getEvents
• getFaces
• getFile
• getFileId
• getGeometries
• getGeometryFeature
• getGeometryFeatures
• getGroups
• getHotSpot
• getHotSpots
• getHotspotRes
• getId
• getImages
• getIsRequesting
• getLocalModelViewContent
• getMaterialById
• getMaterials
• getMaxObjectId
• getMeasure
• getMeasures
• getMesh
• getMesh_1
• getModelBoard
• getModelBoards
• getModelProperties
• getModelViewContent
• getModelViewList
• getModels
• getPMIs
• getParentModel
• getProtoProperties
• getProtos
• getScene
• getSection
• getSections
• getServerModelViewContent
• getServerModelViewList
• getShapes
• getShapesFile
• getSignRes
• getThreeDGesture
• getThreeDGestures
• getTopModel
• getUrl
• isCancle
• isJson
• load
• onBegin
• onCancel
• onEnd
• onException
• onProgress
• onUpdata
• post
• registerEvent
• registerReaderEvent
• removeEvent
• send
• setFile
• setFileId
• setId
• setIsParseInfo
• setIsReferenceReader
• setParentModel
• setScene
• setSvlxFile
• setTopModel
• setUrl
• updata
• getMaxSvlxVersion
• getMinSvlxVersion

Constructors

constructor

• new LocalSvlxReader(options?): LocalSvlxReader

Parameters

Name	Type	Description
options?	any	选项

Returns

LocalSvlxReader

Description

构造函数

Overrides

SvlxReader.constructor

Properties

center

• center: M3DMessageCenter

Inherited from

SvlxReader.center

---

id

• id: number

Inherited from

SvlxReader.id

---

parseMap

• parseMap: Map<any, any>

Inherited from

SvlxReader.parseMap

---

count

▪ Static count: number

Inherited from

SvlxReader.count

Methods

addFile

▸ addFile(file): void

Parameters

Name	Type	Description
file	any	文件

Returns

void

Description

添加文件

Inherited from

SvlxReader.addFile

---

cancel

▸ cancel(): void

Returns

void

Description

取消接口

Inherited from

SvlxReader.cancel

---

cancle

▸ cancle(): void

Returns

void

Description

设置取消

Inherited from

SvlxReader.cancle

---

getAnimation

▸ getAnimation(): Promise<Map<string, string>>

Returns

Promise<Map<string, string>>

动画数据字符串

Description

获取动画数据，数据格式为xml字符串

Inherited from

SvlxReader.getAnimation

---

getAnimationRes

▸ getAnimationRes(): Promise<Map<string, ArrayBuffer>>

Returns

Promise<Map<string, ArrayBuffer>>

动画关联资源数据ArrayBuffer

Description

获取动画关联资源数据

Inherited from

SvlxReader.getAnimationRes

---

getAnnotation

▸ getAnnotation(annotationId): Promise<Annotation>

Parameters

Name	Type	Description
annotationId	number	批注Id

Returns

Promise<Annotation>

Annotation 批注对象

Description

根据id获取单个批注对象

Inherited from

SvlxReader.getAnnotation

---

getAnnotations

▸ getAnnotations(): Promise<Map<number, Annotation>>

Returns

Promise<Map<number, Annotation>>

批注对象 Map

Description

获取所有批注对象的Map

Inherited from

SvlxReader.getAnnotations

---

getAttribute

▸ getAttribute(model): Promise<Map<string, Object>>

Parameters

Name	Type	Description
model	Model	模型

Returns

Promise<Map<string, Object>>

属性集（异步）

Description

获取指定model对应的属性

Inherited from

SvlxReader.getAttribute

---

getCenter

▸ getCenter(): M3DMessageCenter

Returns

M3DMessageCenter

Description

获得消息中心

Inherited from

SvlxReader.getCenter

---

getDecals

▸ getDecals(): Promise<Map<number, Decal>>

Returns

Promise<Map<number, Decal>>

贴图map

Description

获取所有贴图

Inherited from

SvlxReader.getDecals

---

getEdges

▸ getEdges(proto, shapeType, geoType, meshArray?): Promise<Map<number, []>>

Parameters

Name	Type	Description
proto	Model	模型
shapeType	ShapeType	-
geoType	GeoFeatureEnum	模型 未使用
meshArray?	ArrayBuffer	mesh数据 可选参数

Returns

Promise<Map<number, []>>

Description

获取原型下当前等级LOD所有边对象

Inherited from

SvlxReader.getEdges

---

getEntities

▸ getEntities(propertyType): Promise<Map<number, M3DObject>>

Parameters

Name	Type	Description
propertyType	EntityType	数据类型

Returns

Promise<Map<number, M3DObject>>

Description

获取所有指定类型的数据对象， 如:info、material、modelview

Inherited from

SvlxReader.getEntities

---

getEntitiesFile

▸ getEntitiesFile(propertyType): string

Parameters

Name	Type	Description
propertyType	EntityType	实体类型

Returns

string

数据文件字符串

Description

获取所有指定类型的数据文件

Inherited from

SvlxReader.getEntitiesFile

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

SvlxReader.getEvents

---

getFaces

▸ getFaces(proto, meshArray?): Promise<any>

Parameters

Name	Type	Description
proto	Model	模型
meshArray?	ArrayBuffer	可选参数

Returns

Promise<any>

Description

获取原型下当前等级LOD所有面对象

Inherited from

SvlxReader.getFaces

---

getFile

▸ getFile(): File

Returns

File

Description

获取模型文件

Inherited from

SvlxReader.getFile

---

getFileId

▸ getFileId(): string

Returns

string

Description

获取模型对应的唯一标识

Inherited from

SvlxReader.getFileId

---

getGeometries

▸ getGeometries(): Promise<Map<number, Shape>>

Returns

Promise<Map<number, Shape>>

Description

获取所有的几何数据

Inherited from

SvlxReader.getGeometries

---

getGeometryFeature

▸ getGeometryFeature(shape): GeometryFeature | Map<number, GeometryFeature>[]

Parameters

Name	Type	Description
shape	Shape	可见对象

Returns

GeometryFeature | Map<number, GeometryFeature>[]

几何特征对象或几何特征Map数组

Description

获取几何特征

Inherited from

SvlxReader.getGeometryFeature

---

getGeometryFeatures

▸ getGeometryFeatures(): Promise<Map<number, Map<number, GeometryFeature>[]>>

Returns

Promise<Map<number, Map<number, GeometryFeature>[]>>

Description

获取所有几何属性

Inherited from

SvlxReader.getGeometryFeatures

---

getGroups

▸ getGroups(): Promise<Map<number, Group>>

Returns

Promise<Map<number, Group>>

Description

获取所有组的数组

Inherited from

SvlxReader.getGroups

---

getHotSpot

▸ getHotSpot(hotSpotId): Promise<HotSpot>

Parameters

Name	Type	Description
hotSpotId	number	热点Id

Returns

Promise<HotSpot>

热点对象

Description

通过热点Id获取热点对象

Inherited from

SvlxReader.getHotSpot

---

getHotSpots

▸ getHotSpots(): Promise<Map<number, HotSpot>>

Returns

Promise<Map<number, HotSpot>>

热点Map

Description

获取所有热点对象的Map

Inherited from

SvlxReader.getHotSpots

---

getHotspotRes

▸ getHotspotRes(): Promise<Map<string, ArrayBuffer>>

Returns

Promise<Map<string, ArrayBuffer>>

热点关联资源数据ArrayBuffer

Description

获取热点关联资源数据

Inherited from

SvlxReader.getHotspotRes

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

SvlxReader.getId

---

getImages

▸ getImages(): Promise<Map<number, Image>>

Returns

Promise<Map<number, Image>>

视图对象图章Map

Description

获取所有图章对象的Map

Inherited from

SvlxReader.getImages

---

getIsRequesting

▸ getIsRequesting(): boolean

Returns

boolean

Description

是否在请求

---

getLocalModelViewContent

▸ getLocalModelViewContent(modelViewId): Promise<ModelView>

Parameters

Name	Type	Description
modelViewId	number	视图id

Returns

Promise<ModelView>

视图对象 包含视图播放所需所有数据

Description

根据视图id获取本地视图详细数据

Inherited from

SvlxReader.getLocalModelViewContent

---

getMaterialById

▸ getMaterialById(materialId): BaseMaterial

Parameters

Name	Type	Description
materialId	number	材质id

Returns

BaseMaterial

基本材质类

Description

通过材质id获取材质对象

Inherited from

SvlxReader.getMaterialById

---

getMaterials

▸ getMaterials(): Promise<Map<number, BaseMaterial>>

Returns

Promise<Map<number, BaseMaterial>>

材质对象Map

Description

获取所有材质对象的Map

Inherited from

SvlxReader.getMaterials

---

getMaxObjectId

▸ getMaxObjectId(): number

Returns

number

Description

获取最大的id

Inherited from

SvlxReader.getMaxObjectId

---

getMeasure

▸ getMeasure(measureId): Promise<Measure>

Parameters

Name	Type	Description
measureId	number	测量Id

Returns

Promise<Measure>

Measure 测量对象

Description

根据id获取单个测量对象

Inherited from

SvlxReader.getMeasure

---

getMeasures

▸ getMeasures(): Promise<Map<number, Measure>>

Returns

Promise<Map<number, Measure>>

测量对象Map

Description

获取所有测量对象的Map

Inherited from

SvlxReader.getMeasures

---

getMesh

▸ getMesh(lodData): Promise<boolean>

Parameters

Name	Type
lodData	any

Returns

Promise<boolean>

异步返回是否加载成功

Description

获取mesh数据

Inherited from

SvlxReader.getMesh

---

getMesh_1

▸ getMesh_1(model?, offset?): Promise<boolean>

Parameters

Name	Type	Default value	Description
model?	Model	undefined
offset	number	0	未使用 可选参数，默认值为0

Returns

Promise<boolean>

异步返回是否加载成功

Description

获取mesh数据

Inherited from

SvlxReader.getMesh_1

---

getModelBoard

▸ getModelBoard(modelBoardId): Promise<ModelBoard>

Parameters

Name	Type
modelBoardId	number

Returns

Promise<ModelBoard>

Description

根据id获取单个看板对象

Inherited from

SvlxReader.getModelBoard

---

getModelBoards

▸ getModelBoards(): Promise<Map<number, ModelBoard>>

Returns

Promise<Map<number, ModelBoard>>

看板对象的Map

Description

获取所有看板对象的Map

Inherited from

SvlxReader.getModelBoards

---

getModelProperties

▸ getModelProperties(): Promise<Map<string, Object>>

Returns

Promise<Map<string, Object>>

字符串Map

Description

获取.model文件中的instances属性

Inherited from

SvlxReader.getModelProperties

▸ getModelProperties(insID): Promise<Map<string, Object>>

Parameters

Name	Type
insID	number

Returns

Promise<Map<string, Object>>

Description

获取模型属性

Inherited from

SvlxReader.getModelProperties

---

getModelViewContent

▸ getModelViewContent(modelView): Promise<ModelView>

Parameters

Name	Type
modelView	ModelView

Returns

Promise<ModelView>

Description

获取指定视图的详细内容

Inherited from

SvlxReader.getModelViewContent

---

getModelViewList

▸ getModelViewList(): Promise<Map<number, ModelView>>

Returns

Promise<Map<number, ModelView>>

视图对象仅包含列表显示数据

Description

获取所有视图列表数组

Inherited from

SvlxReader.getModelViewList

---

getModels

▸ getModels(): Promise<Map<number, Model>>

Returns

Promise<Map<number, Model>>

模型Map

Description

获取模型接口

Inherited from

SvlxReader.getModels

---

getPMIs

▸ getPMIs(): Promise<Map<number, PMI>>

Returns

Promise<Map<number, PMI>>

Description

获取PMI

Inherited from

SvlxReader.getPMIs

---

getParentModel

▸ getParentModel(): Model

Returns

Model

Description

获取父级模型

Inherited from

SvlxReader.getParentModel

---

getProtoProperties

▸ getProtoProperties(): Promise<Map<string, Object>>

Returns

Promise<Map<string, Object>>

字符串Map

Description

读取.model文件中的models属性

Inherited from

SvlxReader.getProtoProperties

▸ getProtoProperties(protoID): Promise<Map<string, Object>>

Parameters

Name	Type
protoID	number

Returns

Promise<Map<string, Object>>

Description

获取原始属性

Inherited from

SvlxReader.getProtoProperties

---

getProtos

▸ getProtos(): Promise<Map<number, Model>>

Returns

Promise<Map<number, Model>>

模型Map

Description

获取所有原型对象，M3D.Proto的Map，key：protoId

Inherited from

SvlxReader.getProtos

---

getScene

▸ getScene(): Scene

Returns

Scene

Description

获取场景

Inherited from

SvlxReader.getScene

---

getSection

▸ getSection(sectionId): Promise<Section>

Parameters

Name	Type	Description
sectionId	number	剖切面id

Returns

Promise<Section>

剖切面对象

Description

通过剖切面id剖切面对象

Inherited from

SvlxReader.getSection

---

getSections

▸ getSections(): Promise<Map<number, Section>>

Returns

Promise<Map<number, Section>>

key:剖切面的Id；value:剖切面对象

Description

获取所有剖切面的Map

Inherited from

SvlxReader.getSections

---

getServerModelViewContent

▸ getServerModelViewContent(modelView): Promise<ModelView>

Parameters

Name	Type	Description
modelView	ModelView	视图对象

Returns

Promise<ModelView>

视图对象

Description

获取在线视图内容

Inherited from

SvlxReader.getServerModelViewContent

---

getServerModelViewList

▸ getServerModelViewList(): Promise<Map<number, ModelView>>

Returns

Promise<Map<number, ModelView>>

Description

获取在线视图列表

Inherited from

SvlxReader.getServerModelViewList

---

getShapes

▸ getShapes(shapeType): Promise<Map<number, Shape>>

Parameters

Name	Type	Description
shapeType	ShapeType	Shape对象类型

Returns

Promise<Map<number, Shape>>

Description

获取指定类型的Shape对象的集合

Inherited from

SvlxReader.getShapes

---

getShapesFile

▸ getShapesFile(shapeType): string

Parameters

Name	Type	Description
shapeType	ShapeType	Shape对象类型

Returns

string

数据字符串

Description

获取所有指定类型的Shape对象的数据，如pmi/measure/modelboard/annotation等

Inherited from

SvlxReader.getShapesFile

---

getSignRes

▸ getSignRes(): Promise<Map<string, ArrayBuffer>>

Returns

Promise<Map<string, ArrayBuffer>>

图章关联数据ArrayBuffer

Description

获取图章关联资源数据

Inherited from

SvlxReader.getSignRes

---

getThreeDGesture

▸ getThreeDGesture(threeDGesturesId): Promise<ThreeDGesturesNote>

Parameters

Name	Type	Description
threeDGesturesId	number	手绘批注Id

Returns

Promise<ThreeDGesturesNote>

手绘批注对象

Description

根据id获取单个手绘批注对象（手绘批注来源：.measure文件）

Inherited from

SvlxReader.getThreeDGesture

---

getThreeDGestures

▸ getThreeDGestures(): Promise<Map<number, ThreeDGesturesNote>>

Returns

Promise<Map<number, ThreeDGesturesNote>>

手绘批注对象Map

Description

获取所有手绘批注对象的Map

Inherited from

SvlxReader.getThreeDGestures

---

getTopModel

▸ getTopModel(): Promise<Model>

Returns

Promise<Model>

模型

Description

获取顶级装配

Inherited from

SvlxReader.getTopModel

▸ getTopModel(needParseData): Model

Parameters

Name	Type	Description
needParseData	boolean	是否解析数据，不需要解析时直接返回当前topModel对象;

Returns

Model

模型

Description

获取顶级装配

Inherited from

SvlxReader.getTopModel

---

getUrl

▸ getUrl(): string

Returns

string

Description

获取模型路径

Inherited from

SvlxReader.getUrl

---

isCancle

▸ isCancle(): boolean

Returns

boolean

Description

获取是否取消

Inherited from

SvlxReader.isCancle

---

isJson

▸ isJson(name, content): string | [boolean, any]

Parameters

Name	Type	Description
name	string	文件名
content	any	文件内容

Returns

string | [boolean, any]

是否是JSON 1.是JSON数据，返回对应数组[true , JSON对象];2.出错则返回出错信息 ;3.返回null

Description

判断数据是否为json

Inherited from

SvlxReader.isJson

---

load

▸ load(): Promise<Reader>

Returns

Promise<Reader>

异步获取读取类

Description

加载模型

Overrides

SvlxReader.load

▸ load(fileDownloadUrl): Promise<Reader>

Parameters

Name	Type	Description
fileDownloadUrl	string	文件下载路径

Returns

Promise<Reader>

异步获取读取类

Description

加载模型

Overrides

SvlxReader.load

▸ load(fileBuffer): Promise<Reader>

Parameters

Name	Type	Description
fileBuffer	ArrayBuffer	模型二进制文件

Returns

Promise<Reader>

异步获取读取类

Description

加载接口

Overrides

SvlxReader.load

---

onBegin

▸ onBegin(sign, fun): void

Parameters

Name	Type	Description
sign	string	标识，svlx路径或fileid
fun	string	开始的过程或方法

Returns

void

Description

读取开始事件

Inherited from

SvlxReader.onBegin

---

onCancel

▸ onCancel(sign): void

Parameters

Name	Type	Description
sign	string	标识，svlx路径或fileid

Returns

void

Description

读取取消事件

Inherited from

SvlxReader.onCancel

---

onEnd

▸ onEnd(sign, fun): void

Parameters

Name	Type	Description
sign	string	标识，svlx路径或fileid
fun	string	结束过程或方法

Returns

void

Description

读取结束事件

Inherited from

SvlxReader.onEnd

---

onException

▸ onException(sign, fun, error): void

Parameters

Name	Type	Description
sign	string	标识，svlx路径或fileid
fun	string	发生异常的过程或方法
error	Exception	异常信息

Returns

void

Description

读取发生异常事件

Inherited from

SvlxReader.onException

---

onProgress

▸ onProgress(sign, fun, progress): void

Parameters

Name	Type	Description
sign	string	标识，svlx路径或fileid
fun	string	进度发生变化的过程或方法
progress	number	进度

Returns

void

Description

读取进度变化事件

Inherited from

SvlxReader.onProgress

---

onUpdata

▸ onUpdata(sign, fun, dataType): void

Parameters

Name	Type
sign	string
fun	string
dataType	string

Returns

void

Description

读取更新事件

Inherited from

SvlxReader.onUpdata

---

post

▸ post(msg): void

Parameters

Name	Type	Description
msg	M3DMessage	消息内容

Returns

void

Description

消息发送者必须实现方法

Inherited from

SvlxReader.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

SvlxReader.registerEvent

---

registerReaderEvent

▸ registerReaderEvent(): ReaderEvent

Returns

ReaderEvent

读取事件

Description

注册监听

Inherited from

SvlxReader.registerReaderEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

SvlxReader.removeEvent

---

send

▸ send(msg): void

Parameters

Name	Type	Description
msg	M3DMessage	消息内容

Returns

void

Description

消息发送者必须实现方法

Inherited from

SvlxReader.send

---

setFile

▸ setFile(file): Promise<SvlxReader>

Parameters

Name	Type	Description
file	SvlxFile	SvlxFile对象

Returns

Promise<SvlxReader>

Svlx读取类

Description

设置svlx文件

Inherited from

SvlxReader.setFile

▸ setFile(file, sign?): Promise<SvlxReader>

Parameters

Name	Type	Description
file	ArrayBuffer	svlx文件的二进制数据
sign?	string	可选参数

Returns

Promise<SvlxReader>

Svlx读取类

Description

设置svlx文件

Inherited from

SvlxReader.setFile

---

setFileId

▸ setFileId(fileId): void

Parameters

Name	Type	Description
fileId	string	唯一标识

Returns

void

Description

设置模型对应的唯一标识

Inherited from

SvlxReader.setFileId

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

SvlxReader.setId

---

setIsParseInfo

▸ setIsParseInfo(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置当前Reader是否需要解析Info数据

Inherited from

SvlxReader.setIsParseInfo

---

setIsReferenceReader

▸ setIsReferenceReader(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否为分散文件

Inherited from

SvlxReader.setIsReferenceReader

---

setParentModel

▸ setParentModel(parentModel): void

Parameters

Name	Type	Description
parentModel	Model	父级模型

Returns

void

Description

设置父级模型，即Reaader读取出的顶级模型在哪个模型下

Inherited from

SvlxReader.setParentModel

---

setScene

▸ setScene(scene): void

Parameters

Name	Type
scene	Scene

Returns

void

Description

设置场景

Inherited from

SvlxReader.setScene

---

setSvlxFile

▸ setSvlxFile(svlxFile): void

Parameters

Name	Type	Description
svlxFile	SvlxFile	对象

Returns

void

Description

设置SvlxReader中的File

Inherited from

SvlxReader.setSvlxFile

---

setTopModel

▸ setTopModel(topModel): void

Parameters

Name	Type
topModel	Model

Returns

void

Description

设置顶级模型

Inherited from

SvlxReader.setTopModel

---

setUrl

▸ setUrl(url): void

Parameters

Name	Type	Description
url	string	模型路径URL

Returns

void

Description

设置模型路径

Inherited from

SvlxReader.setUrl

---

updata

▸ updata(fun, dataType): void

Parameters

Name	Type
fun	string
dataType	string

Returns

void

Description

更新

Inherited from

SvlxReader.updata

---

getMaxSvlxVersion

▸ getMaxSvlxVersion(): string

Returns

string

Static

Description

获取svlx文件的最高版本

Inherited from

SvlxReader.getMaxSvlxVersion

---

getMinSvlxVersion

▸ getMinSvlxVersion(): string

Returns

string

Static

Description

获取svlx文件的最低版本

Inherited from

SvlxReader.getMinSvlxVersion