Type Alias TFloorState

Type declaration

• altitude: number

  The altitude of the floor.

  Default

  0
  Copy

• areas: { type: "floor.areas"; visible: boolean }

  • type: "floor.areas"

  • visible: boolean

    Visibility of the areas on the floor.

    Default

    true
    Copy

• footprint: {
      altitude: number;
      basementMaskEnabled: boolean;
      ceilingThickness: number;
      ceilingVisible: boolean;
      color: string;
      height: number;
      opacity: number;
      outline: boolean;
      type: "floor.footprint";
      visible: boolean;
  }

  • altitude: number

    Altitude of the footprint relative to the floor.

    Default

    0
    Copy

  • basementMaskEnabled: boolean

  • ceilingThickness: number

    Thickness of the footprint ceiling.

    Default

    0.2
    Copy

  • ceilingVisible: boolean

    Visibility of the ceiling.

    Default

    false
    Copy

  • color: string

    Color of the footprint.

    Default

    #ffffff
    Copy

  • height: number

    Height of the footprint relative to altitude.

    Default

    0
    Copy

  • opacity: number

    Opacity of the footprint.

    Default

    1
    Copy

  • outline: boolean

    Whether to show outlines on the footprint walls and ceiling.

    Default

    true
    Copy

  • type: "floor.footprint"

  • visible: boolean

    Whether the footprint is visible.

    Default

    false
    Copy

• geometry: {
      darkenAmount: number;
      darkenUseDepth: boolean;
      desaturateAmount: number;
      desaturateUseDepth: boolean;
      effectDistance: number;
      effectStart: number;
      maskEffect: "hide" | "reveal";
      maskEnabled: boolean;
      maskId: null | number;
      maskMode: "mask" | "masked-object";
      opacity: number;
      type: "floor.geometry";
      visible: boolean;
      washOutAmount: number;
      washOutUseDepth: boolean;
  }

  • darkenAmount: number

    Darkening amount for floors below voids (0 = none, 1 = fully darkened towards #333).

    Default

    0
    Copy

  • darkenUseDepth: boolean

    Whether darkening varies by depth.

    Default

    true
    Copy

  • desaturateAmount: number

    Desaturation amount for floors below voids (0 = full color, 1 = fully grayscale).

    Default

    0
    Copy

  • desaturateUseDepth: boolean

    Whether desaturation varies by depth.

    Default

    true
    Copy

  • effectDistance: number

    Distance in meters below effectStart at which depth-based effects reach full strength. 0 = effects disabled.

    Default

    0
    Copy

  • effectStart: number

    World-space Z altitude where depth-based effects begin.

    Default

    0
    Copy

  • maskEffect: "hide" | "reveal"

    Whether to invert the mask.

  • maskEnabled: boolean

    Whether the mask is enabled.

  • maskId: null | number

    Mask ID of the floor geometry.

    Default

    null
    Copy

  • maskMode: "mask" | "masked-object"

    Whether the mask is enabled.

  • opacity: number

    Opacity of the floor geometry.

    Default

    1
    Copy

  • type: "floor.geometry"

  • visible: boolean

    Visibility of floor geometry.

    Default

    true
    Copy

  • washOutAmount: number

    Wash out amount for floors below voids (0 = no wash out, 1 = fully white).

    Default

    0
    Copy

  • washOutUseDepth: boolean

    Whether wash out varies by depth.

    Default

    false
    Copy

• images: { collisionsEnabled: boolean; type: "floor.images"; visible: boolean }

  • collisionsEnabled: boolean

    Whether images on this floor should participate in collision detection. When true, images may be hidden if they collide with other elements.

    Default

    false
    Copy

  • type: "floor.images"

  • visible: boolean

    Visibility of the images on the floor.

    Default

    true
    Copy

• labels: { enabled: boolean; type: "floor.labels" }

  • enabled: boolean

    Whether the labels are enabled to be shown when the floor is visible.

    Default

    true
    Copy

  • type: "floor.labels"

• markers: { enabled: boolean; type: "floor.markers" }

  • enabled: boolean

    Whether the markers are enabled to be shown when the floor is visible.

    Default

    true
    Copy

  • type: "floor.markers"

• models: { type: "floor.models"; visible: boolean }

  • type: "floor.models"

  • visible: boolean

    Visibility of the 3D models on the floor.

    Default

    true
    Copy

• occlusion: { type: "floor.occlusion" }

• paths: { type: "floor.paths"; visible: boolean }

  • type: "floor.paths"

  • visible: boolean

    Visibility of the paths on the floor.

    Default

    true
    Copy

• text3d: { visible: boolean }

  • visible: boolean

    Visibility of the 3D text labels on the floor.

    Default

    true
    Copy

• type: "floor"

• visible: boolean

  The visibility of the floor, including the geometry, labels, and markers.

  Default

  false
  Copy