ViewerSettingStrings¶

Enumeration ViewerSettingStrings

This enum contains all the setting keys that are used to read, change and reset the settings of a specific viewer. For every setting key, its default value can be found here, as well as the type of the value.

Please note, that a list of general, webvis context related settings can be found in the SettingStrings enum.

Furthermore, please notice the difference between context and viewer level settings, as described in the ViewerAPI.

Example

webvis.getContext().getViewer().changeSetting(webvis.ViewerSettingStrings.AA_SETTING_ENABLED, true);
webvis.getContext().getViewer().readSetting(webvis.ViewerSettingStrings.CAMERA_FIELD_OF_VIEW);
webvis.getContext().getViewer().resetSetting(webvis.ViewerSettingStrings.BACKGROUND_COLOR);
Index

Enumeration Members

AA_SETTING_ENABLED BACKGROUND_COLOR BUDGETING_MODE BUDGETING_TARGET_FRAMERATE CAMERA_FIELD_OF_VIEW CAPPING_EFFECT_EDGE_COLOR CAPPING_EFFECT_ENABLED CAPPING_EFFECT_INNER_COLOR COLOR_COMPARISON_FIRST_COLOR COLOR_COMPARISON_MATCHING_COLOR COLOR_COMPARISON_SECOND_COLOR COLORIZE_EFFECT_ENABLED COORDINATE_SYSTEM DISABLE_SPECULAR_HIGHLIGHT DOUBLE_CLICK_ANIMATION_VOLUME_SCALE DOUBLE_CLICK_TIME_WINDOW DRAWING_ARROWHEAD_END DRAWING_ARROWHEAD_START DRAWING_COLOR DRAWING_MODE DRAWING_SIZE DYNAMIC_AUX_CONTRAST_ENABLED DYNAMIC_CLIPPING_DISTANCE DYNAMIC_CLIPPING_ENABLED DYNAMIC_COR_ENABLED EXPAND_ON_VIEWER_SELECTION FACE_HIGHLIGHT_COLOR FACE_SELECTION_COLOR FIT_VIEW_FACTOR FLY_NAVIGATION_SPEED FLYTO_ON_DOUBLECLICK_ENABLED FOCUS_ON_DOUBLE_CLICK FRUSTUM_CULLING GHOSTED_SCENE_OPACITY GIZMO_AXIS_LABELS_ENABLED GIZMO_SCALING_FACTOR GIZMOS_ENABLED GPU_MEMORY_RELEASE_FACTOR HOVER_COLOR INIT_VIEW INITIAL_FIT INITIAL_FIT_DIRECTION INVERT_ZOOM_DIRECTION LIGHTING_ENVIRONMENT LINE_HIGHLIGHT_COLOR LINE_SELECTION_COLOR MAX_DYNAMIC_CLIP_DIST MAX_GPU_MEMORY MAX_SRC_MEMORY NAVIGATION_MODE NAVIGATION_SAMPLING NAVIGATION_SPEED_FACTOR NAVIGATION_SPEED_THROTTLE_FACTOR OUTLINE_COLOR OUTLINE_COLOR_OCCLUDED OUTLINE_INNER_RADIUS OUTLINE_OUTER_RADIUS PRE_SELECTION_COLOR PROJECTION_TYPE RENDER_AUXILIARY_ON_TOP RENDER_MODE RENDER_SETUP SCENE_OPACITY SCREEN_SPACE_COVERAGE_CALCULATION_METHOD SELECTION_COLOR SHOW_AUX_ON_NAVIGATION SILHOUETTE_EFFECT_COLOR SILHOUETTE_EFFECT_ENABLED SILHOUETTE_EFFECT_EXCLUSIVE_ENABLED SMALL_FEATURE_CULLING SMALL_FEATURE_PIXEL_THRESHOLD SOFTWAR_OCCLUSION_CULLING SPACEMOUSE_MULTIPLIER SSAO_ENABLED TAA_ENABLED TOPO_GEOMETRY_COLOR TOPO_GEOMETRY_SECONDARY_COLOR TOPO_POINTS_ENABLED TRANSPARENCY_MODE TURNTABLE_LOWER_VERTICAL_LIMIT TURNTABLE_UPPER_VERTICAL_LIMIT TURNTABLE_VERTICAL_LIMITS_ENABLED USE_DEVICE_PIXEL_RATIO VERTEX_COLORS_ENABLED VIEW_PERSPECTIVE WEBGL_PRESERVE_DRAWINGBUFFER

Enumeration Members

AA_SETTING_ENABLED: "aaSetting"

Defines whether the screen space anti-aliasing is enabled or not. Fast approximate anti-aliasing (FXAA) is used to smooth the edges of the rendered geometry. Compared to temporal anti-aliasing (TAA), FXAA has a lower quality but also a lower performance impact.

boolean

false

TAA_ENABLED for temporal anti-aliasing (TAA).

BACKGROUND_COLOR: "backgroundColor"

Defines the current background color.

string

urn:X-l3d:color:rgba:00000000

Property.APPEARANCE_URI for a definition of valid color strings.

BUDGETING_MODE: "budgetingMode"
    • Defines the budgeting mode used for rendering objects.

BudgetingMode *

BudgetingMode.STANDARD
   *
BUDGETING_TARGET_FRAMERATE: "budgetingTargetFramerate"

Defines the budgeting target framerate used for rendering objects. The viewer adjusts the rendering load to hit the specified target framerate.

number

20
CAMERA_FIELD_OF_VIEW: "defaultFieldOfView"

Defines the camera field of view in degrees.

number

45
CAPPING_EFFECT_EDGE_COLOR: "cappingEffectEdgeColor"

Defines the edge color of the capping effect.

string

urn:X-l3d:color:rgba:00000000
CAPPING_EFFECT_ENABLED: "cappingEffectEnabled"

Defines whether the capping effect is enabled or not.

This effect highlights the geometry at the position of a clipplane. This helps distinguishing between solid parts and true hollow spaces.

boolean

false

ClipPlaneAPI

CAPPING_EFFECT_INNER_COLOR: "cappingEffectInnerColor"

Defines the inner color of the capping effect.

string

urn:X-l3d:color:rgba:00000000
COLOR_COMPARISON_FIRST_COLOR: "colorComparisonFirstColor"

Defines the first color for the 3-color-comparison.

string

urn:X-l3d:color:rgb:aa0000
COLOR_COMPARISON_MATCHING_COLOR: "colorComparisonMatchingColor"

Defines the matching color for the 3-color-comparison.

string

urn:X-l3d:color:rgb:00aa00
COLOR_COMPARISON_SECOND_COLOR: "colorComparisonSecondColor"

Defines the second color for the 3-color-comparison.

string

urn:X-l3d:color:rgb:0000aa
COLORIZE_EFFECT_ENABLED: "colorizeEffect"

Defines whether the random colorize effect is enabled or not.

The random colorize effect applies a different color to every instance of resource. For monolithic models, you will only have one color. For models with linked parts, those linked parts will have different colors.

boolean

false

Property.NODE_REPRESENTATION

COORDINATE_SYSTEM: "coordSys"

Defines the front plane of the model for use with the UI elements.

Please use the SettingStrings.FRONT_PLANE_AXIS setting with the SettingsAPI.changeSetting function of the ContextAPI instead.

FrontPlaneAxis

DISABLE_SPECULAR_HIGHLIGHT: "disableSpecularHighlights"

Defines whether a viewer shows specular highlighting or not.

boolean

false
DOUBLE_CLICK_ANIMATION_VOLUME_SCALE: "doubleClickAnimationVolumeScale"

Defines the factor by which volumes are scaled with during double-click animations, affecting the zoom level and the area that the camera will focus on.

This setting only has an effect if either FOCUS_ON_DOUBLE_CLICK or FLYTO_ON_DOUBLECLICK_ENABLED is set to true.

number

1.6
DOUBLE_CLICK_TIME_WINDOW: "doubleClickTimeWindow"

Defines the time window for a double-click in milliseconds.

number

250
DRAWING_ARROWHEAD_END: "drawingArrowheadEnd"

Defines the arrow head at the end of a drawing.

DrawingArrowhead

DrawingArrowhead.NONE
DRAWING_ARROWHEAD_START: "drawingArrowheadStart"

Defines the arrow head at the start of a drawing.

DrawingArrowhead

DrawingArrowhead.NONE
DRAWING_COLOR: "drawingColor"

Defines the drawing color.

string

urn:X-l3d:color:rgb:00b0ff
DRAWING_MODE: "drawingMode"

Defines the drawing mode.

DrawingMode

DrawingMode.BRUSH

ViewerDrawingAPI

DRAWING_SIZE: "drawingSize"

Defines the drawing size in pixels.

Please note that we always add 2 pixels to the drawing size.

number

6

ViewerDrawingAPI

DYNAMIC_AUX_CONTRAST_ENABLED: "dynamicAuxContrastEnabled"

Defines whether the dynamic contrast for auxiliary geometries is enabled or not. If enabled, this will change the color of AUX nodes based on the contrast with the background for better legibility.

boolean

false

NodeType.AUX

DYNAMIC_CLIPPING_DISTANCE: "dynamicClippingDistance"

Defines the dynamic clipping distance in meters. Every part that is closer to the camera then this value will be clipped.

number

5

DYNAMIC_CLIPPING_ENABLED

DYNAMIC_CLIPPING_ENABLED: "dynamicClippingEnabled"

Defines whether dynamic clipping is enabled or not. Every part that is closer to the camera than the value defined in DYNAMIC_CLIPPING_DISTANCE will be clipped.

boolean

false

DYNAMIC_CLIPPING_DISTANCE

DYNAMIC_COR_ENABLED: "dynamicCOREnabled"

Defines whether the dynamic center of rotation (COR) is enabled or not. If disabled, the center of rotation will always be the origin. If enabled, the center of rotation will be the point at which the user clicked when starting the rotation (only applies if the user clicked on the geometry).

boolean

false
EXPAND_ON_VIEWER_SELECTION: "expandOnViewerSelection"

Defines whether or not a subtree should be expanded to the leaf when selected in the viewer.

Usually, users can only select parts that are currently known to webvis. By expanding a node (that has linked parts associated to it), its child nodes will be downloaded and can be selected in the viewer. Changing this setting to true will automatically expand the parent nodes and select the leaf node that was clicked.

boolean

false
FACE_HIGHLIGHT_COLOR: "faceHighlightColor"

Defines the color to be used to indicate faces in the 3D view that are highlighted via the ViewerHighlightAPI (for instance during a measurement).

string

urn:X-l3d:color:rgba:FFFF00A6
FACE_SELECTION_COLOR: "faceSelectionColor"

Defines the color to be used to indicate selected faces in the 3D view.

string

urn:X-l3d:color:rgba:FFFF00A6

Property.APPEARANCE_URI for a definition of valid color strings.

FIT_VIEW_FACTOR: "fitViewFactor"

Defines the factor for view fitting. The factor defines the percentage of the screen that should be covered at maximum by the geometry, per axis. The larger value of the two axes (x and y) will be used. A value of 0.6 for instance means that the geometry will cover at most 60% of the screen both horizontally and vertically.

number

0.6
FLY_NAVIGATION_SPEED: "flyNavigationSpeed"

Defines the speed for the fly navigation mode.

number

7

NavigationMode.FLY

FLYTO_ON_DOUBLECLICK_ENABLED: "flyToOnDoubleClick"

Defines whether or not to fit the camera to the clicked node on double-click.

boolean

false
FOCUS_ON_DOUBLE_CLICK: "focusOnDoubleClick"

Defines whether a viewer should focus on a part on double-click.

boolean

true
FRUSTUM_CULLING: "frustumCulling"

Defines whether camera frustum culling is enabled or not. If enabled, parts not visible by the camera will be excluded from rendering to improve performance.

boolean

true
GHOSTED_SCENE_OPACITY: "ghostedSceneOpacity"

Defines the opacity of the ghosted scene for the geometry that is not occluded by the main scene.

number

0.33

Property.GHOSTED

GIZMO_AXIS_LABELS_ENABLED: "gizmoAxisLabelsEnabled"

Defines whether the axis labels of the gizmos are enabled or not. Axis labels are only available for translation and scaling gizmos yet.

boolean

true
GIZMO_SCALING_FACTOR: "gizmoScalingFactor"

Defines the scaling factor for the size of gizmo geometries.

number

1
GIZMOS_ENABLED: "gizmosEnabled"

Defines whether the gizmos for manipulating 3D entities in the viewer are enabled or not.

boolean

true
GPU_MEMORY_RELEASE_FACTOR: "gpuMemoryReleaseFactor"

Defines the percentage of the GPU memory that is released when the memory limit is reached.

number

0.1
HOVER_COLOR: "hoverColor"

Defines the color to be displayed when hovering the mouse over geometry.

string

urn:X-l3d:color:rgb:262626

Property.APPEARANCE_URI for a definition of valid color strings.

INIT_VIEW: "initView"

Defines a view matrix to set on start.

[number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] | Float32Array | undefined

undefined

ViewerAPI.restoreInitView to restore this initial view.

INITIAL_FIT: "initialFit"

Defines whether or not to fit the view to all visible models when a node's ENABLED property changes. If active, it also refits when new 3D data is being streamed in. Please note that once the view is updated afterwards, for instance by moving the camera, and at any mouse down event, the initial fit will be disabled. To re-enable it, the setting has to be set again.

boolean

true
INITIAL_FIT_DIRECTION: "initialFitDirection"

Defines the direction which is used for the initial view fitting

ViewDirection

ViewDirection.CURRENT
INVERT_ZOOM_DIRECTION: "mouseInvertZoomingDirection"

Defines whether the mouse zoom direction is inverted or not.

boolean

false
LIGHTING_ENVIRONMENT: "lightingEnvironment"

Defines the viewer's lighting environment.

ViewerLightingEnvironment

ViewerLightingEnvironment.HEADLIGHT
LINE_HIGHLIGHT_COLOR: "lineHighlightColor"

Defines the color to be used to indicate lines in the 3D view that are highlighted via the ViewerHighlightAPI (for instance during a measurement).

string

urn:X-l3d:color:rgba:FFFF00BF
LINE_SELECTION_COLOR: "lineSelectionColor"

Defines the color to be used to indicate selected lines in the 3D view.

string

urn:X-l3d:color:rgba:FFFF00BF

Property.APPEARANCE_URI for a definition of valid color strings.

MAX_DYNAMIC_CLIP_DIST: "maxDynamicClipDistance"

Defines the maximum dynamic clipping distance.

number

5
MAX_GPU_MEMORY: "maxGPUMemory"

Defines the limit for the GPU memory in megabytes.

number

1024
MAX_SRC_MEMORY: "maxSRCCPUMemory"

Defines the limit for the CPU-side memory (RAM) in megabytes.

number

512
NAVIGATION_MODE: "navigationMode"

Defines the current navigation mode.

NavigationMode

NavigationMode.WEBVIS
NAVIGATION_SAMPLING: "navigationSampling"

Defines the sampling factor (viewport scale) during navigation. This setting is meant as an optional optimization that allows for rendering in a lower resolution during navigation.

number

1
NAVIGATION_SPEED_FACTOR: "navigationSpeedFactor"

Defines the navigation speed factor (sensitivity).

number

1
NAVIGATION_SPEED_THROTTLE_FACTOR: "navigationSpeedThrottleFactor"

Defines the factor to throttle the navigation speed when the modifier key is pressed (throttled sensitivity).

number

0.1
OUTLINE_COLOR: "outlineColor"

Defines the color of the outline.

string

urn:X-l3d:color:rgb:ffff00
OUTLINE_COLOR_OCCLUDED: "outlineColorOccluded"

Defines the color of the outline for occluded parts.

string

urn:X-l3d:color:rgb:ff9900
OUTLINE_INNER_RADIUS: "outlineInnerRadius"

Defines the inner outline radius in pixels (the offset between a part and its outline).

outlineWidth = outlineOuterRadius - outlineInnerRadius

number

0
OUTLINE_OUTER_RADIUS: "outlineOuterRadius"

Defines the outer outline radius in pixels:

outlineWidth = outlineOuterRadius - outlineInnerRadius

number

8
PRE_SELECTION_COLOR: "preSelectionColor"

Defines the color to be used to indicate the parts the user is interacting with in the 3D scene. This color is used for highlighting parts once the user has clicked on them and before the selection is active.

string

urn:X-l3d:color:rgb:FFFF88

Property.APPEARANCE_URI for a definition of valid color strings.

PROJECTION_TYPE: "projectionType"

Defines the type of camera projection.

CameraProjectionType

CameraProjectionType.PERSPECTIVE

ViewerAPI.getCameraProjectionType

RENDER_AUXILIARY_ON_TOP: "renderAuxOnTop"

Defines whether a viewer renders auxiliaries on top or not.

boolean

false
RENDER_MODE: "renderMode"

Defines the render mode of the viewer.

Please note, that if the Property.RENDER_MODE is set on a specific node, this setting will be overridden.

RenderMode

RenderMode.Faces

ViewerAPI.forceRenderMode

RENDER_SETUP: "renderSetup"

Defines the render setup.

RenderSetup

RenderSetup.LOCAL

HubAPI.requestSupportedRenderSetups

SCENE_OPACITY: "sceneOpacity"

Sets the overall opacity of the rendered scene. This setting is useful in XR applications to allow the user to see tracked real world objects behind the rendered scene.

Possible values range from 0.0 to 1.0, where 1.0 means the scene is fully opaque and 0.0 means the scene is fully transparent.

number

1.0
SCREEN_SPACE_COVERAGE_CALCULATION_METHOD: "screenSpaceCoverageCalculationMethod"

Defines how the screen space coverage of parts, which is used for the small feature culling, is calculated.

string

"BBOX_WEIGHTED_AREA_COMPUTATION"
SELECTION_COLOR: "selectionColor"

Defines the color to be used to indicate selected parts in the 3D view.

string

urn:X-l3d:color:rgb:FFFF00

Property.APPEARANCE_URI for a definition of valid color strings.

SHOW_AUX_ON_NAVIGATION: "showAuxOnNavigation"

Defines whether a viewer shows the auxiliary geometries during navigation or not

ViewerSettingStrings.SHOW_AUX_ON_NAVIGATION is deprecated and will be removed in a future version.

boolean

true

NodeType.AUX

SILHOUETTE_EFFECT_COLOR: "silhouetteEffectColor"

Defines the color of the silhouette rendering effect.

string

urn:X-l3d:color:rgba:000000FF
SILHOUETTE_EFFECT_ENABLED: "silhouetteEffect"

Defines whether the silhouette rendering effect is enabled or not.

boolean

false
SILHOUETTE_EFFECT_EXCLUSIVE_ENABLED: "silhouetteEffectExclusiveEnabled"

Defines whether only the silhouettes should be rendered or not.

boolean

false
SMALL_FEATURE_CULLING: "smallFeatureCulling"

Defines whether small feature culling is enabled or not.

boolean

false

SMALL_FEATURE_PIXEL_THRESHOLD

SMALL_FEATURE_PIXEL_THRESHOLD: "smallFeaturePixelThreshold"

Defines the threshold for small feature culling in pixels. Every part which would be rendered smaller than this threshold will be culled.

number

4

SMALL_FEATURE_CULLING

SOFTWAR_OCCLUSION_CULLING: "soc"

Defines whether software occlusion culling is enabled or not. Before downloading a resource, the viewer will check if the resource is occluded by other geometry which is already rendered. If this is the case, the resource will not be downloaded.

boolean

true
SPACEMOUSE_MULTIPLIER: "spacemouseMultiplier"

Defines the multiplier used to adjust the space mouse sensitivity.

number

7
SSAO_ENABLED: "ssaoEnabled"

Defines whether screen space ambient occlusion (SSAO) is enabled or not.

boolean

false
TAA_ENABLED: "taaEnabled"

Defines whether temporal anti-aliasing (TAA) is enabled or not. TAA is only available in static scenes. It is disabled in the following cases:

  • During camera movement, due to the camera not being static. This means TAA is not available in AR.
  • While downloads are active, the scene must be redrawn every time a new object is loaded.
  • If GPU memory/CPU time is exceeded, it is not possible to render the whole scene in a single frame. Applying TAA becomes too complex in this case.

TAA will automatically be re-enabled once the scene is static again.

boolean

false
TOPO_GEOMETRY_COLOR: "topoGeometryColor"

Defines the color for the topological geometry.

string

urn:X-l3d:color:rgb:00b0ff
TOPO_GEOMETRY_SECONDARY_COLOR: "topoGeometrySecondaryColor"

Defines the secondary color for the topological geometry.

string

urn:X-l3d:color:rgb:555555
TOPO_POINTS_ENABLED: "topoPointsEnabled"

Defines whether topological points are rendered.

boolean

false
TRANSPARENCY_MODE: "transparencyMode"

Defines the transparency mode

TransparencyMode

PERFORMANCE
TURNTABLE_LOWER_VERTICAL_LIMIT: "turntableLowerVerticalLimit"

Defines the lower vertical limit of the turntable navigation mode in degrees.

number

-90
TURNTABLE_UPPER_VERTICAL_LIMIT: "turntableUpperVerticalLimit"

Defines the upper vertical limit for the turntable navigation mode in degrees.

number

90
TURNTABLE_VERTICAL_LIMITS_ENABLED: "turntableVerticalLimitsEnabled"

Defines whether the vertical limits for the turntable navigation mode are enabled or not.

boolean

false
USE_DEVICE_PIXEL_RATIO: "useDevicePixelRatio"

Defines whether the canvas should be scaled by the window.devicePixelRatio or not. Enabling this setting is necessary to compensate for the DPI scaling of the system / monitor. Enabling this setting will improve the visual quality on high DPI monitors but can decrease performance.

boolean

false
VERTEX_COLORS_ENABLED: "vertexColorsEnabled"

Defines whether vertex colors are enabled or not. If enabled and the model contains vertex colors, the vertex colors will be used for rendering. Furthermore, the node's Property.APPEARANCE_URI will be ignored. Thus, if the user wants to change the node's appearance in this case, this setting has to be disabled first.

boolean

true
VIEW_PERSPECTIVE: "viewPerspective"

Defines the view perspective.

ViewPerspective

ViewPerspective.INSIDE
WEBGL_PRESERVE_DRAWINGBUFFER: "webglPreserveDrawingbuffer"

Defines whether or not to preserve the drawing buffer on the WebGL context.

boolean

false

https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext#preservedrawingbuffer