Type Alias TPathUpdateState

TPathUpdateState: {
    __EXPERIMENTAL_BILLBOARDING?: boolean;
    __EXPERIMENTAL_BORDER?: {
        color: BorderColor;
        enabled: boolean;
        width?: number;
    };
    __EXPERIMENTAL_DASH_OPTIONS?: | {
        __EXPERIMENTAL_DASH_GAP?: number;
        __EXPERIMENTAL_DASH_LENGTH?: number;
        __EXPERIMENTAL_DASH_MODE: "length-scaling";
    }
    | {
        __EXPERIMENTAL_DASH_MODE: "width-scaling";
        __EXPERIMENTAL_DASH_SIZE?: number;
        __EXPERIMENTAL_GAP_SIZE?: number;
    }
    | {
        __EXPERIMENTAL_DASH_METERS?: number;
        __EXPERIMENTAL_DASH_MODE: "absolute";
        __EXPERIMENTAL_GAP_METERS?: number;
    };
    __EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number];
    __EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon";
    __EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean;
    __EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number;
    __EXPERIMENTAL_SMOOTHING_TENSION?: number;
    color?: string;
    completeFraction?: number;
    dashed?: boolean;
    highlightColor?: string;
    highlightCompleteFraction?: number;
    highlightEndFraction?: number;
    highlightStartFraction?: number;
    highlightWidthMultiplier?: number;
    type?: "path";
    verticalOffset?: number;
    visible?: boolean;
    width?: unknown;
    xrayOpacity?: number;
}

Type declaration

Optional Experimental__EXPERIMENTAL_BILLBOARDING?: boolean
When true and using ribbon geometry, the path will always face the camera (billboard effect). Most useful for vertical paths between floors.
Default
```
false
```
Optional Experimental__EXPERIMENTAL_BORDER?: { color: BorderColor; enabled: boolean; width?: number }
Border configuration for ribbon path geometry. Renders darkened edges along both sides of the ribbon.
- color: BorderColor
  Border color - 'darken' to auto-darken main color, or explicit hex color string
- enabled: boolean
  Whether the border is enabled
- Optionalwidth?: number
  Border width as fraction of total ribbon width (0-0.5).
  Default
```
0.1
```
Optional Experimental__EXPERIMENTAL_DASH_OPTIONS?:
    | {
        __EXPERIMENTAL_DASH_GAP?: number;
        __EXPERIMENTAL_DASH_LENGTH?: number;
        __EXPERIMENTAL_DASH_MODE: "length-scaling";
    }
    | {
        __EXPERIMENTAL_DASH_MODE: "width-scaling";
        __EXPERIMENTAL_DASH_SIZE?: number;
        __EXPERIMENTAL_GAP_SIZE?: number;
    }
    | {
        __EXPERIMENTAL_DASH_METERS?: number;
        __EXPERIMENTAL_DASH_MODE: "absolute";
        __EXPERIMENTAL_GAP_METERS?: number;
    }
Dash configuration. When dashed=true, controls dash/gap sizing. Uses discriminated union - mode determines which properties are valid.
Optional Experimental__EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number]
Endcap extension for ribbon geometry as [start, end] tuple in meters. Value > 0 extends path and renders rounded cap; 0 = square end.
Default
```
[0.5, 0.5]
```
Optional Experimental__EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon"
Geometry type for path rendering.
- 'tube': Original tube geometry with 8 radial segments (default)
- 'ribbon': Flat ribbon geometry with 2 vertices per segment
Default
```
'tube'
```
Optional Experimental__EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean
When true, prevents the xray path from rendering multiple overlapping pixels when the path crosses over itself. Uses stencil buffer to ensure single-pixel rendering.
Default
```
false
```
Optional Experimental__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number
Distance in meters from corners where control points are inserted for smoothing. Only applies when __EXPERIMENTAL_SMOOTHING_TENSION > 0. Typical values are 0.5-2.0 meters.
Default
```
0.5
```
Optional Experimental__EXPERIMENTAL_SMOOTHING_TENSION?: number
Controls the smoothness of path corners using CatmullRom curve tension. Higher values create smoother curves. Values between 0.1-0.3 provide subtle smoothing.
Default
```
0.0
```
Optionalcolor?: string
The color of the path.
Default
```
#4b90e2
```
OptionalcompleteFraction?: number
The fraction of the path that should be complete. This can be used to animate the path.
Default
```
0
```
Optionaldashed?: boolean
Whether the path should be rendered as a dashed line.
Default
```
false
```
OptionalhighlightColor?: string
The color of the highlight.
Default
```
red
```
OptionalhighlightCompleteFraction?: number
The fraction of the highlighted path that should be complete. This can be used to animate the highlight.
Default
```
1
```
OptionalhighlightEndFraction?: number
The end fraction of the path that should be highlighted. Indicates the end of the highlighted section.
Default
```
0
```
OptionalhighlightStartFraction?: number
The start fraction of the path that should be highlighted. Indicates the start of the highlighted section.
Default
```
0
```
OptionalhighlightWidthMultiplier?: number
The width multiplier of the highlight. Setting this to 1 will result in no changes to path width.
Default
```
1.1
```
Optionaltype?: "path"
OptionalverticalOffset?: number
The altitude of the geometry, in meters
Default
```
0.1
```
Optionalvisible?: boolean
Whether the path is visible.
Default
```
true
```
Optionalwidth?: unknown
The width of the path in meters. Can be a number or an Interpolation.
OptionalxrayOpacity?: number
The opacity of the path when it's behind geometry (x-ray effect). Value from 0 to 1.
Default
```
0.25
```

Type Alias TPathUpdateState

Type declaration

Optional Experimental__EXPERIMENTAL_BILLBOARDING?: boolean

Default

Optional Experimental__EXPERIMENTAL_BORDER?: { color: BorderColor; enabled: boolean; width?: number }

color: BorderColor

enabled: boolean

Optionalwidth?: number

Default

Optional Experimental__EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number]

Default

Optional Experimental__EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon"

Default

Optional Experimental__EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean

Default

Optional Experimental__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number

Default

Optional Experimental__EXPERIMENTAL_SMOOTHING_TENSION?: number

Default

Optionalcolor?: string

Default

OptionalcompleteFraction?: number

Default

Optionaldashed?: boolean

Default

OptionalhighlightColor?: string

Default

OptionalhighlightCompleteFraction?: number

Default

OptionalhighlightEndFraction?: number

Default

OptionalhighlightStartFraction?: number

Default

OptionalhighlightWidthMultiplier?: number

Default

Optionaltype?: "path"

OptionalverticalOffset?: number

Default

Optionalvisible?: boolean

Default

Optionalwidth?: unknown

OptionalxrayOpacity?: number

Default

Settings

`Optional` `Experimental`__EXPERIMENTAL_BILLBOARDING?: boolean

`Optional` `Experimental`__EXPERIMENTAL_BORDER?: { color: BorderColor; enabled: boolean; width?: number }

`Optional`width?: number

`Optional` `Experimental`__EXPERIMENTAL_ENDCAP_EXTENSION?: [number, number]

`Optional` `Experimental`__EXPERIMENTAL_GEOMETRY?: "tube" | "ribbon"

`Optional` `Experimental`__EXPERIMENTAL_PREVENT_SELF_OVERLAP?: boolean

`Optional` `Experimental`__EXPERIMENTAL_SMOOTHING_CORNER_RADIUS?: number

`Optional` `Experimental`__EXPERIMENTAL_SMOOTHING_TENSION?: number

`Optional`color?: string

`Optional`completeFraction?: number

`Optional`dashed?: boolean

`Optional`highlightColor?: string

`Optional`highlightCompleteFraction?: number

`Optional`highlightEndFraction?: number

`Optional`highlightStartFraction?: number

`Optional`highlightWidthMultiplier?: number

`Optional`type?: "path"

`Optional`verticalOffset?: number

`Optional`visible?: boolean

`Optional`width?: unknown

`Optional`xrayOpacity?: number