Class: DisplayQuality

Extends

• vcs.vcm.widgets.Widget

Members

active{boolean}

activePreset{Object}

An object with a 'preset' key representing the name of the active preset

className{string}

class Name of the Object

initialized{boolean}

layers{Array.<vcs.vcm.widgets.DisplayQuality.LayerModel>}

The layers managed by this widget

name{string}

unique Name

viewModel{vcs.vcm.widgets.DisplayQuality.ViewModel} {null}

The current view model

Methods

getClassName(){string} inherited

returns the class name of this object.

Deprecated

• Yes

Returns:

className

getConfigObject(){Object} inherited

getId(){string} inherited

returns the id of this object

Deprecated

• Yes

getName(){string} inherited

returns the name of the Object, the name is either given by the config Object or a uuid is generated

Deprecated

• Yes

getSupportedMaps(){Array.<string>} inherited

Returns the widgets supported maps

isActive(){boolean} inherited

returns the active state of the widget

Deprecated

• v3.6 use the property active directly

Returns:

state of the widget

isInitialized(){boolean} inherited

checks if the Widget is already initialized

Deprecated

• Yes

Returns:

true if all requirements are there

isSupported(map){boolean} inherited

returns true if this widget supports the given map. Should be overriden by the widget

Name	Type	Description
map	string | vcs.vcm.maps.Map	the map or className to check for support

setLayerQuality(layerName)

Sets the screen space error for a layer

Name	Type	Description
layerName	string	the layer to set the screen space error for

Throws:

vcs.vcm.util.InvalidArgument

setPreset(presetName)

Uses a preset to set the view model

Name	Type	Description
presetName	string	a valid preset name 'low', 'medium' or 'high'

Throws:

vcs.vcm.util.InvalidArgument

setQuality(isPreset)

Sets the quality of this.viewModel to the cesium map. Does not affect layers

Name	Type	Description
isPreset	boolean	whether this is set using a preset or not

Throws:

vcs.vcm.util.InvalidArgument

Type Definitions

vcs.vcm.widgets.DisplayQuality.LayerModel{Object}

Properties:

Name	Type	Description
layerName	string
defaultSse	number
sse	number

vcs.vcm.widgets.DisplayQuality.ViewModel{Object}

Properties:

Name	Type	Description
sse	number
fxaa	boolean
fog	Cesium.Fog
resolutionScale	number
layerSSEFactor	number | undefined