Type Alias TGeometryState

TGeometryState: {
    altitude: number;
    borderColor?: string;
    borderVisible: boolean;
    borderWidth?: number;
    color: string;
    enableImageCollisions: boolean;
    flipImageToFaceCamera: boolean;
    height: number;
    hoverColor?: string;
    interactive: boolean | "pass-through";
    opacity: number;
    texture?: { url: string };
    topColor?: string;
    topTexture?: { url: string };
    type: "geometry";
    visible: boolean;
}

The serialized state of a geometry element such as a Space, including its style, color, and visibility.

Type declaration

  • altitude: number

    The altitude of the geometry element in meters.

    Default

    0
  • OptionalborderColor?: string

    The color of the border. borderVisible must be true for this to take effect.

  • borderVisible: boolean

    Whether the geometry has a border

  • OptionalborderWidth?: number

    The width of the border. borderVisible must be true for this to take effect.

  • color: string

    Color of the geometry element. Color can be set using CSS colors names DarkGoldenRod, as Hex strings #0000FF or the rgb values rgb(255,0,0). Set to initial to reset to the default color.

  • enableImageCollisions: boolean

    Whether the anchored image should collide with other images.

    Default

    false
  • flipImageToFaceCamera: boolean

    Whether the image should be flipped to face the camera.

    Default

    false
  • height: number

    Height of the geometry element in meters.

    Default

    0
  • OptionalhoverColor?: string

    Color of the geometry element when hovered over. Color can be set using CSS colors names DarkGoldenRod, as Hex strings #0000FF or the rgb values rgb(255,0,0). Set to initial to reset to the default color.

  • interactive: boolean | "pass-through"

    Controls how the geometry participates in pointer-event raycasting.

    • true: hover and click handlers fire on this geometry.
    • false (default): the geometry captures the raycast — clicks land on it and stop there — but no hover or click handler fires. The geometry still shields anything rendered behind it from receiving events.
    • 'pass-through': raycasts skip this geometry entirely so pointer events fall through to whatever is rendered behind it. Useful for invisible helper geometry that must never block clicks beneath it.

    Default

    false
  • opacity: number

    Opacity of the geometry element.

    Default

    1
  • Optionaltexture?: { url: string }

    Texture to apply to the geometry element.

  • OptionaltopColor?: string

    Color of the geometry element's top. Color can be set using CSS colors names DarkGoldenRod, as Hex strings #0000FF or the rgb values rgb(255,0,0). Set to initial to reset to the default color.

  • OptionaltopTexture?: { url: string }

    Top texture to apply to the geometry element.

  • type: "geometry"
  • visible: boolean

    Whether the geometry is visible.

    Default

    true

Settings

Member Visibility