@equinor/videx-3d
    Preparing search index...

    Type Alias BoxGridProps

    BoxGridProps: CommonComponentProps & {
        autoSize?: boolean;
        autoSizePadding?: number | Vec3 | BoxPadding;
        autoSizeUpdateRate?: number;
        axesColor?: string | number | Color;
        axesLineWidth?: number;
        axesTickSize?: number;
        background?: string | Color | number;
        backgroundOpacity?: number;
        cellSize?: number;
        enableProjection?: boolean;
        gridColorMajor?: string | number | Color;
        gridColorMinor?: string | number | Color;
        gridLineWidth?: number;
        gridOrigin?: Vec3;
        gridScale?: Vec3;
        opacity?: number;
        originValue?: Vec3;
        projectionColor?: string | number | Color;
        projectionRefreshRate?: number;
        projectionResolution?: number;
        showRulers?: boolean;
        size?: Vec3;
        subDivisions?: number;
    }

    BoxGrid props

    Type Declaration

    • OptionalautoSize?: boolean

      enable automatic sizing and positioning of the box grid according to its child elements

    • OptionalautoSizePadding?: number | Vec3 | BoxPadding

      padding when autosize is enabled

    • OptionalautoSizeUpdateRate?: number

      update frequency in ms when autosize is enabled

    • OptionalaxesColor?: string | number | Color

      axes color

    • OptionalaxesLineWidth?: number

      axes line width as a factor of cell size

    • OptionalaxesTickSize?: number

      the axes tick size as a factor of cell size

    • Optionalbackground?: string | Color | number

      background color of the grid planes

    • OptionalbackgroundOpacity?: number

      opacity of the grid planes background color

    • OptionalcellSize?: number

      the size of a grid cell in world units

    • OptionalenableProjection?: boolean

      if enabled, project a shade of the objects within the grid planes, using an orthographic camera

    • OptionalgridColorMajor?: string | number | Color

      the color of the major grid lines

    • OptionalgridColorMinor?: string | number | Color

      the color of the minor/sub division grid lines

    • OptionalgridLineWidth?: number

      line width as a factor of the cell size

    • OptionalgridOrigin?: Vec3

      world coordinates of the grid origin (origo)

    • OptionalgridScale?: Vec3

      scale determining axes values and direction along each axis

    • Optionalopacity?: number

      opacity of the grid planes (including grid lines)

    • OptionaloriginValue?: Vec3

      the axes values at the specified origin (default 0,0,0)

    • OptionalprojectionColor?: string | number | Color

      the color of the projected shade when projection is enabled

    • OptionalprojectionRefreshRate?: number

      the update frequency of the projected texture when projection is enabled (ms)

    • OptionalprojectionResolution?: number

      the quality/size of the projection texture used when projection is enabled

    • OptionalshowRulers?: boolean

      show rulers on the grid planes at the intersection point of the pointer

    • Optionalsize?: Vec3

      size of the grid box in world units

    • OptionalsubDivisions?: number

      number of sub divisions of a grid cell

    Settings