Interface RendererInititializationOptions

Declarative Initialization Options. Everything here can be changed at runtime with the appropriate call

Hierarchy

  • RendererInititializationOptions

Properties

ambientColor? assetsPath? backgroundColor? backgroundColorEnd? backgroundColorStart? bimctServerBasePath? bimctViewerBasePath? cube? display? ecoRenderingOn? enhancedSilhouettes? glassHover? grid? groundShadow? gui? hatchesOn? highlightAlpha? highlightBorderColor? highlightColor? highlightPointColor? highlightXRayAlpha? key? linesOn? logging? maps? measurementSystem? modelLocation? paperColor? pickMode? preloadProperties? rollOverEnabled? shading? shadowMaps? skymapId? snappingEnabled? sunFlare? sunLight? transformationGismo? xRayHighlights?

Properties

Optional ambientColor

ambientColor?: RGB

Ambient lighting color. Default rgb(0.7, 0.7, 0.7), applys to non Realistic Modes

Optional assetsPath

assetsPath?: string

Assets Base Path, use this to change the assets location

Optional backgroundColor

backgroundColor?: RGB

Background color. Default rgb(1, 1, 1)

Optional backgroundColorEnd

backgroundColorEnd?: RGB

Optional backgroundColorStart

backgroundColorStart?: RGB

Background colors for gradient image. Default rgb(1, 1, 1)

Optional bimctServerBasePath

bimctServerBasePath?: string

BimCT Server URL for additional functions lile OCR text, isometric, template matching GIS etc, the license must also support theses features

Optional bimctViewerBasePath

bimctViewerBasePath?: string

BimCT Viewer Base Path, place where the bimct-viewer.js is located for creating i-frames for functions like side by side comparison

Optional cube

cube?: RendererCubeOptions

3D rotation cube Widget Options

Optional display

display?: { decimalPlaces?: DecimalPlaces; decimalSeparator?: DECIMAL_SEPARATOR; language?: Language; useImperialFractions?: boolean }

Display Format and Language for Numbers and Text

Type declaration

Optional ecoRenderingOn

ecoRenderingOn?: boolean

Eco Rendering means always draw render loop, otherwise rendering will stop after 5 seconds of inactivity

See

also: refreshRedrawNeeded()

Optional enhancedSilhouettes

enhancedSilhouettes?: boolean

Enhance silhouettes to emphasize edges

Optional glassHover

glassHover?: boolean

Glass Hover over windows

Optional grid

grid?: RendererGridOptions

Grid on bottom of the design model

Optional groundShadow

groundShadow?: boolean

Ground shadow on/off

Optional gui

gui?: { customElementProperties?: { dataBinding?: BimCTCustomElementPropertiesDataBinding; editEnabled?: boolean }; enableTransformButton?: boolean; leftToolbarCustomItems?: BimCTCustomToolbarButton[]; map?: { type?: "2D" | "3D"; visible?: boolean }; sharesDataBinding?: BimCTSharesDataBinding; splashScreenImageURL?: string; useContextMenu?: boolean; useDesignTreeWindow?: boolean; useFilterElementsWindow?: boolean; useHomeToolbar?: boolean; useLeftToolbar?: boolean; useMessageBoxes?: boolean; usePropertiesWindow?: boolean; useQuantitiesLabel?: boolean; useSettingsWindow?: boolean; useShareWindow?: boolean; useSnapshotWindow?: boolean; useToolbar?: boolean; useTouchWidget?: boolean; useViewsWindows?: boolean; useWebXRWindow?: boolean; viewsDataBinding?: BimCTViewsDataBinding; viewsSavingOptions?: BimCTViewsOptions }

Use the BimCT UI by default everything is set to non used (false)

Type declaration

  • Optional customElementProperties?: { dataBinding?: BimCTCustomElementPropertiesDataBinding; editEnabled?: boolean }

    Use Custom Properties

  • Optional enableTransformButton?: boolean

    Use Quantitites Label

  • Optional leftToolbarCustomItems?: BimCTCustomToolbarButton[]

    Custom Buttonm Items for the Left Toolbar

  • Optional map?: { type?: "2D" | "3D"; visible?: boolean }
    • Optional type?: "2D" | "3D"

      whether to start the viewer with the map in 3D or 2D mode default is 2D

    • Optional visible?: boolean

      whether to start the viewer with the map visible default is false

  • Optional sharesDataBinding?: BimCTSharesDataBinding
  • Optional splashScreenImageURL?: string

    URL of Splash Screen Image

  • Optional useContextMenu?: boolean

    Use Right Click Menu

  • Optional useDesignTreeWindow?: boolean

    Use Properties Window

  • Optional useFilterElementsWindow?: boolean

    Use Filter Elements

  • Optional useHomeToolbar?: boolean

    Use Left Toolbar

  • Optional useLeftToolbar?: boolean

    Use Left Toolbar

  • Optional useMessageBoxes?: boolean

    Message Boxes

  • Optional usePropertiesWindow?: boolean

    Use Properties Window

  • Optional useQuantitiesLabel?: boolean

    Use Quantitites Label

  • Optional useSettingsWindow?: boolean

    Use Settings Window

  • Optional useShareWindow?: boolean

    Use Share Window

  • Optional useSnapshotWindow?: boolean

    Take Snapshots

  • Optional useToolbar?: boolean

    Use Default Toolbar

  • Optional useTouchWidget?: boolean

    Use TouchWidget

  • Optional useViewsWindows?: boolean

    Enable Views Windows

  • Optional useWebXRWindow?: boolean

    WebXR

  • Optional viewsDataBinding?: BimCTViewsDataBinding
  • Optional viewsSavingOptions?: BimCTViewsOptions

Optional hatchesOn

hatchesOn?: boolean

Hatches on/off

Optional highlightAlpha

highlightAlpha?: number

Highlight Color Alpha (default 0.8)

Optional highlightBorderColor

highlightBorderColor?: RGB

Highlight Border Color

Optional highlightColor

highlightColor?: RGB

Highlight Color

Optional highlightPointColor

highlightPointColor?: RGB

Highlight Point Color

Optional highlightXRayAlpha

highlightXRayAlpha?: number

Highlight Color Aplha for XRay Mode (default 0.4)

Optional key

key?: string

The domain key ti be used with the BimCT Server, if you dont set it the viewer will only run o localhost environments, a watermakr will be displayed on unlicensed domains. To get a domain key for a web application please contact BimCT Sales

Optional linesOn

linesOn?: boolean

Lines on/off

Optional logging

logging?: RendererLoggingOptions

Enable/Disable logging. Default false

Optional maps

maps?: { allowed?: MAP_SERVER[]; default?: { server: MAP_SERVER; type: MAP_TILE_TYPE }; google?: { apiKey: string }; layers?: { clientId: string }; search?: { allowDetectUserLocation?: boolean; apiKey?: string; service: MAP_SEARCH_SERVICE }; terrain?: { mapTiler?: { apiKey?: string; selfHostedUrl?: string }; nomitech?: { hostUrl?: string } } }

Type declaration

  • Optional allowed?: MAP_SERVER[]
  • Optional default?: { server: MAP_SERVER; type: MAP_TILE_TYPE }
  • Optional google?: { apiKey: string }
    • apiKey: string
  • Optional layers?: { clientId: string }
    • clientId: string
  • Optional search?: { allowDetectUserLocation?: boolean; apiKey?: string; service: MAP_SEARCH_SERVICE }
    • Optional allowDetectUserLocation?: boolean
    • Optional apiKey?: string
    • service: MAP_SEARCH_SERVICE
  • Optional terrain?: { mapTiler?: { apiKey?: string; selfHostedUrl?: string }; nomitech?: { hostUrl?: string } }
    • Optional mapTiler?: { apiKey?: string; selfHostedUrl?: string }
      • Optional apiKey?: string
      • Optional selfHostedUrl?: string
    • Optional nomitech?: { hostUrl?: string }
      • Optional hostUrl?: string

Optional measurementSystem

measurementSystem?: MEASUREMENT_SYSTEM

Define the Measurement System (Imperial or Metric)

Optional modelLocation

modelLocation?: ModelLocation

Override Default Model Location (used for true alignment of Sun-Light in the Scene) will used those values instead of those found in design file

Optional paperColor

paperColor?: RGB

Paper Color

Optional pickMode

pickMode?: RENDERER_PICK_MODE

Initial picking mode

Optional preloadProperties

preloadProperties?: boolean

Properties Preloaded to ElementInfo, increases the memory of javascript

Optional rollOverEnabled

rollOverEnabled?: boolean

Eco Rendering means always draw render loop, otherwise rendering will stop after 5 seconds of inactivity

See

also: refreshRedrawNeeded()

Optional shading

shading?: SHADING_MODE

Initial shading mode

Optional shadowMaps

shadowMaps?: boolean

Shadows on/off (realistic mode only)

Optional skymapId

skymapId?: "grass" | "desert" | "farm"

Skymap image id available values (desert, grass or null)

Optional snappingEnabled

snappingEnabled?: boolean

Snapping Enabled, will increase the Emscripten Memory and every time you show or hide an element the points will be racomputed

Optional sunFlare

sunFlare?: boolean

Sun Flare on/off (realistic mode only)

Optional sunLight

sunLight?: boolean

Sun Light on/off (realistic mode only)

Optional transformationGismo

transformationGismo?: TransformationGismoOptions

Transformation Gismo Options

Optional xRayHighlights

xRayHighlights?: boolean

Whether to use XRay effect on Highlighted Elements Faces and Measurements

Settings

Member Visibility

Theme