Class GLViewer

Threejs scene initialize class

Hierarchy (View Summary)

BaseViewer
- GLViewer

Index

Constructors

constructor

new GLViewer(
container?: string | HTMLElement,
options?: ViewerOptions,
): GLViewer
Constructor
Parameters
- Optionalcontainer: string | HTMLElement
  container element or selector string
- options: ViewerOptions = {}
  GLViewer options
Returns GLViewer
Inherited from BaseViewer.constructor
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:75

Properties

`Readonly`ambLight

ambLight: AmbientLight

`Readonly`camera

camera: PerspectiveCamera

`Readonly`clock

clock: Clock = ...

`Optional`container

container?: HTMLElement

controls

controls: TileMapControls = ...

`Readonly`dirLight

dirLight: DirectionalLight

`Readonly`renderer

renderer: WebGLRenderer

`Readonly`scene

scene: Scene

`Readonly`topScenes

topScenes: Scene[] = []

Accessors

controlsMode

get controlsMode(): "MAP" | "ORBIT"
Returns "MAP" | "ORBIT"
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:32
set controlsMode(value: "MAP" | "ORBIT"): void
Parameters
- value: "MAP" | "ORBIT"
Returns void
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:35

fogFactor

get fogFactor(): number
Get fog factor

Returns number
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:22
set fogFactor(value: number): void
Set fog factor, default 1
Parameters
- value: number
Returns void
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:27

height

get height(): number
Container height

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

width

get width(): number
Container width

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

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
Add the renderer to a container
Parameters
- container: string | HTMLElement
  container element or selector string
Returns GLViewer
this
Inherited from BaseViewer.addTo
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:98

animate

animate(): void
Threejs animation loop

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

`Protected`createAmbLight

createAmbLight(): AmbientLight
Create ambient light

Returns AmbientLight
AmbientLight
Inherited from BaseViewer.createAmbLight
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:157

`Protected`createCamera

createCamera(): PerspectiveCamera
Create camera

Returns PerspectiveCamera
camera
Inherited from BaseViewer.createCamera
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:147

`Protected`createDirLight

createDirLight(): DirectionalLight
Create directional light

Returns DirectionalLight
DirectionalLight
Inherited from BaseViewer.createDirLight
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:166

`Protected`createRenderer

createRenderer(
    antialias: boolean,
    stencil: boolean,
    logarithmicDepthBuffer: boolean,
): WebGLRenderer
Create WebGL renderer
Parameters
- antialias: boolean
- stencil: boolean
- logarithmicDepthBuffer: boolean
Returns WebGLRenderer
renderer
Inherited from BaseViewer.createRenderer
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:129

`Protected`createScene

createScene(): Scene
Create scene

Returns Scene
scene
Inherited from BaseViewer.createScene
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:114

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

flyTo

flyTo(
    centerPostion: Vector3,
    cameraPostion: Vector3,
    animate?: boolean,
): Promise<void>
Fly to a position
Parameters
- centerPostion: Vector3
  Map center target position (world coordinate)
- cameraPostion: Vector3
  Camera target position (world coordinate)
- animate: boolean = true
  animate or not
Returns Promise<void>
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:71

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:105

getState

getState(): { cameraPosition: Vector3; centerPosition: Vector3 }
Get current scens state

Returns { cameraPosition: Vector3; centerPosition: Vector3 }
center position and camera position
- Defined in packages/plugin/src/GLViewer/GLViewer.ts:168

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
Container resize

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

`Protected`update

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

Class GLViewer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GLViewer

Properties

ReadonlyambLight

Readonlycamera

Readonlyclock

Optionalcontainer

controls

ReadonlydirLight

Readonlyrenderer

Readonlyscene

ReadonlytopScenes

Accessors

controlsMode

Returns "MAP" | "ORBIT"

Parameters

Returns void

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

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

Type Parameters

Parameters

Returns void

resize

`Readonly`ambLight

`Readonly`camera

`Readonly`clock

`Optional`container

`Readonly`dirLight

`Readonly`renderer

`Readonly`scene

`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