Class GLViewer

Three.js 3D 场景视图类

Hierarchy (View Summary)

BaseViewer
- GLViewer

Index

Constructors

constructor

new GLViewer(
container?: string | HTMLElement,
options?: ViewerOptions,
): GLViewer
构造函数
Parameters
- Optionalcontainer: string | HTMLElement
  容器元素或 CSS 选择器
- options: ViewerOptions = {}
  视图选项
Returns GLViewer
Inherited from BaseViewer.constructor
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:86

Properties

`Readonly`ambLight

ambLight: AmbientLight

环境光

`Readonly`camera

camera: PerspectiveCamera

透视相机

`Optional`container

container?: HTMLElement

挂载容器元素

controls

controls: TileMapControls = ...

瓦片地图轨道控制器

`Readonly`dirLight

dirLight: DirectionalLight

平行光

`Readonly`renderer

renderer: WebGLRenderer

WebGL 渲染器

`Readonly`scene

scene: Scene

主场景

`Readonly`timer

timer: Timer = ...

帧计时器，用于计算每帧间隔时间

`Readonly`topScenes

topScenes: Scene[] = []

顶层覆盖场景列表（渲染在主场景之上）

Accessors

controlsMode

get controlsMode(): "MAP" | "ORBIT"
获取当前控制器模式：MAP（地图模式）或 ORBIT（轨道模式）

Returns "MAP" | "ORBIT"
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:41
set controlsMode(value: "MAP" | "ORBIT"): void
设置控制器模式
Parameters
- value: "MAP" | "ORBIT"
Returns void
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:45

flying

get flying(): boolean
是否正在飞行

Returns boolean
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:25

fogFactor

get fogFactor(): number
获取雾密度系数

Returns number
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:30
set fogFactor(value: number): void
设置雾密度系数，默认值 1
Parameters
- value: number
Returns void
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:35

height

get height(): number
容器高度

Returns number
Inherited from BaseViewer.height
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:77

width

get width(): number
容器宽度

Returns number
Inherited from BaseViewer.width
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:72

Methods

addEventListener

addEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, GLViewer>,
): void
Adds a listener to an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ViewerEventMap[T], T, GLViewer>
  The function that gets called when the event is fired.
Returns void
Inherited from BaseViewer.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

addTo

addTo(container: string | HTMLElement): GLViewer
将渲染器添加到容器中
Parameters
- container: string | HTMLElement
  容器元素或 CSS 选择器
Returns GLViewer
this
Inherited from BaseViewer.addTo
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:108

animate

animate(): void
Three.js 动画循环

Returns void
Overrides BaseViewer.animate
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:81

`Protected`createAmbLight

createAmbLight(): AmbientLight
创建环境光

Returns AmbientLight
环境光
Inherited from BaseViewer.createAmbLight
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:168

`Protected`createCamera

createCamera(): PerspectiveCamera
创建透视相机

Returns PerspectiveCamera
相机
Inherited from BaseViewer.createCamera
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:158

`Protected`createDirLight

createDirLight(): DirectionalLight
创建平行光

Returns DirectionalLight
平行光
Inherited from BaseViewer.createDirLight
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:177

`Protected`createRenderer

createRenderer(
    antialias: boolean,
    stencil: boolean,
    logarithmicDepthBuffer: boolean,
): WebGLRenderer
创建 WebGL 渲染器
Parameters
- antialias: boolean
  是否抗锯齿
- stencil: boolean
  是否使用模板缓冲
- logarithmicDepthBuffer: boolean
  是否使用对数深度缓冲
Returns WebGLRenderer
渲染器
Inherited from BaseViewer.createRenderer
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:140

`Protected`createScene

createScene(): Scene
创建主场景

Returns Scene
场景
Inherited from BaseViewer.createScene
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:125

dispatchEvent

dispatchEvent<T extends keyof ViewerEventMap>(
event: BaseEvent<T> & ViewerEventMap[T],
): void
Fire an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- event: BaseEvent<T> & ViewerEventMap[T]
  The event that gets fired.
Returns void
Inherited from BaseViewer.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

dispose(): void
清理资源

Returns void
Overrides BaseViewer.dispose
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:73

flyTo

flyTo(
    centerPosition: Vector3,
    cameraPosition: Vector3,
    animate?: boolean,
): Promise<void>
飞行到指定位置
Parameters
- centerPosition: Vector3
  地图中心目标位置（世界坐标）
- cameraPosition: Vector3
  相机目标位置（世界坐标）
- animate: boolean = true
  是否使用动画
Returns Promise<void>
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:92

flyToObject

flyToObject(
    object: Object3D,
    offset?: {
        animate?: boolean;
        azimuthDeg?: number;
        distanceMultiplier?: number;
        pitchDeg?: number;
    },
): Promise<void>
飞行到指定对象的位置
Parameters
- object: Object3D
  目标对象，相机将飞向该对象
- offset: {
      animate?: boolean;
      azimuthDeg?: number;
      distanceMultiplier?: number;
      pitchDeg?: number;
  } = ...
  相机位置的偏移参数
  - Optionalanimate?: boolean
    是否使用动画效果飞行，默认值为 true
  - OptionalazimuthDeg?: number
    方位角，单位为度，默认值为 0
  - OptionaldistanceMultiplier?: number
    距离乘数，用于调整相机与对象的距离，默认值为 1.2
  - OptionalpitchDeg?: number
    俯仰角，单位为度，默认值为 30
Returns Promise<void>
一个 Promise，在飞行完成时 resolve
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:129

getState

getState(): { cameraPosition: Vector3; centerPosition: Vector3 }
获取当前场景状态

Returns { cameraPosition: Vector3; centerPosition: Vector3 }
中心位置和相机位置
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:197

hasEventListener

hasEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, GLViewer>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ViewerEventMap[T], T, GLViewer>
  The function that gets called when the event is fired.
Returns boolean
Inherited from BaseViewer.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

removeEventListener

removeEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, GLViewer>,
): void
Removes a listener from an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<ViewerEventMap[T], T, GLViewer>
  The listener function that gets removed.
Returns void
Inherited from BaseViewer.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

resize

resize(): GLViewer
容器大小变化处理

Returns GLViewer
this
Inherited from BaseViewer.resize
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:188

`Protected`update

update(): void
渲染一帧（主场景 + 覆盖场景）

Returns void
Inherited from BaseViewer.update
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:216

Class GLViewer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GLViewer

Properties

ReadonlyambLight

Readonlycamera

Optionalcontainer

controls

ReadonlydirLight

Readonlyrenderer

Readonlyscene

Readonlytimer

ReadonlytopScenes

Accessors

controlsMode

Returns "MAP" | "ORBIT"

Parameters

Returns void

flying

Returns boolean

fogFactor

Returns number

Parameters

Returns void

height

Returns number

width

Returns number

Methods

addEventListener

Type Parameters

Parameters

Returns void

addTo

Parameters

Returns GLViewer

animate

Returns void

ProtectedcreateAmbLight

Returns AmbientLight

ProtectedcreateCamera

Returns PerspectiveCamera

ProtectedcreateDirLight

Returns DirectionalLight

ProtectedcreateRenderer

Parameters

Returns WebGLRenderer

ProtectedcreateScene

Returns Scene

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

flyTo

Parameters

Returns Promise<void>

flyToObject

Parameters

Optionalanimate?: boolean

OptionalazimuthDeg?: number

OptionaldistanceMultiplier?: number

OptionalpitchDeg?: number

Returns Promise<void>

getState

Returns { cameraPosition: Vector3; centerPosition: Vector3 }

hasEventListener

Type Parameters

Parameters

Returns boolean

removeEventListener

`Readonly`ambLight

`Readonly`camera

`Optional`container

`Readonly`dirLight

`Readonly`renderer

`Readonly`scene

`Readonly`timer

`Readonly`topScenes

`Protected`createAmbLight

`Protected`createCamera

`Protected`createDirLight

`Protected`createRenderer

`Protected`createScene

`Optional`animate?: boolean

`Optional`azimuthDeg?: number

`Optional`distanceMultiplier?: number

`Optional`pitchDeg?: number

`Protected`update