@caveworld/honeycomb-grid
Version:
Create hexagon grids easily
11 lines (10 loc) • 604 B
TypeScript
import { BoundingBox, Ellipse, Hex, HexPrototype, HexSettings, Orientation, Point } from '../types';
export declare const defaultHexSettings: HexSettings;
export declare const createHexPrototype: <T extends Hex>(options?: Partial<HexPrototypeOptions | Omit<T, keyof HexPrototypeOptions>> | undefined) => T;
export declare type OriginFn = <T extends Omit<HexPrototype, 'origin'>>(prototype: T) => Point;
export interface HexPrototypeOptions {
dimensions: Ellipse | BoundingBox | number;
orientation: Orientation | 'pointy' | 'flat';
origin: Point | 'topLeft' | OriginFn;
offset: number;
}