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

M3D / M3D / Scene

Class: Scene

M3D.Scene

Memberof

M3D

Description

场景对象

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 Scene(...para): Scene

Parameters​

NameType
...paraany[]

Returns​

Scene

Description

构造函数

Overrides​

M3DObject.constructor

Properties​

id​

• id: number

Inherited from​

M3DObject.id

count​

▪ Static count: number

Inherited from​

M3DObject.count

Methods​

addFile​

▸ addFile(url, parentModel?): Promise<any>

Parameters​

NameTypeDescription
urlstring模型文件路径
parentModel?Model可选参数，将要插入到哪个Model下

Returns​

Promise<any>

Description

添加文件

▸ addFile(fileId, serverUrl, parentModel?): Promise<any>

Parameters​

NameTypeDescription
fileIdstring文件的fileId
serverUrlstring文件存储的服务器路径
parentModel?Model可选参数，将要插入到哪个Model下

Returns​

Promise<any>

Description

添加文件

▸ addFile(tag, format, fileArray, parentModel?): Promise<any>

Parameters​

NameTypeDescription
tagstring文件的唯一标识
formatstring文件格式
fileArrayArrayBuffer二进制文件
parentModel?Model可选参数，将要插入到哪个Model下

Returns​

Promise<any>

Description

添加文件

▸ addFile(urls, parentModel?): Promise<any>

Parameters​

NameTypeDescription
urlsstring[]文件路径数组
parentModel?Model可选参数，将要插入到哪个Model下

Returns​

Promise<any>

Description

添加文件

▸ addFile(tag, reader, parentModel?): Promise<any>

Parameters​

NameTypeDescription
tagstring文件的唯一标识
readerReader文件所在Reader
parentModel?Model可选参数，将要插入到哪个Model下

Returns​

Promise<any>

Description

添加文件

▸ addFile(userFileID, serverUrl, reader): Promise<any>

Parameters​

NameTypeDescription
userFileIDstring文件ID
serverUrlstring
readerReader

Returns​

Promise<any>

Description

添加文件,按需获取分散文件

cancle​

▸ cancle(): void

Returns​

void

Description

设置取消

clear​

▸ clear(): void

Returns​

void

Description

场景清空

clearData​

▸ clearData(para): void

Parameters​

NameType
paraany

Returns​

void

Description

清空批注测量等信息，不传参全清空

close​

▸ close(...para): void

Parameters​

NameType
...paraany[]

Returns​

void

Description

关闭模型，或一个模型

computeBox​

▸ computeBox(): void

Returns​

void

Description

计算包围盒

createBackground​

▸ createBackground(): void

Returns​

void

Description

创建背景对象

createView​

▸ createView(): void

Returns​

void

doAction​

▸ doAction(action): ActionState

Parameters​

NameType
actionAction

Returns​

ActionState

Description

执行动作

getAttributesMap​

▸ getAttributesMap(): Map<string, any>

Returns​

Map<string, any>

Description

获取属性Map

getAxis​

▸ getAxis(): Axis

Returns​

Axis

Description

获取坐标轴对象

getBackground​

▸ getBackground(): Background

Returns​

Background

Description

获取默认背景对象

getBoundingBox​

▸ getBoundingBox(isTotal?): BoundingBox

Parameters​

NameType
isTotal?boolean

Returns​

BoundingBox

Description

获取包围盒

getCollisionManager​

▸ getCollisionManager(): Collisions

Returns​

Collisions

Description

获取干涉检查管理类

getCompareModelManager​

▸ getCompareModelManager(): CompareModels

Returns​

CompareModels

Description

获取模型比对管理类

getCurrentViewPort​

▸ getCurrentViewPort(): Viewport

Returns​

Viewport

Description

获取当前视口

getDefaultFocusLength​

▸ getDefaultFocusLength(): number

Returns​

number

Description

获取默认焦距

getDraggerManager​

▸ getDraggerManager(): Draggers

Returns​

Draggers

Description

获取拖拽器管理类

getDrawMode​

▸ getDrawMode(): number

Returns​

number

Description

获取渲染模式

getEffectManager​

▸ getEffectManager(): Effects

Returns​

Effects

Description

获取效果管理

getEvents​

▸ getEvents(): M3DEvent[]

Returns​

M3DEvent[]

Description

获得事件列表

Inherited from​

M3DObject.getEvents

getFileInfo​

▸ getFileInfo(): Info

Returns​

Info

Description

获取文件信息

getFps​

▸ getFps(): FPS

Returns​

FPS

Description

获取fps对象

getGlueObj​

▸ getGlueObj(): GlueObj

Returns​

GlueObj

getGroups​

▸ getGroups(): Groups

Returns​

Groups

组管理对象

Description

获取场景关联的组管理对象

getId​

▸ getId(): number

Returns​

number

Description

获取id

Inherited from​

M3DObject.getId

getInstances​

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

Returns​

Map<Model, Model[]>

Description

获取多实例数据

getIsUpdateShadow​

▸ getIsUpdateShadow(): boolean

Returns​

boolean

Description

获取是否更新阴影

getLicenseHelper​

▸ getLicenseHelper(): LicenseHelper

Returns​

LicenseHelper

Description

获取许可验证帮助类

getLicenseTools​

▸ getLicenseTools(): LicenseTools

Returns​

LicenseTools

Description

获取许可验证工具类

getLightManager​

▸ getLightManager(): Lights

Returns​

Lights

Description

获取灯光管理

getLoader​

▸ getLoader(): Loader

Returns​

Loader

Description

获取加载管理器

getLoaderState​

▸ getLoaderState(step): boolean

Parameters​

NameType
stepLoadStep

Returns​

boolean

true加载成功 false加载失败

Description

获取子文件加载状态

getLocationParameterManager​

▸ getLocationParameterManager(): LocationParameters

Returns​

LocationParameters

Description

获取位置管理

getMaterialManager​

▸ getMaterialManager(): Materials

Returns​

Materials

Description

获取材质管理

getName​

▸ getName(): string

Returns​

string

Description

获取场景名称

getNonInstances​

▸ getNonInstances(): Model[]

Returns​

Model[]

Description

获取非多实例数据

getOctreeHandler​

▸ getOctreeHandler(): OctreeHandler

Returns​

OctreeHandler

Description

获取八叉树管理类

getParameters​

▸ getParameters(): SParameters

Returns​

SParameters

Description

获取参数配置对象

getPreSelector​

▸ getPreSelector(): PreSelector

Returns​

PreSelector

Description

获取场景关联的预选器

getRender​

▸ getRender(): Renders

Returns​

Renders

Description

获取渲染管理类

getResources​

▸ getResources(): Resources

Returns​

Resources

Description

获取资源管理

getSceneBox​

▸ getSceneBox(): BoundingBox

Returns​

BoundingBox

场景包围盒

Description

获取场景包围盒

getSelectedBox​

▸ getSelectedBox(): SelectedBox

Returns​

SelectedBox

Description

获取选中包围盒

getSelector​

▸ getSelector(): Selector

Returns​

Selector

选择器对象

Description

获取场景关联的选择器

getShapeByPlcPath​

▸ getShapeByPlcPath(plcPath): Shape

Parameters​

NameType
plcPathstring

Returns​

Shape

Description

根据plcPath获取Shape

getShapeEvents​

▸ getShapeEvents(): void

Returns​

void

Description

获取所有Shape事件

getShapes​

▸ getShapes(): ShapeSet

Returns​

ShapeSet

管理类

Description

获取shape管理类

getTopModel​

▸ getTopModel(): Model

Returns​

Model

Description

获取顶级模型

Description

修改方法，直接返回Scene中创建的虚拟顶级节点

getUser​

▸ getUser(): string

Returns​

string

Description

获取许可用户

getVertexSetManager​

▸ getVertexSetManager(): VertexSets

Returns​

VertexSets

Description

获取顶点集管理

getViewPorts​

▸ getViewPorts(): Viewports

Returns​

Viewports

Description

获取ViewPorts管理类

getVisiables​

▸ getVisiables(): Visibles

Returns​

Visibles

Description

获取可见对象管理类

getVisibleSetDiry​

▸ getVisibleSetDiry(viewport): boolean

Parameters​

NameType
viewportViewport

Returns​

boolean

Description

获取场景可视化对象集是否为脏

isCancle​

▸ isCancle(): boolean

Returns​

boolean

Description

获取是否取消

post​

▸ post(msg): void

Parameters​

NameTypeDescription
msgM3DMessage消息

Returns​

void

Description

推送消息，不需立即执行订阅者回调

refresh​

▸ refresh(): void

Returns​

void

Description

刷新场景

registerEvent​

▸ registerEvent(event): void

Parameters​

NameTypeDescription
eventM3DEventM3D事件

Returns​

void

Description

注册事件

Inherited from​

M3DObject.registerEvent

registerReaderEvent​

▸ registerReaderEvent(onBigin, onEnd, onCancle, onException, onProgress): void

Parameters​

NameTypeDescription
onBiginany开始事件，若不需要则为null
onEndany结束事件，若不需要则为null
onCancleany取消事件，若不需要则为null
onExceptionany异常事件，若不需要则为null
onProgressany进度事件，若不需要则为null

Returns​

void

Description

注册reader监听，整体打开监听

removeEvent​

▸ removeEvent(): void

Returns​

void

Description

删除事件

Inherited from​

M3DObject.removeEvent

removeFile​

▸ removeFile(...para): void

Parameters​

NameType
...paraany[]

Returns​

void

Description

移除文件

renderFrame​

▸ renderFrame(): void

Returns​

void

Description

渲染一帧

restoreView​

▸ restoreView(): void

Returns​

void

Description

重置场景到最初加载状态

save​

▸ save(...para): void

Parameters​

NameType
...paraany[]

Returns​

void

Description

保存

screenShots​

▸ screenShots(): string

Returns​

string

Description

快照

send​

▸ send(msg): void

Parameters​

NameTypeDescription
msgM3DMessage消息

Returns​

void

Description

发送消息，需立即执行订阅者回调方法

setAttributesMap​

▸ setAttributesMap(attributesMap): void

Parameters​

NameType
attributesMapMap<string, any>

Returns​

void

Description

设置属性Map

setAxis​

▸ setAxis(axis): void

Parameters​

NameType
axisAxis

Returns​

void

Description

设置坐标轴对象

setDrawMode​

▸ setDrawMode(drawModeType): void

Parameters​

NameType
drawModeTypenumber

Returns​

void

Description

设置渲染模式

setFileInfo​

▸ setFileInfo(info): void

Parameters​

NameType
infoInfo

Returns​

void

Description

设置文件信息

setFps​

▸ setFps(fps): void

Parameters​

NameType
fpsFPS

Returns​

void

Description

设置fps对象

setGluObj​

▸ setGluObj(glueObj): void

Parameters​

NameType
glueObjGlueObj

Returns​

void

setId​

▸ setId(v): void

Parameters​

NameTypeDescription
vnumberShapeId

Returns​

void

Description

设置id

Inherited from​

M3DObject.setId

setIsUpdateShadow​

▸ setIsUpdateShadow(val): void

Parameters​

NameType
valboolean

Returns​

void

Description

设置是否更新阴影

setLicenceOptionUserId​

▸ setLicenceOptionUserId(userId): void

Parameters​

NameType
userIdstring

Returns​

void

Description

设置许可userId

setModelIsVisible​

▸ setModelIsVisible(models, isVisible): void

Parameters​

NameType
modelsModel[]
isVisibleboolean

Returns​

void

Description

设置模型可见性

setName​

▸ setName(name): void

Parameters​

NameType
namestring

Returns​

void

Description

设置场景名称

setTopModel​

▸ setTopModel(topModel): void

Parameters​

NameType
topModelModel

Returns​

void

Description

设置顶级模型

setVisibleSetDirty​

▸ setVisibleSetDirty(dirty): void

Parameters​

NameType
dirtyboolean

Returns​

void

Description

获取场景可视化对象集是否为脏

Description

当该标识（VisiableSetDirty）为脏数据时，需要重新生成可视化对象集合

update​

▸ update(msg): void

Parameters​

NameType
msgM3DMessage

Returns​

void

Description

中转reader、render相关的消息给base层

updateFileCamera​

▸ updateFileCamera(viewport): void

Parameters​

NameType
viewportViewport

Returns​

void

Description

更新文件相机

updateUser​

▸ updateUser(user): void

Parameters​

NameType
userstring

Returns​

void

Description

更新许可用户id