UNPKG

videx-3d

Version:

React 3D component library designed for sub surface visualizations in the browser

38 lines (37 loc) 1.2 kB
import { CRS } from '../../sdk/projection/crs'; import { Vec3 } from '../../sdk/types/common'; /** * UtmArea props * @expand */ export type UtmAreaProps = { crsInstance?: CRS; utmZone?: string; origin: [number, number]; originUnits?: 'utm' | 'lnglat'; offset?: Vec3; utmProjectionDef?: string; }; /** * A container component that maps a UTM reference point to a 3d world space origin. This can be used by sub components to * position themselves by using UTM or Wgs84 coordinates as well as converting between these and 3d space coordinates. * * @example * <UtmArea utmZone={utmZone} origin={origin} originUnits={originUnits} offset={offset}> * { children } * </UtmArea> * * @remarks * This component will return the internal CRS instance when passing a ref * * @see [Storybook](/videx-3d/?path=/docs/components-containers-utmarea--docs) * @see {@link UtmPosition} * @see {@link Wgs84Position} * @see {@link UtmAreaContext} * @see {@link CRS} * * @group Components */ export declare const UtmArea: import('react').ForwardRefExoticComponent<UtmAreaProps & { children?: import('react').ReactNode | undefined; } & import('react').RefAttributes<CRS>>;