Type Alias TFloorUpdateState

TFloorUpdateState: {
    altitude?: number;
    areas?: { type?: "floor.areas"; visible?: boolean };
    footprint?: {
        altitude?: number;
        basementMaskEnabled?: boolean;
        ceilingThickness?: number;
        ceilingVisible?: boolean;
        color?: string;
        height?: number;
        opacity?: number;
        outline?: boolean;
        type?: "floor.footprint";
        visible?: boolean;
    };
    geometry?: {
        maskEffect?: "hide"
        | "reveal";
        maskEnabled?: boolean;
        maskId?: null | number;
        maskMode?: "mask" | "masked-object";
        opacity?: number;
        overlayColor?: string;
        overlayStrength?: number;
        type?: "floor.geometry";
        visible?: boolean;
    };
    images?: { type?: "floor.images"; visible?: boolean };
    labels?: { enabled?: boolean; type?: "floor.labels" };
    markers?: { enabled?: boolean; type?: "floor.markers" };
    occlusion?: { type?: "floor.occlusion" };
    paths?: { type?: "floor.paths"; visible?: boolean };
    text3d?: { visible?: boolean };
    type?: "floor";
    visible?: boolean;
}

Type declaration

Optionalaltitude?: number
The altitude of the floor.
Default
```
0
```
Optionalareas?: { type?: "floor.areas"; visible?: boolean }
- Optionaltype?: "floor.areas"
- Optionalvisible?: boolean
  Visibility of the areas on the floor.
  Default
```
true
```
Optionalfootprint?: {
    altitude?: number;
    basementMaskEnabled?: boolean;
    ceilingThickness?: number;
    ceilingVisible?: boolean;
    color?: string;
    height?: number;
    opacity?: number;
    outline?: boolean;
    type?: "floor.footprint";
    visible?: boolean;
}
- Optionalaltitude?: number
  Altitude of the footprint relative to the floor.
  Default
```
0
```
- OptionalbasementMaskEnabled?: boolean
- OptionalceilingThickness?: number
  Thickness of the footprint ceiling.
  Default
```
0.2
```
- OptionalceilingVisible?: boolean
  Visibility of the ceiling.
  Default
```
false
```
- Optionalcolor?: string
  Color of the footprint.
  Default
```
#ffffff
```
- Optionalheight?: number
  Height of the footprint relative to altitude.
  Default
```
0
```
- Optionalopacity?: number
  Opacity of the footprint.
  Default
```
1
```
- Optionaloutline?: boolean
  Whether to show outlines on the footprint walls and ceiling.
  Default
```
true
```
- Optionaltype?: "floor.footprint"
- Optionalvisible?: boolean
  Whether the footprint is visible.
  Default
```
false
```
Optionalgeometry?: {
    maskEffect?: "hide" | "reveal";
    maskEnabled?: boolean;
    maskId?: null | number;
    maskMode?: "mask" | "masked-object";
    opacity?: number;
    overlayColor?: string;
    overlayStrength?: number;
    type?: "floor.geometry";
    visible?: boolean;
}
State of the geometry on the floor.
- OptionalmaskEffect?: "hide" | "reveal"
  Whether to invert the mask.
- OptionalmaskEnabled?: boolean
  Whether the mask is enabled.
- OptionalmaskId?: null | number
  Mask ID of the floor geometry.
  Default
```
null
```
- OptionalmaskMode?: "mask" | "masked-object"
  Whether the mask is enabled.
- Optionalopacity?: number
  Opacity of the floor geometry.
  Default
```
1
```
- OptionaloverlayColor?: string
  Whether the overlay is enabled.
- OptionaloverlayStrength?: number
  The opacity of the overlay.
- Optionaltype?: "floor.geometry"
- Optionalvisible?: boolean
  Visibility of floor geometry.
  Default
```
true
```
Optionalimages?: { type?: "floor.images"; visible?: boolean }
- Optionaltype?: "floor.images"
- Optionalvisible?: boolean
  Visibility of the images on the floor.
  Default
```
true
```
Optionallabels?: { enabled?: boolean; type?: "floor.labels" }
- Optionalenabled?: boolean
  Whether the labels are enabled to be shown when the floor is visible.
  Default
```
true
```
- Optionaltype?: "floor.labels"
Optionalmarkers?: { enabled?: boolean; type?: "floor.markers" }
- Optionalenabled?: boolean
  Whether the markers are enabled to be shown when the floor is visible.
  Default
```
true
```
- Optionaltype?: "floor.markers"
Optionalocclusion?: { type?: "floor.occlusion" }
Optionalpaths?: { type?: "floor.paths"; visible?: boolean }
- Optionaltype?: "floor.paths"
- Optionalvisible?: boolean
  Visibility of the paths on the floor.
  Default
```
true
```
Optionaltext3d?: { visible?: boolean }
- Optionalvisible?: boolean
  Visibility of the 3D text labels on the floor.
  Default
```
true
```
Optionaltype?: "floor"
Optionalvisible?: boolean
The visibility of the floor, including the geometry, labels, and markers.
Default
```
false
```

Type Alias TFloorUpdateState

Type declaration

Optionalaltitude?: number

Default

Optionalareas?: { type?: "floor.areas"; visible?: boolean }

Optionaltype?: "floor.areas"

Optionalvisible?: boolean

Default

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

Optionalaltitude?: number

Default

OptionalbasementMaskEnabled?: boolean

OptionalceilingThickness?: number

Default

OptionalceilingVisible?: boolean

Default

Optionalcolor?: string

Default

Optionalheight?: number

Default

Optionalopacity?: number

Default

Optionaloutline?: boolean

Default

Optionaltype?: "floor.footprint"

Optionalvisible?: boolean

Default

Optionalgeometry?: { maskEffect?: "hide" | "reveal"; maskEnabled?: boolean; maskId?: null | number; maskMode?: "mask" | "masked-object"; opacity?: number; overlayColor?: string; overlayStrength?: number; type?: "floor.geometry"; visible?: boolean;}

OptionalmaskEffect?: "hide" | "reveal"

OptionalmaskEnabled?: boolean

OptionalmaskId?: null | number

Default

OptionalmaskMode?: "mask" | "masked-object"

Optionalopacity?: number

Default

OptionaloverlayColor?: string

OptionaloverlayStrength?: number

Optionaltype?: "floor.geometry"

Optionalvisible?: boolean

Default

Optionalimages?: { type?: "floor.images"; visible?: boolean }

Optionaltype?: "floor.images"

Optionalvisible?: boolean

Default

Optionallabels?: { enabled?: boolean; type?: "floor.labels" }

Optionalenabled?: boolean

Default

Optionaltype?: "floor.labels"

Optionalmarkers?: { enabled?: boolean; type?: "floor.markers" }

Optionalenabled?: boolean

Default

Optionaltype?: "floor.markers"

Optionalocclusion?: { type?: "floor.occlusion" }

Optionalpaths?: { type?: "floor.paths"; visible?: boolean }

Optionaltype?: "floor.paths"

Optionalvisible?: boolean

Default

Optionaltext3d?: { visible?: boolean }

Optionalvisible?: boolean

Default

Optionaltype?: "floor"

Optionalvisible?: boolean

Default

Settings

`Optional`altitude?: number

`Optional`areas?: { type?: "floor.areas"; visible?: boolean }

`Optional`type?: "floor.areas"

`Optional`visible?: boolean

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

`Optional`altitude?: number

`Optional`basementMaskEnabled?: boolean

`Optional`ceilingThickness?: number

`Optional`ceilingVisible?: boolean

`Optional`color?: string

`Optional`height?: number

`Optional`opacity?: number

`Optional`outline?: boolean

`Optional`type?: "floor.footprint"

`Optional`visible?: boolean

`Optional`geometry?: {
maskEffect?: "hide" | "reveal";
maskEnabled?: boolean;
maskId?: null | number;
maskMode?: "mask" | "masked-object";
opacity?: number;
overlayColor?: string;
overlayStrength?: number;
type?: "floor.geometry";
visible?: boolean;
}

`Optional`maskEffect?: "hide" | "reveal"

`Optional`maskEnabled?: boolean

`Optional`maskId?: null | number

`Optional`maskMode?: "mask" | "masked-object"

`Optional`opacity?: number

`Optional`overlayColor?: string

`Optional`overlayStrength?: number

`Optional`type?: "floor.geometry"

`Optional`visible?: boolean

`Optional`images?: { type?: "floor.images"; visible?: boolean }

`Optional`type?: "floor.images"

`Optional`visible?: boolean

`Optional`labels?: { enabled?: boolean; type?: "floor.labels" }

`Optional`enabled?: boolean

`Optional`type?: "floor.labels"

`Optional`markers?: { enabled?: boolean; type?: "floor.markers" }

`Optional`enabled?: boolean

`Optional`type?: "floor.markers"

`Optional`occlusion?: { type?: "floor.occlusion" }

`Optional`paths?: { type?: "floor.paths"; visible?: boolean }

`Optional`type?: "floor.paths"

`Optional`visible?: boolean

`Optional`text3d?: { visible?: boolean }

`Optional`visible?: boolean

`Optional`type?: "floor"

`Optional`visible?: boolean