Configuration

Description of the `configuration` field¶

interface ConfigurationState {
    renderStyles: RenderStyle[]
    currentConfigurationId: string
    configurations: Configuration[]
}

`renderStyles`¶

Updated by: UI

List of the Render Styles available on this file.

Data model¶

interface RenderStyle {
    name: string
    valueQuery: string
    indexQuery: string
    legendQuery: string
    files: string[]
    id: string
}

Examples¶

The Configuration has a single Render Style¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "renderStyles": [
          {
            "name": "Test",
            "valueQuery": "cube",
            "indexQuery": "",
            "legendQuery": "",
            "files": ["62224769c04655015b742b64"],
            "id": "6203db0eb5a72a052f59984d"
          }
        ]
        ...
      }
    ]
    ...
  }
}

`currentConfigurationId`¶

Updated by: UI

ID of the currently active Configuration.

Data model¶

currentConfigurationId: string

Examples¶

Change the current configuration¶

{
  "configuration":  {
    ...
    "currentConfigurationId": "61f8f80d5d3c8d000b021eb1"
    ...
  }
}

`configurations/renderMode`¶

Updated by: UI

Name or ID of the currently active Render Style.

Data model¶

renderMode: string

Examples¶

Set the Render Style to "basic"¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "renderMode": "basic"
        ...
      }
    ]
    ...
  }
}

`configurations/modifiers`¶

Updated by: UI

List of the Modifiers created on this file.

Data model¶

interface Modifier {
    _id: string
    details: {
        colorId?: number
        lockedActions: string[]
        enabled: boolean
        id: string | null
    }
    node: string
    type: 'hidden' | 'color' | 'transparent' | 'lock'
    nodeName: string
    depth: number
}

Example¶

The Configuration contains one Modifier¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "modifiers": [
          {
            "node": "620fbe7ee1f9c80999ebef93",
            "details": {
                "lockedActions": [
                "select",
                "annotate",
                "quote"
                ],
                "colorId": 11,
                "enabled": true,
                "id": null
            },
            "_id": "6224b061aaeaba070c9ff741",
            "type": "color"
          }
        ]
        ...
      }
    ]
    ...
  }
}

`configurations/modifiersEnabled`¶

Updated by: UI

Enables the Modifier feature. This field must be true to enable any Modifier.

Data model¶

modifiersEnabled: boolean

Examples¶

Enable the Modifier feature¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "modifiersEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/iblEnabled`¶

Updated by: UI

Enables the "Environment ligthing": the light of the skybox reflects on the model, giving the scene a more realistic look.

Data model¶

iblEnabled: boolean

Examples¶

Enable the environment lighting¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "iblEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/skyboxEnabled`¶

Updated by: UI

Enable the skybox. The skybox is the image used in the background of the scene. When disabled, a single color is used instead of an image.

Data model¶

skyboxEnabled: boolean

Example¶

Enable the skybox¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "skyboxEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/environmentEnabled`¶

Updated by: UI

Enable all Environment related features like skyboxEnabled, iblEnabled...

Data model¶

environmentEnabled: boolean

Examples¶

Enable the environment features¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "environmentEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/enabledEffects`¶

Updated by: UI

List of the Effects enabled in the 3D view. The effects available are:

HDR Bloom
FXAA
Edges
Transparency

Data model¶

enabledEffects: string[]

Examples¶

Enable the `Edges` and `HDR Bloom` effects¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledEffects": ["Edges", "HDR Bloom"]
        ...
      }
    ]
    ...
  }
}

Enable only the `HDR Bloom` effect¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledEffects": ["HDR Bloom"]
        ...
      }
    ]
    ...
  }
}

Disable all the effects¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledEffects": []
        ...
      }
    ]
    ...
  }
}

`configurations/transparencyEffectParameters`¶

Updated by: UI

Parameters of the Transparency effect:

transparencyIntensityIndex: An index between 0 and 2 that describes the intensity of the transparency.

Data model¶

transparencyEffectParameters: {
    transparencyIntensityIndex: number
}

Examples¶

Set the transparency intensity index¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "transparencyEffectParameters": {
          "transparencyIntensityIndex": 2
        }
        ...
      }
    ]
    ...
  }
}

`configurations/enabledBehaviors`¶

Updated by: UI

List of the IDs of the Behaviors to enable.

Data model¶

enabledBehaviors: string[]

Examples¶

Enable two Behaviors¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledBehaviors": [
          "61f91a7f5d3c8d000b023f99",
          "61f91aaf5d3c8d000b023fe3"]
        ...
      }
    ]
    ...
  }
}

Disable all the Behaviors¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledBehaviors": []
        ...
      }
    ]
    ...
  }
}

`configurations/behaviorsEnabled`¶

Updated by: UI

Enable the Behavior feature. This field must be true to enable any Behavior.

Data model¶

layersEnabled: boolean

Examples¶

Enable Behaviors¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "behaviorsEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/enabledLayers`¶

Updated by: UI

List of the IDs of the Layers to enable.

Data model¶

enabledLayers: string[]

Example¶

Enable two layers¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledLayers": [
          "61f91a7f5d3c8d000b023f99", 
          "61f91aaf5d3c8d000b023fe3"]
        ...
      }
    ]
    ...
  }
}

Disable all Layers¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledLayers": []
        ...
      }
    ]
    ...
  }
}

`configurations/layersEnabled`¶

Updated by: UI

Enable the Layer feature. This field must be true to enable any Layer.

Data model¶

layersEnabled: boolean

Examples¶

Enable the Layer feature¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "layersEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/environmentOrientation`¶

Updated by: UI

Orientation of the skybox in degrees.

Data model¶

environmentOrientation: number

Examples¶

Set the orientation of the skybox to 95 degrees¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "environmentOrientation": 95
        ...
      }
    ]
    ...
  }
}

`configurations/environmentBrightness`¶

Updated by: UI

Brightness of the environment light. 1 is the nominal value.

Data model¶

environmentBrightness: number

Examples¶

Set the brightness of the environment light to 1.55¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "environmentBrightness": 1.55
        ...
      }
    ]
    ...
  }
}

`configurations/environmentFile`¶

Updated by: UI

Path to the file representing the skybox.

Available skybox files are described in the server settings at "lights settings"."image based light"."sources".

Data model¶

environmentFile: number

Examples¶

Set the skybox to a specific value¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "environmentFile": "scene/envmap_apartment.light.scene"
        ...
      }
    ]
    ...
  }
}

`configurations/clippingPlanesEnabled`¶

Updated by: UI

Enable the Clipping Plane feature. This field must be true to enable any Clipping Plane.

Data model¶

clippingPlanesEnabled: boolean

Examples¶

Enable Clipping Planes¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "clippingPlanesEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/enabledClippingPlanes`¶

Updated by: UI

List of the IDs of the Clipping Planes to enable.

Data model¶

enabledClippingPlanes: string[]

Examples¶

Enable two Clipping Planes¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledClippingPlanes": [
          "61f91a7f5d3c8d000b023f99",
          "61f91aaf5d3c8d000b023fe3"]
        ...
      }
    ]
    ...
  }
}

Disable all the Clipping Planes¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledClippingPlanes": []
        ...
      }
    ]
    ...
  }
}

`configurations/quotationsEnabled`¶

Updated by: UI

Enable the Quotation feature. This field must be true to enable any Quotation.

Data model¶

quotationsEnabled: boolean

Examples¶

Enable Quotations¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "quotationsEnabled": true
        ...
      }
    ]
    ...
  }
}

`configurations/enabledQuotations`¶

Updated by: UI

List of the IDs of the Quotations to enable.

Data model¶

enabledQuotations: string[]

Examples¶

Enable two Quotations¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledQuotations": [
          "61f91a7f5d3c8d000b023f99", 
          "61f91aaf5d3c8d000b023fe3"]
        ...
      }
    ]
    ...
  }
}

Disable all the Quotations¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "enabledQuotations": []
        ...
      }
    ]
    ...
  }
}

`configurations/cameraType`¶

Updated by: UI

Type of camera used by the user to navigate in the 3D scene. Available types are:

third person
first person
physics FPS

Data model¶

cameraType: string | null

Examples¶

Set the camera type to `third person`¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "cameraType": "third person"
        ...
      }
    ]
    ...
  }
}

`configurations/cameraPosition`¶

Updated by: UI

Set the position and target of the camera in 6 strings that contain coordinates.

The position must be stored in the first 3 values of the array.
The target must be stored in the last 3 values of the array.

Data model¶

cameraPosition: string[]

Examples¶

Set a camera position¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "cameraPosition": [
          "66.789536",
          "38.173241",
          "52.096951",
          "13.034428",
          "23.770706",
          "-17.025814"
        ]
        ...
      }
    ]
    ...
  }
}

`configurations/cameraFoVIndex`¶

Updated by: UI

An index between 0 and 2 that describes the field of view of the camera.

Available field of views are described in the server settings at "camera"."available fovs".

Data model¶

cameraFoVIndex: number

Examples¶

Update the index of the camera FoV¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "cameraFoVIndex": 1
        ...
      }
    ]
    ...
  }
}

`configurations/zNear`¶

Updated by: UI

Nearest distance from the camera at which 3D objects are rendered to the screen.

Data model¶

zNear: number

Examples¶

Update zNear value¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "zNear": 0.04
        ...
      }
    ]
    ...
  }
}

`configurations/upVector`¶

Updated by: UI

Which vector is "up" in the 3D view. Available up vectors:

X+
X-
Y+
Y-
Z+
Z-

Data model¶

upVector: string

Examples¶

Use `Z-` as the up vector¶

{
  "configuration":  {
    ...
    "configurations":[
      {
        ...
        "upVector": "Z-"
        ...
      }
    ]
    ...
  }
}

November 24, 2022 March 8, 2022

Configuration

Description of the configuration field¶

renderStyles¶

Data model¶

Examples¶

The Configuration has a single Render Style¶

currentConfigurationId¶

Data model¶

Examples¶

Change the current configuration¶

configurations/renderMode¶

Data model¶

Examples¶

Set the Render Style to "basic"¶

configurations/modifiers¶

Data model¶

Example¶

The Configuration contains one Modifier¶

configurations/modifiersEnabled¶

Data model¶

Examples¶

Enable the Modifier feature¶

configurations/iblEnabled¶

Data model¶

Examples¶

Enable the environment lighting¶

configurations/skyboxEnabled¶

Data model¶

Example¶

Enable the skybox¶

configurations/environmentEnabled¶

Data model¶

Examples¶

Enable the environment features¶

configurations/enabledEffects¶

Data model¶

Examples¶

Enable the Edges and HDR Bloom effects¶

Enable only the HDR Bloom effect¶

Disable all the effects¶

configurations/transparencyEffectParameters¶

Data model¶

Examples¶

Set the transparency intensity index¶

configurations/enabledBehaviors¶

Data model¶

Examples¶

Enable two Behaviors¶

Disable all the Behaviors¶

configurations/behaviorsEnabled¶

Data model¶

Examples¶

Enable Behaviors¶

configurations/enabledLayers¶

Data model¶

Example¶

Enable two layers¶

Disable all Layers¶

configurations/layersEnabled¶

Data model¶

Examples¶

Enable the Layer feature¶

configurations/environmentOrientation¶

Data model¶

Examples¶

Set the orientation of the skybox to 95 degrees¶

configurations/environmentBrightness¶

Data model¶

Examples¶

Set the brightness of the environment light to 1.55¶

configurations/environmentFile¶

Data model¶

Examples¶

Set the skybox to a specific value¶

configurations/clippingPlanesEnabled¶

Data model¶

Examples¶

Enable Clipping Planes¶

configurations/enabledClippingPlanes¶

Data model¶

Description of the `configuration` field¶

`renderStyles`¶

`currentConfigurationId`¶

`configurations/renderMode`¶

`configurations/modifiers`¶

`configurations/modifiersEnabled`¶

`configurations/iblEnabled`¶

`configurations/skyboxEnabled`¶

`configurations/environmentEnabled`¶

`configurations/enabledEffects`¶

Enable the `Edges` and `HDR Bloom` effects¶

Enable only the `HDR Bloom` effect¶

`configurations/transparencyEffectParameters`¶

`configurations/enabledBehaviors`¶

`configurations/behaviorsEnabled`¶

`configurations/enabledLayers`¶

`configurations/layersEnabled`¶

`configurations/environmentOrientation`¶

`configurations/environmentBrightness`¶

`configurations/environmentFile`¶

`configurations/clippingPlanesEnabled`¶

`configurations/enabledClippingPlanes`¶

`configurations/quotationsEnabled`¶

`configurations/enabledQuotations`¶

`configurations/cameraType`¶

Set the camera type to `third person`¶

`configurations/cameraPosition`¶

`configurations/cameraFoVIndex`¶

`configurations/zNear`¶

`configurations/upVector`¶

Use `Z-` as the up vector¶