// generated by diplomat-tool
import type { DefinitionRegion } from "./DefinitionRegion.mjs"
import type { NucleationError } from "./NucleationError.mjs"
import type { Schematic } from "./Schematic.mjs"
import type { pointer, codepoint } from "./diplomat-runtime.d.ts";



/**
 * Namespace type for the schematic-attached definition-region operations
 * (PORTING rule 12; the `Schematic` opaque lives in another module, so
 * these are statics taking it explicitly, like `Autostack`).
 */
export class SchematicRegions {
    /** @internal */
    get ffiValue(): pointer;
    /** @internal */
    constructor();


    /**
     * Insert (or overwrite) `region` under `name`.
     */
    static add(schematic: Schematic, name: string, region: DefinitionRegion): void;

    /**
     * Overwrite the region stored under `name` (identical to `add` in the
     * old ABI too; kept as a separate method for 1:1 coverage of
     * `schematic_update_region`).
     */
    static update(schematic: Schematic, name: string, region: DefinitionRegion): void;

    /**
     * A copy of the region stored under `name`. Errors with `NotFound` when
     * absent.
     */
    static get(schematic: Schematic, name: string): DefinitionRegion;

    /**
     * Remove the region stored under `name`. Errors with `NotFound` when
     * absent.
     */
    static remove(schematic: Schematic, name: string): void;

    /**
     * The names of every definition region, written as a JSON array string.
     */
    static namesJson(schematic: Schematic): string;

    /**
     * Create an empty region under `name`.
     */
    static create(schematic: Schematic, name: string): void;

    /**
     * Create a single-point region under `name`.
     */
    static createFromPoint(schematic: Schematic, name: string, x: number, y: number, z: number): void;

    /**
     * Create a single-box region under `name`.
     */
    static createFromBounds(schematic: Schematic, name: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): void;

    /**
     * Create a single-box region under `name` and return a copy of it.
     */
    static createRegion(schematic: Schematic, name: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): DefinitionRegion;

    /**
     * Add a box to the region stored under `name`. Errors with `NotFound`
     * when absent.
     */
    static addBoundsTo(schematic: Schematic, name: string, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): void;

    /**
     * Add a point to the region stored under `name`. Errors with `NotFound`
     * when absent.
     */
    static addPointTo(schematic: Schematic, name: string, x: number, y: number, z: number): void;

    /**
     * Set a metadata entry on the region stored under `name`. Errors with
     * `NotFound` when absent.
     */
    static setMetadataOn(schematic: Schematic, name: string, key: string, value: string): void;

    /**
     * Shift the region stored under `name` by (`dx`, `dy`, `dz`). Errors
     * with `NotFound` when absent.
     */
    static shiftRegion(schematic: Schematic, name: string, dx: number, dy: number, dz: number): void;
}