Class: Viewer

Defined in: packages/core/sdk/src/core/Viewer.ts:131

Constructors

Constructor

new Viewer(container, options?): Viewer

Defined in: packages/core/sdk/src/core/Viewer.ts:180

Parameters

container

string | HTMLDivElement

options?

IViewerOptions

Returns

Viewer

Properties

assetContainer

assetContainer: PlumAssetContainer

Defined in: packages/core/sdk/src/core/Viewer.ts:143

---

assetsManager

assetsManager: PlumAssetsManager

Defined in: packages/core/sdk/src/core/Viewer.ts:142

---

axesViewer?

optional axesViewer: AxesViewer

Defined in: packages/core/sdk/src/core/Viewer.ts:576

---

cameraControls

cameraControls: CameraControls

Defined in: packages/core/sdk/src/core/Viewer.ts:147

---

canvas

canvas: HTMLCanvasElement

Defined in: packages/core/sdk/src/core/Viewer.ts:134

---

container

container: HTMLElement

Defined in: packages/core/sdk/src/core/Viewer.ts:133

---

drawLine

drawLine: DrawLine

Defined in: packages/core/sdk/src/core/Viewer.ts:152

---

editor

editor: Editor

Defined in: packages/core/sdk/src/core/Viewer.ts:151

---

effectLayer

effectLayer: EffectLayer

Defined in: packages/core/sdk/src/core/Viewer.ts:150

---

engine

engine: AbstractEngine

Defined in: packages/core/sdk/src/core/Viewer.ts:137

---

environmentManage

environmentManage: EnvironmentManage

Defined in: packages/core/sdk/src/core/Viewer.ts:154

---

eventManager

eventManager: EventManager

Defined in: packages/core/sdk/src/core/Viewer.ts:146

---

gridTool

gridTool: GridTool

Defined in: packages/core/sdk/src/core/Viewer.ts:158

---

htmlMeshRenderer

htmlMeshRenderer: HtmlMeshRenderer = null

Defined in: packages/core/sdk/src/core/Viewer.ts:139

---

initComponentSubject

initComponentSubject: Subject<unknown>

Defined in: packages/core/sdk/src/core/Viewer.ts:163

---

initSubject

initSubject: Subject<unknown>

Defined in: packages/core/sdk/src/core/Viewer.ts:165

---

isInitDebugModule

isInitDebugModule: boolean = false

Defined in: packages/core/sdk/src/core/Viewer.ts:177

---

isLoad

isLoad: boolean = false

Defined in: packages/core/sdk/src/core/Viewer.ts:176

---

isWebGPU

isWebGPU: boolean = false

Defined in: packages/core/sdk/src/core/Viewer.ts:174

---

lightManager

lightManager: LightManager

Defined in: packages/core/sdk/src/core/Viewer.ts:148

---

options

options: IViewerOptions

Defined in: packages/core/sdk/src/core/Viewer.ts:172

---

ossApi

ossApi: OssApi = null

Defined in: packages/core/sdk/src/core/Viewer.ts:156

---

physics

physics: Physics

Defined in: packages/core/sdk/src/core/Viewer.ts:157

---

postProcessManager

postProcessManager: PlumPostProcessManager

Defined in: packages/core/sdk/src/core/Viewer.ts:149

---

scene

scene: PScene

Defined in: packages/core/sdk/src/core/Viewer.ts:138

---

sceneLoadProgressSubject

sceneLoadProgressSubject: Subject<ISceneLoadProgressEvent>

Defined in: packages/core/sdk/src/core/Viewer.ts:167

---

sceneSaveProgressSubject

sceneSaveProgressSubject: Subject<ISceneSaveProgressEvent>

Defined in: packages/core/sdk/src/core/Viewer.ts:169

---

serializer

serializer: Package = null

Defined in: packages/core/sdk/src/core/Viewer.ts:159

---

statistics

statistics: Statistics

Defined in: packages/core/sdk/src/core/Viewer.ts:153

Accessors

htmlMeshRendererEnabled

Set Signature

set htmlMeshRendererEnabled(value): void

Defined in: packages/core/sdk/src/core/Viewer.ts:229

启用/禁用 HTML 网格渲染器

Parameters

value

boolean

是否启用

Returns

void

---

useLogarithmicDepth

Get Signature

get useLogarithmicDepth(): boolean

Defined in: packages/core/sdk/src/core/Viewer.ts:213

Returns

boolean

Set Signature

set useLogarithmicDepth(value): void

Defined in: packages/core/sdk/src/core/Viewer.ts:217

Parameters

value

boolean

Returns

void

Methods

addNode()

addNode(node, recursive): void

Defined in: packages/core/sdk/src/core/Viewer.ts:510

添加节点。

Parameters

node

Node

节点。

recursive

boolean = true

是否递归添加子节点。

Returns

void

---

addParticle()

addParticle(option): any

Defined in: packages/core/sdk/src/core/Viewer.ts:594

Parameters

option

any

Returns

any

---

debug()

debug(debugOn, config): Promise<void>

Defined in: packages/core/sdk/src/core/Viewer.ts:395

开启调试模式

Parameters

debugOn

boolean = true

config

IInspectorOptions = ...

Returns

Promise<void>

---

debug1()

debug1(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:587

Returns

void

---

enableEditor()

enableEditor(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:384

启用编辑器

Returns

void

---

getNodeByName()

getNodeByName(name): Node

Defined in: packages/core/sdk/src/core/Viewer.ts:481

根据名称获取节点。

Parameters

name

string

节点的名称。

Returns

Node

具有指定名称的节点，如果未找到则返回 null。

---

getNodeByUniqueId()

getNodeByUniqueId(uniqueId): Node

Defined in: packages/core/sdk/src/core/Viewer.ts:455

根据唯一 ID 获取节点。

Parameters

uniqueId

number

节点的唯一 ID。

Returns

Node

具有指定唯一 ID 的节点，如果未找到则返回 null。

---

getSize()

getSize(): object

Defined in: packages/core/sdk/src/core/Viewer.ts:420

获取容器大小

Returns

object

height

height: number

width

width: number

---

initCanvas()

initCanvas(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:283

初始化画布

Returns

void

---

initComponent()

initComponent(): Promise<void>

Defined in: packages/core/sdk/src/core/Viewer.ts:298

初始化组件

Returns

Promise<void>

---

initContainer()

initContainer(container): void

Defined in: packages/core/sdk/src/core/Viewer.ts:264

初始化容器

Parameters

container

容器

string | HTMLDivElement

Returns

void

---

loadScene()

loadScene(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:437

初始化场景

Returns

void

---

removeNode()

removeNode(node, recursive): void

Defined in: packages/core/sdk/src/core/Viewer.ts:526

移除节点。

Parameters

node

Node

节点。

recursive

boolean = true

是否递归移除子节点。

Returns

void

---

resize()

resize(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:430

重置画布大小

Returns

void

---

run()

run(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:410

开始渲染

Returns

void

---

screenToWorld()

screenToWorld(point, z): Vector3

Defined in: packages/core/sdk/src/core/Viewer.ts:555

屏幕坐标转世界坐标

Parameters

point

MouseEvent

z

number = 0.99

Returns

Vector3

---

screenToWorldOrPick()

screenToWorldOrPick(event): Vector3

Defined in: packages/core/sdk/src/core/Viewer.ts:540

拾取或者屏幕坐标转世界坐标

Parameters

event

DragEvent

Returns

Vector3

---

setDefaultMaterial()

setDefaultMaterial(mesh): void

Defined in: packages/core/sdk/src/core/Viewer.ts:361

设置默认材质

Parameters

mesh

AbstractMesh

Returns

void

---

setInitState()

setInitState(): void

Defined in: packages/core/sdk/src/core/Viewer.ts:370

Returns

void

---

showAxesViewer()

showAxesViewer(show, scaleLines): void

Defined in: packages/core/sdk/src/core/Viewer.ts:578

Parameters

show

boolean = true

scaleLines

number = 10

Returns

void

---

create()

static create(container, options?): Promise<Viewer>

Defined in: packages/core/sdk/src/core/Viewer.ts:251

创建 Viewer

Parameters

container

容器

string | HTMLDivElement

options?

IViewerOptions

配置项

Returns

Promise<Viewer>