deep-engine-demo/packages/docs/api/core/ViewerInstances.md

outline
2 3

ViewerInstances

• 源文件：packages/sdk/src/core/ViewerInstances.ts
• 文档位置：packages/docs/api/core/ViewerInstances.md

类：ViewerManager

• 作用：ViewerManager 类。

属性

属性名	可见性	类型	作用
viewers	public	Set<Viewer>	用于保存 viewers 对应的数据。
defaultViewer	public	Viewer | null	用于保存 defaultViewer 对应的数据。

方法

register(viewer: Viewer, makeDefault = false): void

• 作用：执行 register 相关逻辑。

• 入参：

参数名	类型	必填	说明
viewer	Viewer	是	关联的 Viewer 实例。
makeDefault	boolean	否	参数 makeDefault，类型为 boolean。

• 出参：void
• 返回说明：无返回值。

unregister(viewer: Viewer): void

• 作用：执行 unregister 相关逻辑。

• 入参：

参数名	类型	必填	说明
viewer	Viewer	是	关联的 Viewer 实例。

• 出参：void
• 返回说明：无返回值。

getDefault(): Viewer

• 作用：获取 Default。

• 入参：无

• 出参：Viewer

• 返回说明：返回 Viewer。

setDefault(viewer: Viewer): void

• 作用：设置 Default。

• 入参：

参数名	类型	必填	说明
viewer	Viewer	是	关联的 Viewer 实例。

• 出参：void
• 返回说明：无返回值。

getAll(): Viewer[]

• 作用：获取 All。

• 入参：无

• 出参：Viewer[]

• 返回说明：返回数组结果，元素类型为 Viewer。

构造示例

• 当前 Demo 中没有直接展示 ViewerManager 的构造调用。

函数示例

• 当前 Demo 中没有直接展示 ViewerManager 的公开方法调用。