Skip to main content

Interface: SpatialConfiguration

component.SpatialConfiguration

Interface for configuration of spatial component.

interface

example

var viewer = new Viewer({    ...    component: {        spatial: {            cameraSize: 0.5,            cameraVisualizationMode: CameraVisualizationMode.Cluster,            cellsVisible: true,            originalPositionMode: OriginalPositionMode.Altitude,            pointSize: 0.5,            pointVisualizationMode: PointVisualizationMode.Hidden,        },    },    ...});

Hierarchy#

  • ComponentConfiguration

    ↳ SpatialConfiguration

Properties#

cameraSize#

• Optional cameraSize: number

The camera size on the interval [0.01, 1].

default 0.1

Defined in#

component/interfaces/SpatialConfiguration.ts:34


cameraVisualizationMode#

• Optional cameraVisualizationMode: CameraVisualizationMode

Specify the camera visualization mode.

default CameraVisualizationMode.Homogeneous

Defined in#

component/interfaces/SpatialConfiguration.ts:41


cellGridDepth#

• Optional cellGridDepth: number

Cell grid depth from the cell of the currently selected camera.

description Max value is 3. Value will be clamped to the interval [1, 3].

default 1

Defined in#

component/interfaces/SpatialConfiguration.ts:59


cellsVisible#

• Optional cellsVisible: boolean

Specify if the currently rendered cells should be visualize on an approximated ground plane.

default false

Defined in#

component/interfaces/SpatialConfiguration.ts:49


originalPositionMode#

• Optional originalPositionMode: OriginalPositionMode

Specify the original position visualization mode.

description The original positions are hidden by default.

default OriginalPositionMode.Hidden

Defined in#

component/interfaces/SpatialConfiguration.ts:69


pointSize#

• Optional pointSize: number

The point size on the interval [0.01, 1].

default 0.1

Defined in#

component/interfaces/SpatialConfiguration.ts:76


pointVisualizationMode#

• Optional pointVisualizationMode: PointVisualizationMode

Specify how point clouds should be visualized.

default PointVisualizationMode.Original

Defined in#

component/interfaces/SpatialConfiguration.ts:93


pointsVisible#

• Optional pointsVisible: boolean

Specify if the points should be visible or not.

deprecated pointsVisible will be removed in v5.x. Use pointVisualizationMode instead.

default true

Defined in#

component/interfaces/SpatialConfiguration.ts:86