videx-3d
Version:
React 3D component library designed for sub surface visualizations in the browser
53 lines (52 loc) • 1.97 kB
TypeScript
import { PropsWithChildren } from 'react';
import { Color } from 'three';
import { Vec3 } from '../../../sdk/types/common';
import { CommonComponentProps } from '../../common';
import { BoxPadding } from '../../ObservableGroup/ObservableGroup';
/**
* BoxGrid props
* @expand
*/
export type BoxGridProps = CommonComponentProps & {
size?: Vec3;
cellSize?: number;
subDivisions?: number;
gridScale?: Vec3;
gridOrigin?: Vec3;
originValue?: Vec3;
gridLineWidth?: number;
background?: string | Color | number;
backgroundOpacity?: number;
opacity?: number;
gridColorMajor?: string | number | Color;
gridColorMinor?: string | number | Color;
axesColor?: string | number | Color;
axesLineWidth?: number;
axesTickSize?: number;
enableProjection?: boolean;
projectionColor?: string | number | Color;
projectionResolution?: number;
projectionRefreshRate?: number;
showRulers?: boolean;
autoSize?: boolean;
autoSizePadding?: number | Vec3 | BoxPadding;
autoSizeUpdateRate?: number;
};
/**
* Renders 5 grid planes in a box form (bottom and sides). See `Grid` for more info.
*
* @example
* <BoxGrid
* size={[5000, 2000, 5000]}
* cellSize={100}
* gridLineWidth={0.01}
* axesColor="#eee"
* opacity={0.8}
* />
*
* @see [Storybook](/videx-3d/?path=/docs/components-grids-boxgrid--docs)
* @see {@link Grid}
*
* @group Components
*/
export declare const BoxGrid: ({ name, visible, castShadow, receiveShadow, layers, renderOrder, userData, size, cellSize, gridScale, gridOrigin, originValue, subDivisions, position, gridLineWidth, background, backgroundOpacity, opacity, gridColorMajor, gridColorMinor, axesColor, axesLineWidth, axesTickSize, enableProjection, projectionColor, projectionResolution, projectionRefreshRate, showRulers, autoSize, autoSizePadding, autoSizeUpdateRate, children, }: PropsWithChildren<BoxGridProps>) => import("react/jsx-runtime").JSX.Element;