Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Viewer

Hierarchy

  • Viewer

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

ERROR

ERROR: object = VIEWER_ERRORS

Type declaration

  • PIN_ID_TAKEN: string

Module

Module: any

account

account: any = null

avatarRadius

avatarRadius: number = 0.5

branch

branch: any = null

broadcastClippingPlane

broadcastClippingPlane: any

callback

callback: any

changeAvatarHeight

changeAvatarHeight: any

clickingEnabled

clickingEnabled: boolean = false

convertToM

convertToM: number = 1

currentNavMode

currentNavMode: any

currentViewpoint

currentViewpoint: any

defaultNavMode

defaultNavMode: string = Viewer.NAV_MODES.TURNTABLE

defaultShowAll

defaultShowAll: boolean = true

divId

divId: string = "unityViewer"

downloadsLeft

downloadsLeft: number = 1

element

element: HTMLElement

Private emitter

emitter: EventEmitter<string | symbol> = new EventEmitter()

errCallback

errCallback: any

fullscreen

fullscreen: boolean = false

groupNodes

groupNodes: any = null

handle

handle: any

initialized

initialized: boolean = false

inline

inline: any = null

inlineRoots

inlineRoots: object

Type declaration

lastMultipart

lastMultipart: any = null

logos

logos: any[] = []

measureMode

measureMode: boolean = false

model

model: any = null

modelString

modelString: any = null

multipartNodes

multipartNodes: any[] = []

multipartNodesByModel

multipartNodesByModel: object

Type declaration

name

name: string

nav

nav: any

numClips

numClips: any

oneGrpNodes

oneGrpNodes: any[] = []

options

options: any

pickObject

pickObject: object

Type declaration

pinDropMode

pinDropMode: boolean = false

pinSize

pinSize: number = 1

pinSizeFromSettings

pinSizeFromSettings: boolean = false

pins

pins: object

Type declaration

plugins

plugins: any

previousHighLightedPin

previousHighLightedPin: any = null

revision

revision: any = null

rootName

rootName: string = "model"

runtime

runtime: any = null

selectionDisabled

selectionDisabled: boolean = false

setSpeed

setSpeed: any

settings

settings: any

twoGrpNodes

twoGrpNodes: any[] = []

units

units: string = "m"

unityLoaderPath

unityLoaderPath: string = "unity/Build/UnityLoader.js"

unityLoaderReady

unityLoaderReady: boolean

unityLoaderScript

unityLoaderScript: any

viewer

viewer: HTMLElement

zFar

zFar: number = -1

zNear

zNear: number = -1

Static EVENT

EVENT: object = VIEWER_EVENTS

Type declaration

  • ADD_PIN: string
  • BACKGROUND_SELECTED: string
  • BACKGROUND_SELECTED_PIN_MODE: string
  • BBOX_READY: string
  • CLEAR_CLIPPING_PLANES: string
  • CLEAR_HIGHLIGHT_OBJECTS: string
  • CLICK_PIN: string
  • CLIPPING_PLANE_BROADCAST: string
  • CLIPPING_PLANE_READY: string
  • ENTER_VR: string
  • GET_CURRENT_OBJECT_STATUS: string
  • GET_CURRENT_VIEWPOINT: string
  • GET_SCREENSHOT: string
  • GO_HOME: string
  • HIGHLIGHT_OBJECTS: string
  • INITIALISE: string
  • LOADED: string
  • LOAD_MODEL: string
  • LOGO_CLICK: string
  • MEASURE_MODE_CLICK_POINT: string
  • MODEL_LOADED: string
  • MODEL_LOADING_CANCEL: string
  • MODEL_LOADING_PROGRESS: string
  • MODEL_LOADING_START: string
  • MOVE_PIN: string
  • MOVE_POINT: string
  • MULTI_OBJECTS_SELECTED: string
  • NAV_MODE_CHANGED: string
  • OBJECT_SELECTED: string
  • PICK_POINT: string
  • REGISTER_MOUSE_MOVE_CALLBACK: string
  • REGISTER_VIEWPOINT_CALLBACK: string
  • REMOVE_PIN: string
  • RUNTIME_READY: string
  • SET_CAMERA: string
  • SET_NAV_MODE: string
  • SET_PIN_VISIBILITY: string
  • START_LOADING: string
  • SWITCH_FULLSCREEN: string
  • SWITCH_OBJECT_VISIBILITY: string
  • TOGGLE_PANEL: string
  • UNHIGHLIGHT_OBJECTS: string
  • UNITY_ERROR: string
  • UNITY_READY: string
  • UPDATE_CLIPPING_PLANES: string
  • UPDATE_NUM_CLIP: string
  • VIEWER_INIT: string
  • VIEWER_INIT_FAILED: string
  • VIEWER_INIT_PROGRESS: string
  • VIEWER_INIT_SUCCESS: string
  • VR_READY: string

Static MAP_SOURCES

MAP_SOURCES: object = VIEWER_MAP_SOURCES

Type declaration

  • HERE: string
  • HERE_AERIAL: string
  • HERE_TRAFFIC: string
  • HERE_TRAFFIC_FLOW: string
  • OSM: string

Static NAV_MODES

NAV_MODES: object = VIEWER_NAV_MODES

Type declaration

  • HELICOPTER: string
  • TURNTABLE: string

Methods

addMapSource

  • addMapSource(source: any): void
  • Add map source

    Parameters

    • source: any

      Map source

    Returns void

addPin

  • addPin(account: any, model: any, id: any, type: any, position: any, norm: any, colours: any, viewpoint: any): void
  • Pins

    Parameters

    • account: any
    • model: any
    • id: any
    • type: any
    • position: any
    • norm: any
    • colours: any
    • viewpoint: any

    Returns void

backView

  • backView(): any

bottomView

  • bottomView(): any

cancelLoadModel

  • cancelLoadModel(): void

centreToPoint

  • centreToPoint(params: any): void

changePinColours

  • changePinColours(id: any, colours: any): void
  • Parameters

    • id: any
    • colours: any

    Returns void

clearHighlights

  • clearHighlights(): void

clipBroadcast

  • clipBroadcast(clip: any): void
  • Clipping planes

    Parameters

    • clip: any

    Returns void

destroy

  • destroy(): void

diffToolDiffView

  • diffToolDiffView(): void

diffToolDisableAndClear

  • diffToolDisableAndClear(): void

diffToolEnableWithClashMode

  • diffToolEnableWithClashMode(): void

diffToolEnableWithDiffMode

  • diffToolEnableWithDiffMode(): void

diffToolLoadComparator

  • diffToolLoadComparator(account: string, model: string, revision: string): any
  • Parameters

    • account: string
    • model: string
    • revision: string

    Returns any

diffToolSetAsComparator

  • diffToolSetAsComparator(account: string, model: string): void
  • Parameters

    • account: string
    • model: string

    Returns void

diffToolShowBaseModel

  • diffToolShowBaseModel(): void

diffToolShowComparatorModel

  • diffToolShowComparatorModel(): void

disableCaching

  • disableCaching(): void

disableShadows

  • disableShadows(): void

emit

  • emit(event: any, ...args: any[]): void
  • Parameters

    • event: any
    • Rest ...args: any[]

    Returns void

enableCaching

  • enableCaching(): void

enableHardShadows

  • enableHardShadows(): void

enableSoftShadows

  • enableSoftShadows(): void

frontView

  • frontView(): any

getCurrentViewpointInfo

  • getCurrentViewpointInfo(account: any, model: any): any
  • Parameters

    • account: any
    • model: any

    Returns any

getDefaultHighlightColor

  • getDefaultHighlightColor(): any

getNumPlanes

  • getNumPlanes(): any

getObjectsStatus

  • getObjectsStatus(account: any, model: any): any
  • Parameters

    • account: any
    • model: any

    Returns any

getScreenshot

  • getScreenshot(): any

handleError

  • handleError(message: any): void

helicopterSpeedDown

  • helicopterSpeedDown(): void

helicopterSpeedReset

  • helicopterSpeedReset(): void

helicopterSpeedUp

  • helicopterSpeedUp(): void

hideCoordView

  • hideCoordView(): void

hideHiddenByDefaultObjects

  • hideHiddenByDefaultObjects(): void

highlightObjects

  • highlightObjects(account: any, model: any, idsIn: any, zoom: any, colour: any, multiOverride: any, forceReHighlight: any): void
  • Parameters

    • account: any
    • model: any
    • idsIn: any
    • zoom: any
    • colour: any
    • multiOverride: any
    • forceReHighlight: any

    Returns void

highlightPin

  • highlightPin(id: any): void

init

  • init(options: any): Promise<Object>
  • Parameters

    • options: any

    Returns Promise<Object>

insertUnityLoader

  • insertUnityLoader(memory: any): Promise<void> | Promise<Object>
  • Parameters

    • memory: any

    Returns Promise<void> | Promise<Object>

isModelLoaded

  • isModelLoaded(): Promise<any>

leftView

  • leftView(): any

loadModel

  • loadModel(account: any, model: any, branch: any, revision: any): Promise<any>
  • Parameters

    • account: any
    • model: any
    • branch: any
    • revision: any

    Returns Promise<any>

mapInitialise

  • mapInitialise(surveyPoints: any): void
  • Initialise map creator within unity

    Parameters

    • surveyPoints: any

      array of survey points and it's respective latitude and longitude value

    Returns void

mapStart

  • mapStart(): void

mapStop

  • mapStop(): void

navMethodChanged

  • navMethodChanged(newNavMode: any): void
  • Parameters

    • newNavMode: any

    Returns void

numClipPlanesUpdated

  • numClipPlanesUpdated(nPlanes: any): void

objectSelected

  • objectSelected(pointInfo: any): void
  • Parameters

    • pointInfo: any

    Returns void

objectsSelected

  • objectsSelected(nodes: any): void

off

  • off(event: any, ...args: any[]): void
  • Parameters

    • event: any
    • Rest ...args: any[]

    Returns void

on

  • on(event: any, fn: any, ...args: any[]): void
  • Parameters

    • event: any
    • fn: any
    • Rest ...args: any[]

    Returns void

onModelProgress

  • onModelProgress(progress: any): void

onUnityProgress

  • onUnityProgress(progress: any): void

once

  • once(event: any, fn: any, ...args: any[]): void
  • Parameters

    • event: any
    • fn: any
    • Rest ...args: any[]

    Returns void

overrideMeshColor

  • overrideMeshColor(account: any, model: any, meshIDs: any, color: any): void
  • Parameters

    • account: any
    • model: any
    • meshIDs: any
    • color: any

    Returns void

pauseRendering

  • pauseRendering(): void

pickPointEvent

  • pickPointEvent(pointInfo: any): void
  • Parameters

    • pointInfo: any

    Returns void

removeMapSource

  • removeMapSource(source: any): void
  • Remove map source

    Parameters

    • source: any

      Map source

    Returns void

removePin

  • removePin(id: any): void

reset

  • reset(): void

resetMapSources

  • resetMapSources(): void

resetMeshColor

  • resetMeshColor(account: any, model: any, meshIDs: any): void
  • Parameters

    • account: any
    • model: any
    • meshIDs: any

    Returns void

resumeRendering

  • resumeRendering(): void

rightView

  • rightView(): any

selectPin

  • selectPin(id: any): void

setCamera

  • setCamera(pos: any, viewDir: any, upDir: any, lookAt: any, animate: any, rollerCoasterMode: any, account: any, model: any): void
  • Parameters

    • pos: any
    • viewDir: any
    • upDir: any
    • lookAt: any
    • animate: any
    • rollerCoasterMode: any
    • account: any
    • model: any

    Returns void

setDefaultNearPlane

  • setDefaultNearPlane(nearplane: number): void
  • Parameters

    • nearplane: number

    Returns void

setFarPlaneSampleSize

  • setFarPlaneSampleSize(farplaneSample: number): void
  • Parameters

    • farplaneSample: number

    Returns void

setHandle

  • setHandle(handle: any): void

setMaxShadowDistance

  • setMaxShadowDistance(value: number): void

setMeasureMode

  • setMeasureMode(on: boolean): void

setNavMode

  • setNavMode(mode: any, force: any): void
  • Parameters

    • mode: any
    • force: any

    Returns void

setNumCacheThreads

  • setNumCacheThreads(value: number): void

setPinDropMode

  • setPinDropMode(on: boolean): void

setRenderingQualityDefault

  • setRenderingQualityDefault(): void

setRenderingQualityHigh

  • setRenderingQualityHigh(): void

setUnits

  • setUnits(units: any): void

setUnity

  • setUnity(): void

setXRayHighlightOff

  • setXRayHighlightOff(): void

setXRayHighlightOn

  • setXRayHighlightOn(): void

showAll

  • showAll(): void

showCoordView

  • showCoordView(): void

showHiddenByDefaultObjects

  • showHiddenByDefaultObjects(): void

startAreaSelect

  • startAreaSelect(): void

startBoxClip

  • startBoxClip(): void

startClipEdit

  • startClipEdit(): void

startSingleClip

  • startSingleClip(): void

stopAreaSelect

  • stopAreaSelect(): void

stopClipEdit

  • stopClipEdit(): void

switchFullScreen

  • switchFullScreen(vrDisplay: any): void
  • Parameters

    • vrDisplay: any

    Returns void

switchObjectVisibility

  • switchObjectVisibility(account: any, model: any, ids: any, visibility: any): void
  • Parameters

    • account: any
    • model: any
    • ids: any
    • visibility: any

    Returns void

toggleStats

  • toggleStats(): void

topView

  • topView(): void

unhighlightObjects

  • unhighlightObjects(account: any, model: any, idsIn: any): void
  • Parameters

    • account: any
    • model: any
    • idsIn: any

    Returns void

updateCamera

  • updateCamera(pos: any, up: any, viewDir: any, lookAt: any, animate: any, rollerCoasterMode: any, account: any, model: any): void
  • Parameters

    • pos: any
    • up: any
    • viewDir: any
    • lookAt: any
    • animate: any
    • rollerCoasterMode: any
    • account: any
    • model: any

    Returns void

updateClippingPlanes

  • updateClippingPlanes(clipPlanes: any, account: any, model: any): void
  • Parameters

    • clipPlanes: any
    • account: any
    • model: any

    Returns void

updateSettings

  • updateSettings(settings: any): void

useBoundingBoxFarPlaneAlgorithm

  • useBoundingBoxFarPlaneAlgorithm(): void

useBoundingSphereFarPlaneAlgorithm

  • useBoundingSphereFarPlaneAlgorithm(): void

zoomToHighlightedMeshes

  • zoomToHighlightedMeshes(): void

zoomToObjects

  • zoomToObjects(meshes: any): void

Generated using TypeDoc