Selva Compute API Reference - v2.1.0
    Preparing search index...

    Type Alias GridConfig

    Infinite distance-fading reference grid. See createGrid.

    type GridConfig = {
        cellColor?: ColorRepresentation;
        cellSize?: number;
        enabled?: boolean;
        fadeDistance?: number;
        majorColor?: ColorRepresentation;
        majorEvery?: number;
        plane?: "x" | "y" | "z";
    }
    Index

    Properties

    cellColor? cellSize? enabled? fadeDistance? majorColor? majorEvery? plane?

    Properties

    cellColor?: ColorRepresentation

    Minor line color.

    cellSize?: number

    Minor cell size in world units (meters). Default 1.

    enabled?: boolean

    Show the grid. Default false (opt-in).

    fadeDistance?: number

    World radius at which the grid fully fades. Default 100.

    majorColor?: ColorRepresentation

    Major line color.

    majorEvery?: number

    Minor cells per major line. Default 10.

    plane?: "x" | "y" | "z"

    Plane the grid lies on. 'y' = horizontal ground. Default 'y'.

    Settings

    Member Visibility

    On This Page

    Properties