Class Viewer

Type declaration

• backupName: StringController

  Name of the backup to save the settings in the local storage

  Default Value

  "Default"
  Copy

• camera: {
      centerCameraWhenLoading: BooleanController;
      stepDistanceZoom: NumberController;
  }

  Camera settings

  • centerCameraWhenLoading: BooleanController

    Center the viewport camera on scene bounding sphere when loading content

    Default Value

    true
    Copy

  • stepDistanceZoom: NumberController

    The added or removed distance when we click on the "zoom in / zoom out" buttons in the toolbar (CameraZoomOutCommand / CameraZoomInCommand)

    Default Value

    10
    Copy

• debug: BooleanController

  Show debug tools

  Default Value

  false
  Copy

• dev: { drawDebug: BooleanController; verbose: BooleanController }

  Developer settings

  • drawDebug: BooleanController

    Whether to active the draw debugs (draw debug objects to scene)

    Default Value

    false
    Copy

  • verbose: BooleanController

    Verbose console logging. If true, info and time measures will be displayed in console

    Default Value

    false
    Copy

• doubleClickDelay: NumberController

  Delay in milliseconds between two successing clicks/taps to consider event as DoubleClick/Tap

  Default Value

  250
  Copy

  Min

  100

  Max

  500

• forceLocalSettings: BooleanController

  Whether to use the local storage settings over the settings sent to the viewer

  Default Value

  false
  Copy

• keyboardType: SelectController<readonly ["unknown", "azerty", "qwerty"]>

  Type of the keyboard

  Default Value

  "unknown"
  Copy

• lights: {
      ambientLightIntensity: NumberController;
      cameraLightIntensity: NumberController;
      directionalLightIntensity: NumberController;
      hemisphereLightIntensity: NumberController;
      skyAzimuth: NumberController;
      skyElevation: NumberController;
      skyIsVisible: BooleanController;
      skyMieCoefficient: NumberController;
      skyMieDirectionalG: NumberController;
      skyRayleigh: NumberController;
      skyTurbidity: NumberController;
  }

  Light settings

• loading: {
      batchingMeshCountUpdateThreshold: NumberController;
      batchingWorkersCount: NumberController;
      edgeGeometryMinAngle: NumberController;
      loadingWorkersCount: NumberController;
      maxBatchingIndexCount: NumberController;
      maxBatchingProxyCount: NumberController;
      maxBatchingVertexCount: NumberController;
  }

  Loading settings

  • batchingMeshCountUpdateThreshold: NumberController

    Number of meshes to batch in the worker before sending an update to main thread

    Default Value

    1000
    Copy

    Min

    100

    Max

    2000

  • batchingWorkersCount: NumberController

    Number of WebWorkers used to re-arrange geometry buffers

    Default Value

    navigator.hardwareConcurrency
    Copy

    Min

    1

    Max

    navigator.hardwareConcurrency

  • edgeGeometryMinAngle: NumberController

    Edge threshold used to compute edge geometries

    Default Value

    60
    Copy

  • loadingWorkersCount: NumberController

    Number of WebWorkers used to load scene

    Default Value

    navigator.hardwareConcurrency
    Copy

    Min

    1

    Max

    navigator.hardwareConcurrency

  • maxBatchingIndexCount: NumberController

    Maximum size of the index buffer for a batch

    Default Value

    1e7
    Copy

    Min

    1e6

    Max

    1e7

  • maxBatchingProxyCount: NumberController

    Maximum number of object per batch

    Default Value

    3000
    Copy

    Min

    500

    Max

    7000

  • maxBatchingVertexCount: NumberController

    Maximum size of the vertex buffer for a batch

    Default Value

    1e7
    Copy

    Min

    1e6

    Max

    1e7

• memory: {
      memoryUsageCriticalLevel: NumberController;
      memoryUsageWarningLevel: NumberController;
  }

  JS Memory settings

  • memoryUsageCriticalLevel: NumberController

    Max percentage of memory used before displaying a critical warning

    Default Value

    0.8
    Copy

    Min

    0

    Max

    1

  • memoryUsageWarningLevel: NumberController

    Max percentage of memory used before displaying a warning

    Default Value

    0.5
    Copy

    Min

    0

    Max

    1

• objects: {
      defaultEdgesColor: ColorController;
      doubleSide: BooleanController;
      flatShading: BooleanController;
      highlightColor: ColorController;
      pivotPoint: SelectController<readonly ["Center", "Min", "Max"]>;
      selectionLayer: SelectController<readonly [Base, SelectedObject]>;
      xRayOpacity: NumberController;
  }

  Objects settings

  • defaultEdgesColor: ColorController

  • doubleSide: BooleanController

  • flatShading: BooleanController

  • highlightColor: ColorController

    Color used to highlight selected objects in the scene

    Default Value

    #fabd38
    Copy

  • pivotPoint: SelectController<readonly ["Center", "Min", "Max"]>

    Pivot point of the group transform

    Default Value

    false (PivotPoint.center)
    Copy

  • selectionLayer: SelectController<readonly [Base, SelectedObject]>

    Layer to use for selection

  • xRayOpacity: NumberController

• raycast: { marginError: NumberController }

  Selection settings

  • marginError: NumberController

    Max distance in world units (meters) between the ray and a the object to be selected (e.g. Lines)

• scene: {
      axesSize: NumberController;
      backgroundColor: ColorController;
      gridSize: NumberController;
      showGrid: BooleanController;
      showOriginAxisHelper: BooleanController;
      showSceneAxisHelper: BooleanController;
  }

  Scene settings

  • axesSize: NumberController

    Size of the AxesHelper

    Default Value

    10
    Copy

    Min

    1

    Max

    1000

  • backgroundColor: ColorController

    Background color of the scene

    Default Value

    #aabbdd
    Copy

  • gridSize: NumberController

    Size of the grid

    Default Value

    100
    Copy

    Min

    10

    Max

    1000

  • showGrid: BooleanController

    Whether to show a grid in the scene

    Default Value

    false
    Copy

  • showOriginAxisHelper: BooleanController

    Whether to show an AxisHelper on the (0,0,0) coordinates

    Default Value

    false
    Copy

  • showSceneAxisHelper: BooleanController

    Whether to show an AxisHelper on the center of the bounding sphere of the scene

    Default Value

    false
    Copy

• snapping: { snappingEdgesThreshold: NumberController }

  Snapping settings

  • snappingEdgesThreshold: NumberController

    Threshold used to snap on edges

• ui: {
      disableToolbar: BooleanController;
      showObjectHierarchyBanner: BooleanController;
      showToolbar: BooleanController;
      treeViewPageSize: NumberController;
      widgetZoneBottomMargin: NumberController;
  }

  Ui Settings

  • disableToolbar: BooleanController

    Whether to disable the toolbar (if any added)

    Default Value

    false
    Copy

  • showObjectHierarchyBanner: BooleanController

    Whether the selected object hierarchy banner is open by default

    Default Value

    false
    Copy

  • showToolbar: BooleanController

    Whether to show the toolbar (if any added)

    Default Value

    true
    Copy

  • treeViewPageSize: NumberController

    Default number of children displayed per parent in the tree view, also the size of added children

    Default Value

    30
    Copy

    Min

    1

    Max

    30

  • widgetZoneBottomMargin: NumberController

    Margin bottom in which the widgets can't go

    Default Value

    60
    Copy

    Min

    0

    Max

    300