Class UEViewer

Hierarchy

UEViewer

Index

Constructors

constructor

Methods

Constructors

constructor

new UEViewer(opts: UEOptions, viewer: Viewer): UEViewer

Parameters
- opts: UEOptions
- viewer: Viewer
Returns UEViewer

Properties

UETaskId

UETaskId: string

idMap

idMap: Map<string, string>

initOpt

initOpt: UEOptions

isOpenSameProj

isOpenSameProj: boolean

Optional loadingEle

loadingEle: HTMLDivElement

Optional loadingMsg

loadingMsg: HTMLDivElement

openId

openId: string

openMod

openMod: undefined | Mod

openType

openType: string

pingPongTimer

pingPongTimer: null | Timer

Optional resizeObserver

resizeObserver: () => void

Type declaration

- (): void
- Returns void

responseCode

responseCode: number

responseMsg

responseMsg: string

streamUrl

streamUrl: string

ueCameraChanged

ueCameraChanged: Event

ueClippingPlane

ueClippingPlane: UEClippingPlane

Optional ueContainer

ueContainer: HTMLDivElement

ueFreewalk

ueFreewalk: UEFreewalk

Optional ueIframe

ueIframe: HTMLIFrameElement

uePathRoaming

uePathRoaming: UEPathRoaming

viewer

viewer: Viewer

websocketUrl

websocketUrl: string

ws

ws: WebSocketService

Methods

Init

Init(cfg?: { openId: string; openType: string }): Promise<unknown>

Parameters
- Optional cfg: { openId: string; openType: string }
  - openId: string
  - openType: string
Returns Promise<unknown>

autoAdjustResolution

autoAdjustResolution(): void

Returns void

boxPick

boxPick(windowPosAry: [number, number][], near?: number, far?: number, isLeftToRightDrag?: boolean): Promise<PickRes[]>

Parameters
- windowPosAry: [number, number][]
- Optional near: number
- Optional far: number
- Optional isLeftToRightDrag: boolean
Returns Promise<PickRes[]>

captureImage

captureImage(): void

Returns void

close

close(): Promise<WSResponse>

Returns Promise<WSResponse>

closeProjs

closeProjs(): Promise<WSResponse>

Returns Promise<WSResponse>

deleteMod

deleteMod(mod: Mod): Promise<WSResponse>

Parameters
- mod: Mod
Returns Promise<WSResponse>

destroy

destroy(): void

Returns void

destroyEvt

destroyEvt(): void

Returns void

dispatchKeyboardEvt

dispatchKeyboardEvt(event: KeyboardEvent): void

Parameters
- event: KeyboardEvent
Returns void

drillPosition

drillPosition(windowPosition: { x: number; y: number }): Promise<undefined | Vector3[]>

Parameters
- windowPosition: { x: number; y: number }
  - x: number
  - y: number
Returns Promise<undefined | Vector3[]>

enableNotifyCameraChanged

enableNotifyCameraChanged(enableNotify: boolean): Promise<WSResponse>

Parameters
- enableNotify: boolean
Returns Promise<WSResponse>

getCesiumDom

getCesiumDom(): null | HTMLElement

Returns null | HTMLElement

getConfig

getConfig(): Promise<UEResourceResponse>

Returns Promise<UEResourceResponse>

getLocalModAry

getLocalModAry(): Promise<WSResponse>

Returns Promise<WSResponse>

getModProjProxyInfo

getModProjProxyInfo(modId: string): Promise<WSResponse>

Parameters
- modId: string
Returns Promise<WSResponse>

getPixelSize

getPixelSize(): Promise<WSResponse>

Returns Promise<WSResponse>

getViewPosition

getViewPosition(): Promise<undefined | ViewPosition>

Returns Promise<undefined | ViewPosition>

hideLoading

hideLoading(): void

Returns void

injectIframeEle

injectIframeEle(debug?: boolean): void

Parameters
- Optional debug: boolean
Returns void

msgToIframe

msgToIframe(type: string, data: {}): Promise<unknown>

Parameters
- type: string
- data: {}
  - [key: string]: any
Returns Promise<unknown>

offsetXYToUEOffsetXY

offsetXYToUEOffsetXY(offsetX: number, offsetY: number): Promise<undefined | Vector2>

Parameters
- offsetX: number
- offsetY: number
Returns Promise<undefined | Vector2>

open

open(): Promise<undefined | WSResponse>

Returns Promise<undefined | WSResponse>

pick

pick(windowPosition: { x: number; y: number }): Promise<undefined | PickRes>

Parameters
- windowPosition: { x: number; y: number }
  - x: number
  - y: number
Returns Promise<undefined | PickRes>

pickBillboard

pickBillboard(windowPosition: { x: number; y: number }): Promise<undefined | PickUEBillboardRes>

Parameters
- windowPosition: { x: number; y: number }
  - x: number
  - y: number
Returns Promise<undefined | PickUEBillboardRes>

pickPosition

pickPosition(windowPosition: { x: number; y: number }): Promise<undefined | Vector3>

Parameters
- windowPosition: { x: number; y: number }
  - x: number
  - y: number
Returns Promise<undefined | Vector3>

pingPong

pingPong(): Promise<WSResponse>

Returns Promise<WSResponse>

registerDestroyEvent

registerDestroyEvent(): void

Returns void

releaseUEResource

releaseUEResource(): void

Returns void

removeIframeEle

removeIframeEle(): void

Returns void

renderTag

renderTag(modTag: ModTagInstance): Promise<void | WSResponse>

Parameters
- modTag: ModTagInstance
Returns Promise<void | WSResponse>

resetDefaultColor

resetDefaultColor(target: Mod, isHighlight: boolean, oneBatch?: OneBatch, forceDeal?: boolean): Promise<undefined | WSResponse>

Parameters
- target: Mod
- isHighlight: boolean
- Optional oneBatch: OneBatch
- Optional forceDeal: boolean
Returns Promise<undefined | WSResponse>

setCameraTrack

setCameraTrack(cameraPosAry: { duration: number; name?: string; viewPosition: ViewPosition }[]): Promise<WSResponse>

Parameters
- cameraPosAry: { duration: number; name?: string; viewPosition: ViewPosition }[]
Returns Promise<WSResponse>

setColor

setColor(target: Mod, color: Color, isHighlight: boolean, oneBatch?: OneBatch, forceDeal?: boolean): Promise<undefined | WSResponse>

Parameters
- target: Mod
- color: Color
- isHighlight: boolean
- Optional oneBatch: OneBatch
- Optional forceDeal: boolean
Returns Promise<undefined | WSResponse>

setConfigs

setConfigs(cfg: { openId: string; openType: string }): void

Parameters
- cfg: { openId: string; openType: string }
  - openId: string
  - openType: string
Returns void

setKeyboardMode

setKeyboardMode(isEnableKeyboardMode: boolean, keyboardSpeed?: number): Promise<WSResponse>

Parameters
- isEnableKeyboardMode: boolean
- Optional keyboardSpeed: number
Returns Promise<WSResponse>

setPanRotateApplyType

setPanRotateApplyType(panKey?: string, rotateKey?: string): Promise<WSResponse>

Parameters
- Optional panKey: string
- Optional rotateKey: string
Returns Promise<WSResponse>

setResolution

setResolution(width: number, height: number, maxLimit?: boolean): Promise<undefined | WSResponse>

Parameters
- width: number
- height: number
- Optional maxLimit: boolean
Returns Promise<undefined | WSResponse>

setViewToBox

setViewToBox(box: [number, number, number, number, number, number], phi?: number, theta?: number): Promise<WSResponse>

Parameters
- box: [number, number, number, number, number, number]
- Optional phi: number
- Optional theta: number
Returns Promise<WSResponse>

setViewToPosition

setViewToPosition(pos: Vector3NumberAry, phi?: number, theta?: number, target?: Vector3NumberAry, duration?: number): Promise<WSResponse>

Parameters
- pos: Vector3NumberAry
- Optional phi: number
- Optional theta: number
- Optional target: Vector3NumberAry
- Optional duration: number
Returns Promise<WSResponse>

setVisibility

setVisibility(target: Mod, value: boolean, oneBatch?: OneBatch, forceDeal?: boolean): Promise<undefined | WSResponse>

Parameters
- target: Mod
- value: boolean
- Optional oneBatch: OneBatch
- Optional forceDeal: boolean
Returns Promise<undefined | WSResponse>

setWeatherTime

setWeatherTime(Weather?: ClearSky | Cloudy | Foggy | Overcast | PartlyCloudy | Rain | RainLight | RainThunderstorm | SandDustCalm | SandDustStorm | Snow | SnowBlizzard | SnowLight, timeOfDay?: number): Promise<WSResponse>

Parameters
- Optional Weather: ClearSky | Cloudy | Foggy | Overcast | PartlyCloudy | Rain | RainLight | RainThunderstorm | SandDustCalm | SandDustStorm | Snow | SnowBlizzard | SnowLight
- Optional timeOfDay: number
Returns Promise<WSResponse>

showCesiumDom

showCesiumDom(isShow: boolean): void

Parameters
- isShow: boolean
Returns void

showLoading

showLoading(msg?: string): void

Parameters
- Optional msg: string
Returns void

transferKeyboardEvt

transferKeyboardEvt(): void

Returns void

worldPtToScreenPt

worldPtToScreenPt(positionWC: Vector3): Promise<undefined | Vector2>

Parameters
- positionWC: Vector3
Returns Promise<undefined | Vector2>