跳到主要内容
版本：v10.0

M3D / M3D / IO / SvlxFile

Class: SvlxFile

M3D.IO.SvlxFile

Memberof

M3D.IO

Description

vlx封装类，包含svlx文件的zip格式文件，以及封装接口

Author

YW

Date

2022-1-17

Version

1.0

Copyright

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

Hierarchy​

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new SvlxFile(sign?): SvlxFile

Parameters​

NameTypeDescription
sign?string签名

Returns​

SvlxFile

Description

构造函数

Overrides​

File.constructor

Properties​

id​

• id: number

Inherited from​

File.id

ALL_SUBFILE​

▪ Static ALL_SUBFILE: string

ANIMATION_SUBFILE​

▪ Static ANIMATION_SUBFILE: string

ANNOTATION_SUBFILE​

▪ Static ANNOTATION_SUBFILE: string

ATTRIBUTE_SUBFILE​

▪ Static ATTRIBUTE_SUBFILE: string

BOM_SUBFILE​

▪ Static BOM_SUBFILE: string

DECAL_SUBFILE​

▪ Static DECAL_SUBFILE: string

EDGE_SUBFILE​

▪ Static EDGE_SUBFILE: string

GEOMETRY_SUBFILE​

▪ Static GEOMETRY_SUBFILE: string

GEO_SUBFILE​

▪ Static GEO_SUBFILE: string

GROUP_SUBFILE​

▪ Static GROUP_SUBFILE: string

HOTSPOTRES_SUBFILE​

▪ Static HOTSPOTRES_SUBFILE: string

IMAGE_SUBFILE​

▪ Static IMAGE_SUBFILE: string

INFO_SUBFILE​

▪ Static INFO_SUBFILE: string

LIGHT_SUBFILE​

▪ Static LIGHT_SUBFILE: string

▪ Static LINK_SUBFILE: string

LOD_SPLITELOD​

▪ Static LOD_SPLITELOD: string

LOD_SUBFILE​

▪ Static LOD_SUBFILE: string

MATERIAL_SUBFILE​

▪ Static MATERIAL_SUBFILE: string

MEASURE_SUBFILE​

▪ Static MEASURE_SUBFILE: string

MESH1_SUBFILE​

▪ Static MESH1_SUBFILE: string

MESH2_SUBFILE​

▪ Static MESH2_SUBFILE: string

MESH3_SUBFILE​

▪ Static MESH3_SUBFILE: string

MESH4_SUBFILE​

▪ Static MESH4_SUBFILE: string

MESH5_SUBFILE​

▪ Static MESH5_SUBFILE: string

MESHBLOCK_SUBFILE​

▪ Static MESHBLOCK_SUBFILE: string

MESH_SUBFILE​

▪ Static MESH_SUBFILE: string

MODELBOARD_SUBFILE​

▪ Static MODELBOARD_SUBFILE: string

MODEL_INSTANCES​

▪ Static MODEL_INSTANCES: string

MODEL_MODELS​

▪ Static MODEL_MODELS: string

MODEL_SUBFILE​

▪ Static MODEL_SUBFILE: string

PMI_SUBFILE​

▪ Static PMI_SUBFILE: string

SARES_SUBFILE​

▪ Static SARES_SUBFILE: string

SECTION_SUBFILE​

▪ Static SECTION_SUBFILE: string

SHOTSPOT_SUBFILE​

▪ Static SHOTSPOT_SUBFILE: string

STORY_SUBFILE​

▪ Static STORY_SUBFILE: string

THREEDGESTURE_SUBFILE​

▪ Static THREEDGESTURE_SUBFILE: string

VIEW_SUBFILE​

▪ Static VIEW_SUBFILE: string

count​

▪ Static count: number

Inherited from​

File.count

Methods​

addMeshBlock​

▸ addMeshBlock(indexNumber, jsObj): void

Parameters​

NameType
indexNumbernumber
jsObjArrayBuffer

Returns​

void

Description

添加Mesh块文件

addModelByProtoID​

▸ addModelByProtoID(protoId, model): boolean

Parameters​

NameType
protoIdnumber
modelModel

Returns​

boolean

Description

添加原型对应的实例

addSubFile​

▸ addSubFile(regExp, jsObj): void

Parameters​

NameType
regExpstring
jsObjstring | ArrayBuffer | Map<string, string | ArrayBuffer>

Returns​

void

Description

添加子文件

addSubM3DObject​

▸ addSubM3DObject(fileName, object): void

Parameters​

NameTypeDescription
fileNamestring文件名称
objectany

Returns​

void

Description

添加子件对应M3DObject

Inherited from​

File.addSubM3DObject

decodeFile​

▸ decodeFile(): Promise<void>

Returns​

Promise<void>

Description

解密文件

getAniSares​

▸ getAniSares(regExpStr): string | ArrayBuffer | Map<string, string | ArrayBuffer>

Parameters​

NameType
regExpStrstring

Returns​

string | ArrayBuffer | Map<string, string | ArrayBuffer>

Description

获取动画资源文件(/sares/xxx.mp3/png)

getEvents​

▸ getEvents(): M3DEvent[]

Returns​

M3DEvent[]

Description

获得事件列表

Inherited from​

File.getEvents

getFile​

▸ getFile(fileName, usePromise?): string | ArrayBuffer | Promise<string | ArrayBuffer>

Parameters​

NameTypeDescription
fileNamestring模型格式名称，lod、bom、mesh、info、model、attribute等
usePromise?boolean

Returns​

string | ArrayBuffer | Promise<string | ArrayBuffer>

Description

获取子文件

getFileArray​

▸ getFileArray(): any

Returns​

any

文件数组

Description

设置文件集合

Inherited from​

File.getFileArray

getFileType​

▸ getFileType(): FileType

Returns​

FileType

文件类型

Description

获取文件类型

Inherited from​

File.getFileType

getFiles​

▸ getFiles(fileName): string | ArrayBuffer | Map<string, string | ArrayBuffer> | Promise<string | ArrayBuffer | Map<string, string | ArrayBuffer>>

Parameters​

NameTypeDescription
fileNamestring模型格式名称，lod、bom、mesh、info、model、attribute等

Returns​

string | ArrayBuffer | Map<string, string | ArrayBuffer> | Promise<string | ArrayBuffer | Map<string, string | ArrayBuffer>>

Description

获取子文件

getHotspotRes​

▸ getHotspotRes(regExpStr): string | ArrayBuffer | Map<string, string | ArrayBuffer>

Parameters​

NameType
regExpStrstring

Returns​

string | ArrayBuffer | Map<string, string | ArrayBuffer>

Description

获取热点相关音频文件

getId​

▸ getId(): number

Returns​

number

Description

获取id

Inherited from​

File.getId

getIsServerFile​

▸ getIsServerFile(): boolean

Returns​

boolean

Description

获取是否为后台服务文件

Author

ss

Date

2023/03/13

getMeshBlockByIndexNumber​

▸ getMeshBlockByIndexNumber(indexNumber): ArrayBuffer

Parameters​

NameType
indexNumbernumber

Returns​

ArrayBuffer

Description

获取Mesh块文件

getMeshBlockMap​

▸ getMeshBlockMap(): Map<number, ArrayBuffer>

Returns​

Map<number, ArrayBuffer>

Description

获取Mesh块文件Map

getModelsByProtoID​

▸ getModelsByProtoID(id): Model[]

Parameters​

NameType
idnumber

Returns​

Model[]

Description

根据原型ID获取实例

getSceneFile​

▸ getSceneFile(): any

Returns​

any

Description

获取场景文件

Inherited from​

File.getSceneFile

getSecretContent​

▸ getSecretContent(): string

Returns​

string

Description

获取解密密钥

getServerOptions​

▸ getServerOptions(): string

Returns​

string

Description

获取解密服务器路径

getServerUrl​

▸ getServerUrl(): string

Returns​

string

Description

获取服务地址

Author

ss

Date

2023/03/13

getSign​

▸ getSign(): string

Returns​

string

Description

设置标签

Inherited from​

File.getSign

getSignRes​

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

Parameters​

NameType
regExpStrstring

Returns​

string | ArrayBuffer | Map<string, string | ArrayBuffer> | Promise<string | ArrayBuffer | Map<string, string | ArrayBuffer>>

Description

获取图章资源数据(/seal/xxx.png)

getSubM3DObject​

▸ getSubM3DObject(fileName): any

Parameters​

NameTypeDescription
fileNamestring文件名称

Returns​

any

Description

获取文件对应的M3DObject

Inherited from​

File.getSubM3DObject

getSubSvlx​

▸ getSubSvlx(fileName): ArrayBuffer

Parameters​

NameTypeDescription
fileNamestring模型名称

Returns​

ArrayBuffer

Description

获取子件svlx

getSvlxVersion​

▸ getSvlxVersion(): string

Returns​

string

Description

获取文件版本

Author

ss

Date

2023/03/13

getVertexSetWithLevel​

▸ getVertexSetWithLevel(level): VertexSet

Parameters​

NameType
levelnumber

Returns​

VertexSet

Description

根据lod等级获取顶点集对象

getViewImage​

▸ getViewImage(imageUrl): string | ArrayBuffer

Parameters​

NameTypeDescription
imageUrlstring视图图片在模型的相对路径

Returns​

string | ArrayBuffer

Description

获取视图相关图片

getZipFile​

▸ getZipFile(): any

Returns​

any

Description

获取模型压缩文件

hasSubSvlx​

▸ hasSubSvlx(fileName): boolean

Parameters​

NameTypeDescription
fileNamestring模型名称

Returns​

boolean

Description

是否存在子件svlx

registerEvent​

▸ registerEvent(event): void

Parameters​

NameTypeDescription
eventM3DEventM3D事件

Returns​

void

Description

注册事件

Inherited from​

File.registerEvent

removeEvent​

▸ removeEvent(): void

Returns​

void

Description

删除事件

Inherited from​

File.removeEvent

setFileArray​

▸ setFileArray(fileArray): Promise<File>

Parameters​

NameType
fileArrayArrayBuffer

Returns​

Promise<File>

Description

设置文件ArrayBuffer

Overrides​

File.setFileArray

setFileType​

▸ setFileType(fileType): void

Parameters​

NameType
fileTypeFileType

Returns​

void

Description

设置文件类型

Inherited from​

File.setFileType

setId​

▸ setId(v): void

Parameters​

NameTypeDescription
vnumberShapeId

Returns​

void

Description

设置id

Inherited from​

File.setId

setIsServerFile​

▸ setIsServerFile(v): void

Parameters​

NameType
vboolean

Returns​

void

Description

设置是否为通过后台服务文件

Author

ss

Date

2023/03/13

setSceneFile​

▸ setSceneFile(sceneFile): void

Parameters​

NameType
sceneFileany

Returns​

void

Description

设置场景文件

Inherited from​

File.setSceneFile

setSecretContent​

▸ setSecretContent(secretContent): void

Parameters​

NameType
secretContentstring

Returns​

void

Description

设置解密密钥

setServerOptions​

▸ setServerOptions(serverOptions): void

Parameters​

NameType
serverOptionsstring

Returns​

void

Description

设置解密服务器路径

setServerUrl​

▸ setServerUrl(v): void

Parameters​

NameType
vstring

Returns​

void

Description

设置服务地址

Author

ss

Date

2023/03/13

setSvlxVersion​

▸ setSvlxVersion(svlxVersion): void

Parameters​

NameType
svlxVersionstring

Returns​

void

Description

设置文件版本

Author

ss

Date

2023/03/13

setVertexSetWithLevel​

▸ setVertexSetWithLevel(level, vertexSet): void

Parameters​

NameType
levelnumber
vertexSetVertexSet

Returns​

void

Description

根据lod等级设置顶点集对象

setZipFile​

▸ setZipFile(zipFile): void

Parameters​

NameType
zipFileany

Returns​

void

Description

设置模型压缩文件