Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

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);

See

Enumeration Members

AA_SETTING_ENABLED BACKGROUND_COLOR 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_SCALING_FACTOR GIZMOS_ENABLED GPU_MEMORY_RELEASE_FACTOR HOVER_COLOR INIT_VIEW INITIAL_FIT 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

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.

Value Type

boolean

Default

false

See

TAA_ENABLED for temporal anti-aliasing (TAA).

BACKGROUND_COLOR

BACKGROUND_COLOR: "backgroundColor"

Defines the current background color.

Value Type

string

Default

urn:X-l3d:color:rgba:00000000

See

Property.APPEARANCE_URI for a definition of valid color strings.

CAMERA_FIELD_OF_VIEW

CAMERA_FIELD_OF_VIEW: "defaultFieldOfView"

Defines the camera field of view in degrees.

Value Type

number

Default

45

CAPPING_EFFECT_EDGE_COLOR

CAPPING_EFFECT_EDGE_COLOR: "cappingEffectEdgeColor"

Defines the edge color of the capping effect.

Value Type

string

Default

urn:X-l3d:color:rgba:00000000

See

CAPPING_EFFECT_ENABLED

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.

Value Type

boolean

Default

false

See

ClipPlaneAPI

CAPPING_EFFECT_INNER_COLOR

CAPPING_EFFECT_INNER_COLOR: "cappingEffectInnerColor"

Defines the inner color of the capping effect.

Value Type

string

Default

urn:X-l3d:color:rgba:00000000

See

COLOR_COMPARISON_FIRST_COLOR

COLOR_COMPARISON_FIRST_COLOR: "colorComparisonFirstColor"

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

Value Type

string

Default

urn:X-l3d:color:rgb:aa0000

See

COLOR_COMPARISON_MATCHING_COLOR

COLOR_COMPARISON_MATCHING_COLOR: "colorComparisonMatchingColor"

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

Value Type

string

Default

urn:X-l3d:color:rgb:00aa00

See

COLOR_COMPARISON_SECOND_COLOR

COLOR_COMPARISON_SECOND_COLOR: "colorComparisonSecondColor"

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

Value Type

string

Default

urn:X-l3d:color:rgb:0000aa

See

COLORIZE_EFFECT_ENABLED

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.

Value Type

boolean

Default

false

See

Property.NODE_REPRESENTATION

COORDINATE_SYSTEM

COORDINATE_SYSTEM: "coordSys"

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

Deprecated

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

Value Type

FrontPlaneAxis

DISABLE_SPECULAR_HIGHLIGHT

DISABLE_SPECULAR_HIGHLIGHT: "disableSpecularHighlights"

Defines whether a viewer shows specular highlighting or not.

Value Type

boolean

Default

false

DOUBLE_CLICK_ANIMATION_VOLUME_SCALE

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.

Value Type

number

Default

1.6

DOUBLE_CLICK_TIME_WINDOW

DOUBLE_CLICK_TIME_WINDOW: "doubleClickTimeWindow"

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

Value Type

number

Default

250

DRAWING_ARROWHEAD_END

DRAWING_ARROWHEAD_END: "drawingArrowheadEnd"

Defines the arrow head at the end of a drawing.

Value Type

DrawingArrowhead

Default

DrawingArrowhead.NONE

DRAWING_ARROWHEAD_START

DRAWING_ARROWHEAD_START: "drawingArrowheadStart"

Defines the arrow head at the start of a drawing.

Value Type

DrawingArrowhead

Default

DrawingArrowhead.NONE

DRAWING_COLOR

DRAWING_COLOR: "drawingColor"

Defines the drawing color.

Value Type

string

Default

urn:X-l3d:color:rgb:00b0ff

See

DRAWING_MODE

DRAWING_MODE: "drawingMode"

Defines the drawing mode.

Value Type

DrawingMode

Default

DrawingMode.BRUSH

See

ViewerDrawingAPI

DRAWING_SIZE

DRAWING_SIZE: "drawingSize"

Defines the drawing size in pixels.

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

Value Type

number

Default

6

See

ViewerDrawingAPI

DYNAMIC_AUX_CONTRAST_ENABLED

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.

Value Type

boolean

Default

false

See

NodeType.AUX

DYNAMIC_CLIPPING_DISTANCE

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.

Value Type

number

Default

5

See

DYNAMIC_CLIPPING_ENABLED

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.

Value Type

boolean

Default

false

See

DYNAMIC_CLIPPING_DISTANCE

DYNAMIC_COR_ENABLED

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).

Value Type

boolean

Default

false

EXPAND_ON_VIEWER_SELECTION

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.

Value Type

boolean

Default

false

FACE_HIGHLIGHT_COLOR

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).

Value Type

string

Default

urn:X-l3d:color:rgba:FFFF00A6

See

FACE_SELECTION_COLOR

FACE_SELECTION_COLOR: "faceSelectionColor"

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

Value Type

string

Default

urn:X-l3d:color:rgba:FFFF00A6

See

Property.APPEARANCE_URI for a definition of valid color strings.

FIT_VIEW_FACTOR

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.

Value Type

number

Default

0.6

FLY_NAVIGATION_SPEED

FLY_NAVIGATION_SPEED: "flyNavigationSpeed"

Defines the speed for the fly navigation mode.

Value Type

number

Default

7

See

NavigationMode.FLY

FLYTO_ON_DOUBLECLICK_ENABLED

FLYTO_ON_DOUBLECLICK_ENABLED: "flyToOnDoubleClick"

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

Value Type

boolean

Default

false

FOCUS_ON_DOUBLE_CLICK

FOCUS_ON_DOUBLE_CLICK: "focusOnDoubleClick"

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

Value Type

boolean

Default

true

FRUSTUM_CULLING

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.

Value Type

boolean

Default

true

ExperimentalGHOSTED_SCENE_OPACITY

GHOSTED_SCENE_OPACITY: "ghostedSceneOpacity"

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

Value Type

number

Default

0.33

See

Property.GHOSTED

GIZMO_SCALING_FACTOR

GIZMO_SCALING_FACTOR: "gizmoScalingFactor"

Defines the scaling factor for the size of gizmo geometries.

Value Type

number

Default

1

GIZMOS_ENABLED

GIZMOS_ENABLED: "gizmosEnabled"

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

Value Type

boolean

Default

true

GPU_MEMORY_RELEASE_FACTOR

GPU_MEMORY_RELEASE_FACTOR: "gpuMemoryReleaseFactor"

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

Value Type

number

Default

0.1

HOVER_COLOR

HOVER_COLOR: "hoverColor"

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

Value Type

string

Default

urn:X-l3d:color:rgb:262626

See

Property.APPEARANCE_URI for a definition of valid color strings.

INIT_VIEW

INIT_VIEW: "initView"

Defines a view matrix to set on start.

Value Type

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

Default

undefined

See

ViewerAPI.restoreInitView to restore this initial view.

INITIAL_FIT

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.

Value Type

boolean

Default

true

INVERT_ZOOM_DIRECTION

INVERT_ZOOM_DIRECTION: "mouseInvertZoomingDirection"

Defines whether the mouse zoom direction is inverted or not.

Value Type

boolean

Default

false

LIGHTING_ENVIRONMENT

LIGHTING_ENVIRONMENT: "lightingEnvironment"

Defines the viewer's lighting environment.

Value Type

ViewerLightingEnvironment

Default

ViewerLightingEnvironment.HEADLIGHT

LINE_HIGHLIGHT_COLOR

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).

Value Type

string

Default

urn:X-l3d:color:rgba:FFFF00BF

See

LINE_SELECTION_COLOR

LINE_SELECTION_COLOR: "lineSelectionColor"

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

Value Type

string

Default

urn:X-l3d:color:rgba:FFFF00BF

See

Property.APPEARANCE_URI for a definition of valid color strings.

MAX_DYNAMIC_CLIP_DIST

MAX_DYNAMIC_CLIP_DIST: "maxDynamicClipDistance"

Defines the maximum dynamic clipping distance.

Value Type

number

Default

5

MAX_GPU_MEMORY

MAX_GPU_MEMORY: "maxGPUMemory"

Defines the limit for the GPU memory in megabytes.

Value Type

number

Default

1024

MAX_SRC_MEMORY

MAX_SRC_MEMORY: "maxSRCCPUMemory"

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

Value Type

number

Default

512

NAVIGATION_MODE

NAVIGATION_MODE: "navigationMode"

Defines the current navigation mode.

Value Type

NavigationMode

Default

NavigationMode.WEBVIS

NAVIGATION_SAMPLING

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.

Value Type

number

Default

1

NAVIGATION_SPEED_FACTOR

NAVIGATION_SPEED_FACTOR: "navigationSpeedFactor"

Defines the navigation speed factor (sensitivity).

Value Type

number

Default

1

NAVIGATION_SPEED_THROTTLE_FACTOR

NAVIGATION_SPEED_THROTTLE_FACTOR: "navigationSpeedThrottleFactor"

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

Value Type

number

Default

0.1

ExperimentalOUTLINE_COLOR

OUTLINE_COLOR: "outlineColor"

Defines the color of the outline.

Value Type

string

Default

urn:X-l3d:color:rgb:ffff00

See

ExperimentalOUTLINE_COLOR_OCCLUDED

OUTLINE_COLOR_OCCLUDED: "outlineColorOccluded"

Defines the color of the outline for occluded parts.

Value Type

string

Default

urn:X-l3d:color:rgb:ff9900

See

ExperimentalOUTLINE_INNER_RADIUS

OUTLINE_INNER_RADIUS: "outlineInnerRadius"

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

outlineWidth = outlineOuterRadius - outlineInnerRadius

Value Type

number

Default

0

See

ExperimentalOUTLINE_OUTER_RADIUS

OUTLINE_OUTER_RADIUS: "outlineOuterRadius"

Defines the outer outline radius in pixels:

outlineWidth = outlineOuterRadius - outlineInnerRadius

Value Type

number

Default

8

See

PRE_SELECTION_COLOR

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.

Value Type

string

Default

urn:X-l3d:color:rgb:FFFF88

See

Property.APPEARANCE_URI for a definition of valid color strings.

PROJECTION_TYPE

PROJECTION_TYPE: "projectionType"

Defines the type of camera projection.

Value Type

CameraProjectionType

Default

CameraProjectionType.PERSPECTIVE

See

ViewerAPI.getCameraProjectionType

RENDER_AUXILIARY_ON_TOP

RENDER_AUXILIARY_ON_TOP: "renderAuxOnTop"

Defines whether a viewer renders auxiliaries on top or not.

Value Type

boolean

Default

false

RENDER_MODE

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.

Value Type

RenderMode

Default

RenderMode.Faces

See

ViewerAPI.forceRenderMode

RENDER_SETUP

RENDER_SETUP: "renderSetup"

Defines the render setup.

Value Type

RenderSetup

Default

RenderSetup.LOCAL

See

HubAPI.requestSupportedRenderSetups

SCENE_OPACITY

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.

Value Type

number

Default

1.0

SCREEN_SPACE_COVERAGE_CALCULATION_METHOD

SCREEN_SPACE_COVERAGE_CALCULATION_METHOD: "screenSpaceCoverageCalculationMethod"

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

Value Type

string

Default

"BBOX_WEIGHTED_AREA_COMPUTATION"

SELECTION_COLOR

SELECTION_COLOR: "selectionColor"

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

Value Type

string

Default

urn:X-l3d:color:rgb:FFFF00

See

Property.APPEARANCE_URI for a definition of valid color strings.

SHOW_AUX_ON_NAVIGATION

SHOW_AUX_ON_NAVIGATION: "showAuxOnNavigation"

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

Value Type

boolean

Default

true

See

NodeType.AUX

SILHOUETTE_EFFECT_COLOR

SILHOUETTE_EFFECT_COLOR: "silhouetteEffectColor"

Defines the color of the silhouette rendering effect.

Value Type

string

Default

urn:X-l3d:color:rgba:000000FF

See

SILHOUETTE_EFFECT_ENABLED

SILHOUETTE_EFFECT_ENABLED: "silhouetteEffect"

Defines whether the silhouette rendering effect is enabled or not.

Value Type

boolean

Default

false

See

SILHOUETTE_EFFECT_EXCLUSIVE_ENABLED

SILHOUETTE_EFFECT_EXCLUSIVE_ENABLED: "silhouetteEffectExclusiveEnabled"

Defines whether only the silhouettes should be rendered or not.

Value Type

boolean

Default

false

See

SMALL_FEATURE_CULLING

SMALL_FEATURE_CULLING: "smallFeatureCulling"

Defines whether small feature culling is enabled or not.

Value Type

boolean

Default

false

See

SMALL_FEATURE_PIXEL_THRESHOLD

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.

Value Type

number

Default

4

See

SMALL_FEATURE_CULLING

SOFTWAR_OCCLUSION_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.

Value Type

boolean

Default

true

SPACEMOUSE_MULTIPLIER

SPACEMOUSE_MULTIPLIER: "spacemouseMultiplier"

Defines the multiplier used to adjust the space mouse sensitivity.

Value Type

number

Default

7

SSAO_ENABLED

SSAO_ENABLED: "ssaoEnabled"

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

Value Type

boolean

Default

false

TAA_ENABLED

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.

Value Type

boolean

Default

false

TOPO_GEOMETRY_COLOR

TOPO_GEOMETRY_COLOR: "topoGeometryColor"

Defines the color for the topological geometry.

Value Type

string

Default

urn:X-l3d:color:rgb:00b0ff

See

TOPO_GEOMETRY_SECONDARY_COLOR

TOPO_GEOMETRY_SECONDARY_COLOR: "topoGeometrySecondaryColor"

Defines the secondary color for the topological geometry.

Value Type

string

Default

urn:X-l3d:color:rgb:555555

See

TOPO_POINTS_ENABLED

TOPO_POINTS_ENABLED: "topoPointsEnabled"

Defines whether topological points are rendered.

Value Type

boolean

Default

false

TRANSPARENCY_MODE

TRANSPARENCY_MODE: "transparencyMode"

Defines the transparency mode

Value Type

TransparencyMode

Default

PERFORMANCE

TURNTABLE_LOWER_VERTICAL_LIMIT

TURNTABLE_LOWER_VERTICAL_LIMIT: "turntableLowerVerticalLimit"

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

Value Type

number

Default

-90

See

TURNTABLE_UPPER_VERTICAL_LIMIT

TURNTABLE_UPPER_VERTICAL_LIMIT: "turntableUpperVerticalLimit"

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

Value Type

number

Default

90

See

TURNTABLE_VERTICAL_LIMITS_ENABLED

TURNTABLE_VERTICAL_LIMITS_ENABLED: "turntableVerticalLimitsEnabled"

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

Value Type

boolean

Default

false

See

USE_DEVICE_PIXEL_RATIO

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.

Value Type

boolean

Default

false

VERTEX_COLORS_ENABLED

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.

Value Type

boolean

Default

true

VIEW_PERSPECTIVE

VIEW_PERSPECTIVE: "viewPerspective"

Defines the view perspective.

Value Type

ViewPerspective

Default

ViewPerspective.INSIDE

WEBGL_PRESERVE_DRAWINGBUFFER

WEBGL_PRESERVE_DRAWINGBUFFER: "webglPreserveDrawingbuffer"

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

Value Type

boolean

Default

false

See

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