Pointerra 3D Viewer JavaScript API
Options
All
  • Public
  • Public/Protected
  • All
Menu

api.scene

The scene namespace contains methods, properties, and events that relate to the 3D content of the viewer. The SceneAPI is likely to be the API that you use most often, particularly if you are needing to modify the content of the viewer, or programmatically control the camera or other aspects of the visualisation state.

You can modify multiple values of the scene state using the setProperties (and getProperties) methods, or you can use specific methods to change each property individually.

Hierarchy

  • SceneAPI

Index

Accessors

Methods

Object literals

Accessors

baseMapBrightness

  • get baseMapBrightness(): number
  • set baseMapBrightness(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

cameraData

  • Returns ICameraData

  • Parameters

    Returns void

canShowBaseMap

  • get canShowBaseMap(): boolean
  • set canShowBaseMap(show: boolean): void

  • Returns boolean

  • Parameters

    • show: boolean

    Returns void

colourBy

  • Returns ColourByType

  • Parameters

    Returns void

colourByOptions

  • get colourByOptions(): any

  • Returns any

heightMapRange

  • get heightMapRange(): MinMax
  • set heightMapRange(r: MinMax): void

  • Returns MinMax

  • Parameters

    • r: MinMax

    Returns void

horizontalCropBounds

  • get horizontalCropBounds(): LLRectangle
  • set horizontalCropBounds(rr: LLRectangle): void

  • Returns LLRectangle

  • Parameters

    • rr: LLRectangle

    Returns void

nearClip

  • get nearClip(): any
  • set nearClip(value: any): void

  • Returns any

  • Parameters

    • value: any

    Returns void

properties

showBaseMap

  • get showBaseMap(): boolean
  • set showBaseMap(val: boolean): void

  • Returns boolean

  • Parameters

    • val: boolean

    Returns void

useNearClip

  • get useNearClip(): boolean
  • set useNearClip(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

verticalCropBounds

  • get verticalCropBounds(): MinMax

  • Returns MinMax

viewExtents

  • get viewExtents(): ILatLonBoundingBox
  • set viewExtents(extents: ILatLonBoundingBox): void

  • Returns ILatLonBoundingBox

  • Parameters

    • extents: ILatLonBoundingBox

    Returns void

Methods

centerMap

  • centerMap(latlon: { latitude: any; longitude: any }): void

  • Parameters

    • latlon: { latitude: any; longitude: any }
      • latitude: any
      • longitude: any

    Returns void

clearVerticalCrop

  • clearVerticalCrop(): void

  • Returns void

createCrossSectionAtCoordinate

  • createCrossSectionAtCoordinate(center: ICartesianPoint, width: number, depth: number, rotationDegreesCcw: any, activateTool?: boolean): Promise<void>

  • Parameters

    • center: ICartesianPoint
    • width: number
    • depth: number
    • rotationDegreesCcw: any
    • Default value activateTool: boolean = false

    Returns Promise<void>

createPlanSectionAtCoordinate

  • createPlanSectionAtCoordinate(center: ICartesianPoint, depthNative: number, cameraFrustumWidthNative?: number, activateTool?: boolean): Promise<void>

  • Parameters

    • center: ICartesianPoint
    • depthNative: number
    • Default value cameraFrustumWidthNative: number = null
    • Default value activateTool: boolean = true

    Returns Promise<void>

disableAllClassifications

  • disableAllClassifications(): void

  • Returns void

enableAllClassifications

  • enableAllClassifications(): void

  • Returns void

endCrossSectionView

  • endCrossSectionView(): void

  • Returns void

enterOrthographicMode

  • Parameters

    Returns void

exitFixedCameraView

  • exitFixedCameraView(): void

  • Returns void

exitOrthographicMode

  • exitOrthographicMode(exitAll?: boolean, unwind?: boolean): void

  • Parameters

    • Default value exitAll: boolean = false
    • Default value unwind: boolean = true

    Returns void

exitPlanView

  • exitPlanView(): void

  • Returns void

getActiveLayers

  • getActiveLayers(): string[]

  • Returns string[]

getActiveScannerId

  • getActiveScannerId(): ScanId

  • Returns ScanId

getAllCameraData

  • Returns ICameraData

getAllDatasets

  • Returns an array of dataset information, null if the datasets plugin is not loaded.

    Returns DatasetInfo[]

getAutoPointSizingScale

  • getAutoPointSizingScale(): number

  • Returns number

getCameraData

  • Returns ICameraData

getClassNumbersDisabled

  • getClassNumbersDisabled(): number[]

  • Returns number[]

getClassNumbersEnabled

  • getClassNumbersEnabled(): number[]

  • Returns number[]

getClassificationData

getColourScanMarkersByHeight

  • getColourScanMarkersByHeight(): boolean

  • Returns boolean

getOrthographicModeOptions

getPointSizeMillimetres

  • getPointSizeMillimetres(): number

  • Returns number

getPointSizePixels

  • getPointSizePixels(): number

  • Returns number

getPointSizingMode

  • getPointSizingMode(): PointSizing

  • Returns PointSizing

getPointcloudOpacity

  • getPointcloudOpacity(): number

  • Returns the point cloud opacity (a percentage value [0,100])

    Returns number

getProperties

getScanFilterHeights

  • getScanFilterHeights(): { max: any; min: any }

  • Returns { max: any; min: any }

    • max: any
    • min: any

getViewExtents

  • getViewExtents(): ILatLonBoundingBox

  • Returns ILatLonBoundingBox

goToPlanView

  • Parameters

    Returns Promise<ILatLonBoundingBox>

goToTopDownView

  • goToTopDownView(coordinate?: ICartesianPoint): Promise<ILatLonBoundingBox>

  • Parameters

    Returns Promise<ILatLonBoundingBox>

isAutoPointSizeEnabled

  • isAutoPointSizeEnabled(): boolean

  • Returns boolean

isCameraPositionFixed

  • isCameraPositionFixed(): boolean

  • Returns boolean

isDatasetVisible

  • isDatasetVisible(datasetId: string): boolean

  • Parameters

    • datasetId: string

    Returns boolean

isEdgeEnhancementEnabled

  • isEdgeEnhancementEnabled(): boolean

  • Returns boolean

isIn3dOrthographicMode

  • isIn3dOrthographicMode(): boolean

  • Returns boolean

isInFreeRotateSectionMode

  • isInFreeRotateSectionMode(): boolean

  • Returns boolean

isInOrthographicMode

  • isInOrthographicMode(): boolean

  • Returns boolean

isInPlanSectionView

  • isInPlanSectionView(): boolean

  • Returns boolean

isInPlanView

  • isInPlanView(): boolean

  • Returns boolean

isInSectionView

  • isInSectionView(): boolean

  • Returns boolean

isPointcloudVisible

  • isPointcloudVisible(): boolean

  • Returns boolean

isSSAOEnabled

  • isSSAOEnabled(): boolean

  • Returns boolean

lookAt

  • lookAt(x: number, y: number, z: number, heading: number, pitch: number, range: number): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • heading: number
    • pitch: number
    • range: number

    Returns void

lookAtCoordinate

  • lookAtCoordinate(projectCoordinate: ICartesianPoint, heading: number, pitch: number, range: number): void

  • Parameters

    • projectCoordinate: ICartesianPoint
    • heading: number
    • pitch: number
    • range: number

    Returns void

lookAtWgs84

  • lookAtWgs84(wgs84Coordinate: IGeographicPoint, heading: number, pitch: number, range: number): void

  • Parameters

    Returns void

renderToImage

  • renderToImage(mimetype: any, size?: number, quality?: number): string

  • Parameters

    • mimetype: any
    • Default value size: number = 256
    • Default value quality: number = 0.8

    Returns string

requestScanStationView

  • requestScanStationView(scanId: string, desiredView?: {}): void

  • Parameters

    • scanId: string
    • Default value desiredView: {} = {}

    Returns void

resetClassificationColors

  • resetClassificationColors(): void

  • Returns void

resetLayerColors

  • resetLayerColors(): void

  • Returns void

resetPlanView

  • resetPlanView(): void

  • Returns void

resetSectionView

  • resetSectionView(): void

  • Returns void

resetToHomeView

  • resetToHomeView(fullReset?: boolean): void

  • Parameters

    • Default value fullReset: boolean = false

    Returns void

setAutoPointSizingScale

  • setAutoPointSizingScale(scale: number): void

  • Parameters

    • scale: number

    Returns void

setClassEnabled

  • setClassEnabled(id: any, isEnabled?: boolean): boolean

  • Parameters

    • id: any
    • Default value isEnabled: boolean = true

    Returns boolean

setClassNumberColor

  • setClassNumberColor(id: number, rgb: { b: number; g: number; r: number }): void

  • Parameters

    • id: number
    • rgb: { b: number; g: number; r: number }
      • b: number
      • g: number
      • r: number

    Returns void

setClassNumbersDisabled

  • setClassNumbersDisabled(ids: number[]): void

  • Parameters

    • ids: number[]

    Returns void

setClassNumbersEnabled

  • setClassNumbersEnabled(ids: number[]): void

  • Parameters

    • ids: number[]

    Returns void

setColourScanMarkersByHeight

  • setColourScanMarkersByHeight(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setContextMenuCallback

  • setContextMenuCallback(callback: any, append?: boolean): void

  • Parameters

    • callback: any
    • Default value append: boolean = false

    Returns void

setCrossSectionView

  • Parameters

    Returns void

setDatasetVisible

  • setDatasetVisible(datasetId: string, show: boolean): void

  • Parameters

    • datasetId: string
    • show: boolean

    Returns void

setEdgeEnhancement

  • setEdgeEnhancement(enabled: boolean): void

  • Parameters

    • enabled: boolean

    Returns void

setFixedCameraPosition

  • setFixedCameraPosition(pos: ICartesianPoint, options?: { heading: any; pitch: any }): Promise<void>

  • Parameters

    • pos: ICartesianPoint
    • Optional options: { heading: any; pitch: any }
      • heading: any
      • pitch: any

    Returns Promise<void>

setFixedCameraPositionXYZ

  • setFixedCameraPositionXYZ(x: any, y: any, z: any, options?: { heading: any; pitch: any }): void

  • Parameters

    • x: any
    • y: any
    • z: any
    • Optional options: { heading: any; pitch: any }
      • heading: any
      • pitch: any

    Returns void

setFocusPoint

  • Parameters

    • coordinate: ICartesianPoint

      project coordinate to make the new focus point. Pass in null to reset

    Returns void

setHeightMapRangeMax

  • setHeightMapRangeMax(v: number): void

  • Parameters

    • v: number

    Returns void

setHeightMapRangeMin

  • setHeightMapRangeMin(v: number): void

  • Parameters

    • v: number

    Returns void

setHomeView

  • setHomeView(): void

  • Save the current camera view as the home view

    Returns void

setHorizontalCropBearing

  • setHorizontalCropBearing(bearing: number): void

  • Parameters

    • bearing: number

    Returns void

setHorizontalCropBounds

  • setHorizontalCropBounds(rr: LLRectangle, updateSelection?: boolean): void

  • Parameters

    • rr: LLRectangle
    • Default value updateSelection: boolean = true

    Returns void

setHorizontalCropBoundsFromWgs84

  • setHorizontalCropBoundsFromWgs84(__namedParameters: { e: any; n: any; s: any; w: any }): void

  • Parameters

    • __namedParameters: { e: any; n: any; s: any; w: any }
      • e: any
      • n: any
      • s: any
      • w: any

    Returns void

setHorizontalCropFromCorridor

  • Parameters

    Returns Promise<void>

setLayerColors

  • setLayerColors(layerColors: [{ layerId: string; rgb: { b: number; g: number; r: number } }]): void

  • Parameters

    • layerColors: [{ layerId: string; rgb: { b: number; g: number; r: number } }]

    Returns void

setLayerVisibility

  • setLayerVisibility(layer_id: string, is_active: boolean): void

  • Parameters

    • layer_id: string
    • is_active: boolean

    Returns void

setPointSizeMillimetres

  • setPointSizeMillimetres(mm: number): void

  • Parameters

    • mm: number

    Returns void

setPointSizePixels

  • setPointSizePixels(size: number): void

  • Parameters

    • size: number

    Returns void

setPointSizingMode

  • setPointSizingMode(mode: PointSizing): void

  • Parameters

    • mode: PointSizing

    Returns void

setPointcloudBrightness

  • setPointcloudBrightness(brightness: number): void

  • Parameters

    • brightness: number

    Returns void

setPointcloudOpacity

  • setPointcloudOpacity(opacity: number): void

  • Parameters

    • opacity: number

      Percentage opaque [0,100]

    Returns void

setPointcloudVisible

  • setPointcloudVisible(show: boolean): void

  • Parameters

    • show: boolean

    Returns void

setProperties

  • Parameters

    Returns void

setSSAO

  • setSSAO(enabled: boolean): void

  • Parameters

    • enabled: boolean

    Returns void

setScanFilterMaxHeight

  • setScanFilterMaxHeight(h: number): void

  • Parameters

    • h: number

    Returns void

setScanFilterMinHeight

  • setScanFilterMinHeight(h: number): void

  • Parameters

    • h: number

    Returns void

setShowBaseMaps

  • setShowBaseMaps(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setVerticalCropBounds

  • setVerticalCropBounds(mm: MinMax, deactivateTool?: boolean, upVector?: Cartesian3, mmNative?: MinMax): void

  • Parameters

    • mm: MinMax
    • Default value deactivateTool: boolean = true
    • Default value upVector: Cartesian3 = null
    • Default value mmNative: MinMax = null

    Returns void

setVerticalCropLimits

  • setVerticalCropLimits(min: any, max: any, ll?: any, deactivateTool?: boolean): void

  • Parameters

    • min: any
    • max: any
    • Default value ll: any = null
    • Default value deactivateTool: boolean = true

    Returns void

setVerticalCropLimitsFromEcefPoint

  • setVerticalCropLimitsFromEcefPoint(min: any, max: any, point: any, deactivateTool?: boolean): void

  • Parameters

    • min: any
    • max: any
    • point: any
    • Default value deactivateTool: boolean = true

    Returns void

setViewExtents

  • setViewExtents(w: number, s: number, e: number, n: number): void

  • Parameters

    • w: number
    • s: number
    • e: number
    • n: number

    Returns void

setViewFromPointcloudBounds

  • setViewFromPointcloudBounds(): void

  • Returns void

setVisibleLayerIds

  • setVisibleLayerIds(layerList: string[]): void

  • Parameters

    • layerList: string[]

    Returns void

switchToOrthographicFrustum

  • switchToOrthographicFrustum(): void

  • Returns void

toggleDatasetVisibility

  • toggleDatasetVisibility(datasetId: string): void

  • Parameters

    • datasetId: string

    Returns void

toggleLayerVisibility

  • toggleLayerVisibility(layer_id: string): void

  • Parameters

    • layer_id: string

    Returns void

togglePointcloudVisibility

  • togglePointcloudVisibility(): void

  • Returns void

zoomToLayer

  • zoomToLayer(layerId: string): void

  • Parameters

    • layerId: string

    Returns void

Object literals

events

events: object

cameraChanged

cameraChanged: null = null

provides CameraData to the event listener

crossSectionModeChanged

crossSectionModeChanged: null = null

cursorChanged

cursorChanged: null = null

datasetLayerInitialised

datasetLayerInitialised: EventEmitter = new EventEmitter()

datasetsLoaded

datasetsLoaded: EventEmitter = new EventEmitter()

layersChanged

layersChanged: EventEmitter = new EventEmitter()

mouseClick

mouseClick: null = null

mouseDown

mouseDown: null = null

orthographicModeChanged

orthographicModeChanged: null = null

requestFocusPoint

requestFocusPoint: null = null

selectedPointsChanged

selectedPointsChanged: null = null

selectionRectangleChanged

selectionRectangleChanged: null = null

verticalCropChanged

verticalCropChanged: null = null