opengeometry 2.0.17 → 3.0.0

package/src/editor/types.d.ts

@@ -1,223 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import type { ObjectTransformation } from "../freeform/types.js";
-/**
- * Numeric identifier used for faces, edges, and vertices in freeform topology APIs.
- */
-export type TopologyId = number;
-/**
- * Kernel edit permissions shared by global and feature-scoped freeform capabilities.
- */
-export interface FreeformOperationCapabilities {
-    canPushPullFace: boolean;
-    canMoveFace: boolean;
-    canExtrudeFace: boolean;
-    canCutFace: boolean;
-    canMoveEdge: boolean;
-    canMoveVertex: boolean;
-    canInsertVertexOnEdge: boolean;
-    canRemoveVertex: boolean;
-    canSplitEdge: boolean;
-    canLoopCut: boolean;
-    reasons?: string[];
-}
-/**
- * Global editing capabilities for a freeform geometry object.
- */
-export interface FreeformEditCapabilities extends FreeformOperationCapabilities {
-    editingMode: "freeform";
-    entityType: "freeform";
-    editFamily: "freeform";
-    canEditConfig: false;
-    canEditPlacement: false;
-    canConvertToFreeform: false;
-}
-/**
- * Feature-scoped editing capabilities for a single face, edge, or vertex.
- */
-export interface FreeformFeatureEditCapabilities extends FreeformOperationCapabilities {
-    domain: "face" | "edge" | "vertex";
-    topologyId: TopologyId;
-}
-/**
- * How a topology id changed after an edit.
- */
-export type TopologyRemapStatus = "unchanged" | "split" | "merged" | "deleted";
-/**
- * Maps an old topology id to the ids that replaced it.
- */
-export interface TopologyRemapEntry {
-    old_id: TopologyId;
-    new_ids: TopologyId[];
-    primary_id: TopologyId | null;
-    status: TopologyRemapStatus;
-}
-/**
- * Newly created topology ids emitted by a freeform edit.
- */
-export interface TopologyCreatedIds {
-    faces: TopologyId[];
-    edges: TopologyId[];
-    vertices: TopologyId[];
-}
-/**
- * Topology remap payload returned by edits that change face/edge/vertex ids.
- */
-export interface TopologyRemap {
-    faces: TopologyRemapEntry[];
-    edges: TopologyRemapEntry[];
-    vertices: TopologyRemapEntry[];
-    created_ids: TopologyCreatedIds;
-}
-/**
- * Diagnostic severities returned by freeform validity checks.
- */
-export type DiagnosticSeverity = "info" | "warning" | "error";
-/**
- * Individual diagnostic emitted by a freeform edit or validation pass.
- */
-export interface FreeformDiagnostic {
-    code: string;
-    severity: DiagnosticSeverity;
-    message: string;
-    domain?: string;
-    topology_id?: TopologyId;
-}
-/**
- * Validity summary returned after a freeform edit.
- */
-export interface FreeformValidity {
-    ok: boolean;
-    healed?: boolean;
-    diagnostics: FreeformDiagnostic[];
-}
-/**
- * Face metadata returned by the freeform editor.
- */
-export interface FaceInfo {
-    face_id: TopologyId;
-    centroid: Vector3;
-    normal: Vector3;
-    surface_type: string;
-    loop_ids: TopologyId[];
-    edge_ids: TopologyId[];
-    vertex_ids: TopologyId[];
-    adjacent_face_ids: TopologyId[];
-}
-/**
- * Edge metadata returned by the freeform editor.
- */
-export interface EdgeInfo {
-    edge_id: TopologyId;
-    curve_type: string;
-    start_vertex_id: TopologyId;
-    end_vertex_id: TopologyId;
-    start: Vector3;
-    end: Vector3;
-    incident_face_ids: TopologyId[];
-}
-/**
- * Vertex metadata returned by the freeform editor.
- */
-export interface VertexInfo {
-    vertex_id: TopologyId;
-    position: Vector3;
-    edge_ids: TopologyId[];
-    face_ids: TopologyId[];
-}
-/**
- * Triangulated face render data for topology overlays.
- */
-export interface TopologyFaceRenderData {
-    face_id: TopologyId;
-    positions: number[];
-    indices: number[];
-}
-/**
- * Edge polyline render data for topology overlays.
- */
-export interface TopologyEdgeRenderData {
-    edge_id: TopologyId;
-    positions: number[];
-}
-/**
- * Vertex render data for topology overlays.
- */
-export interface TopologyVertexRenderData {
-    vertex_id: TopologyId;
-    position: Vector3;
-}
-/**
- * Full renderable topology payload emitted by the freeform editor.
- */
-export interface TopologyRenderData {
-    faces: TopologyFaceRenderData[];
-    edges: TopologyEdgeRenderData[];
-    vertices: TopologyVertexRenderData[];
-}
-/**
- * Structured result payload returned by freeform edit operations.
- */
-export interface FreeformEditResult {
-    entity_id: string;
-    brep_serialized?: string;
-    local_brep_serialized?: string;
-    geometry_serialized?: string;
-    outline_geometry_serialized?: string;
-    topology_changed: boolean;
-    topology_remap?: TopologyRemap;
-    changed_faces?: TopologyId[];
-    changed_edges?: TopologyId[];
-    changed_vertices?: TopologyId[];
-    validity: FreeformValidity;
-    placement: ObjectTransformation;
-}
-/**
- * Optional flags that control how much auxiliary data an edit returns.
- */
-export interface EditOperationOptions {
-    includeBrepSerialized?: boolean;
-    includeLocalBrepSerialized?: boolean;
-    includeGeometrySerialized?: boolean;
-    includeOutlineGeometrySerialized?: boolean;
-    includeTopologyRemap?: boolean;
-    includeDeltas?: boolean;
-    constraintAxis?: Vector3;
-    constraintPlaneNormal?: Vector3;
-    preserveCoplanarity?: boolean;
-    constraintFrame?: "local" | "world";
-    openSurfaceMode?: boolean;
-}
-/**
- * High-level editing mode families exposed by public wrappers.
- */
-export type EditingMode = "parametric" | "freeform";
-export type ParametricEntityType = "line" | "polyline" | "arc" | "curve" | "elliptical_arc" | "rectangle" | "polygon" | "cuboid" | "cylinder" | "sphere" | "wedge" | "opening" | "sweep";
-export type EntityType = ParametricEntityType | "freeform";
-export type EditFamily = "profile" | "curve" | "box" | "radial" | "wedge" | "sweep" | "freeform";
-export type ParametricEditFamily = Exclude<EditFamily, "freeform">;
-/**
- * Shared placement structure for parametric wrappers.
- */
-export interface ParametricPlacement {
-    translation: Vector3;
-    rotation: Vector3;
-    scale: Vector3;
-}
-/**
- * Base capability payload shared by parametric and freeform wrappers.
- */
-export interface BaseEditCapabilities {
-    editingMode: EditingMode;
-    entityType: EntityType;
-    editFamily: EditFamily;
-    canEditConfig: boolean;
-    canEditPlacement: boolean;
-    canConvertToFreeform: boolean;
-}
-/**
- * Capability payload returned by parametric wrappers such as `Polygon` or `Cuboid`.
- */
-export interface ParametricEditCapabilities extends BaseEditCapabilities {
-    editingMode: "parametric";
-    entityType: ParametricEntityType;
-}

package/src/examples/booleans.d.ts

@@ -1,24 +0,0 @@
-import * as THREE from "three";
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import { BooleanExecutionOptions } from "../operations/boolean.js";
-import { AnalyticSolid } from "../shapes/analytic-solid.js";
-export type BooleanExampleOperation = "union" | "intersection" | "subtraction";
-export type BooleanExampleMode = "solid" | "polygon" | "extruded";
-export interface BooleanExampleBuildOptions extends BooleanExecutionOptions {
-    mode: BooleanExampleMode;
-    sphereCenter?: Vector3;
-    polygonOffset?: Vector3;
-    extrudedOffset?: Vector3;
-}
-export interface BooleanExampleBuildResult {
-    group: THREE.Group;
-    lhs: THREE.Object3D;
-    rhs: THREE.Object3D;
-    result: AnalyticSolid;
-    title: string;
-    description: string;
-}
-/**
- * Builds a complete operand/result scene group for a boolean example page.
- */
-export declare function createBooleanExample(operation: BooleanExampleOperation, options: BooleanExampleBuildOptions): BooleanExampleBuildResult;

package/src/examples/editor-modes.d.ts

@@ -1,20 +0,0 @@
-import * as THREE from "three";
-import { FreeformEditResult } from "../editor.js";
-import { Line } from "../primitives/line.js";
-import { Polygon } from "../shapes/polygon.js";
-import { Cuboid } from "../shapes/cuboid.js";
-/**
- * Demonstrates strict v2 parametric solid edits and the separate sampled-wire
- * freeform editor. Analytic solid freeform conversion is intentionally unsupported.
- */
-export declare function createEditorModesExample(scene: THREE.Scene): {
-    polygon: Polygon;
-    cuboid: Cuboid;
-    guideLine: Line;
-    polygonCapabilities: import("../editor.js").ParametricEditCapabilities;
-    cuboidCapabilities: import("../editor.js").ParametricEditCapabilities;
-    guideLineCapabilities: import("../editor.js").ParametricEditCapabilities;
-    guideLineFreeform: import("../freeform.js").FreeformGeometry;
-    guideLineEditor: import("../editor.js").FreeformEditor;
-    guideLineSplitResult: FreeformEditResult | null;
-};

package/src/examples/index.d.ts

@@ -1,11 +0,0 @@
-/**
- * Reusable scene example builders for primitives, shapes, and operations.
- */
-export * from './primitives.js';
-export * from './shapes.js';
-export * from './sweep.js';
-export * from './offset.js';
-export * from './offset-ring-variable.js';
-export * from './ribbon-from-offsets.js';
-export * from './booleans.js';
-export * from './editor-modes.js';

package/src/examples/offset-ring-variable.d.ts

@@ -1,13 +0,0 @@
-import * as THREE from "three";
-import { Polyline } from "../primitives/polyline.js";
-/**
- * Variable (per-edge) ring inset: a rectangular "parcel" inset by front 6 /
- * side 1.5 / rear 3 setbacks, and a waisted (dumbbell) parcel whose uniform
- * 3 m inset SPLITS into two disjoint buildable envelopes — the case a uniform
- * offset cannot express.
- */
-export declare function createOffsetRingVariableExample(scene: THREE.Scene): {
-    parcelOutline: Polyline;
-    dumbbellOutline: Polyline;
-    envelopes: Polyline[];
-};

package/src/examples/offset.d.ts

@@ -1,18 +0,0 @@
-import * as THREE from "three";
-import { Line } from "../primitives/line.js";
-import { Polyline } from "../primitives/polyline.js";
-import { Rectangle } from "../primitives/rectangle.js";
-import { Curve } from "../primitives/curve.js";
-export declare function createOffsetExample(scene: THREE.Scene): {
-    baseLine: Line;
-    lineOffsetPrimitive: Line;
-    basePolyline: Polyline;
-    polylineOffsetPrimitive: Polyline;
-    baseRectangle: Rectangle;
-    rectangleOffsetPrimitive: Polyline;
-    baseCurve: Curve;
-    curveOffsetPrimitive: Polyline;
-    polylineOffset: import("../primitives/polyline.js").IOffsetResult;
-    rectangleOffset: import("../primitives/rectangle.js").IRectangleOffsetResult;
-    curveOffset: import("../primitives/curve.js").ICurveOffsetResult;
-};

package/src/examples/primitives.d.ts

@@ -1,16 +0,0 @@
-import * as THREE from "three";
-import { Arc } from "../primitives/arc.js";
-import { Curve } from "../primitives/curve.js";
-import { Line } from "../primitives/line.js";
-import { Polyline } from "../primitives/polyline.js";
-import { Rectangle } from "../primitives/rectangle.js";
-/**
- * Adds a basic primitives showcase to the provided scene.
- */
-export declare function createPrimitivesExample(scene: THREE.Scene): {
-    line: Line;
-    polyline: Polyline;
-    arc: Arc;
-    rectangle: Rectangle;
-    curve: Curve;
-};

package/src/examples/ribbon-from-offsets.d.ts

@@ -1,33 +0,0 @@
-import * as THREE from "three";
-import { Polyline } from "../primitives/polyline.js";
-import { AnalyticSolid } from "../shapes/analytic-solid.js";
-import { Polygon } from "../shapes/polygon.js";
-export interface RibbonFromOffsetsOptions {
-    /** Subtract one exact coextensive through slot. Default `false`. */
-    cutThroughSlot?: boolean;
-    /** Width of the through slot along its centerline segment. Default `0.6`. */
-    slotWidth?: number;
-    /**
-     * Ribbon extrusion height in meters. Default `2.6` to match the example HTML.
-     */
-    height?: number;
-}
-/**
- * Renders a human-readable description for an analytic geometry error (or any
- * other thrown value). Used by the example HTML to surface kernel failures
- * in a status panel without losing the structured payload.
- */
-export declare function describeRibbonSubtractError(error: unknown): string;
-export declare function createRibbonFromOffsetsExample(scene: THREE.Scene, options?: RibbonFromOffsetsOptions): {
-    centerline: Polyline;
-    leftOffsetPolyline: Polyline;
-    rightOffsetPolyline: Polyline;
-    ribbonPolygon: Polygon;
-    leftOffset: import("../primitives/polyline.js").IOffsetResult;
-    rightOffset: import("../primitives/polyline.js").IOffsetResult;
-    cutResult: {
-        ribbon: THREE.Object3D;
-        cutters: AnalyticSolid[];
-    } | null;
-    cutError: unknown;
-};

package/src/examples/shapes.d.ts

@@ -1,20 +0,0 @@
-import * as THREE from "three";
-import { Cuboid } from "../shapes/cuboid.js";
-import { Cylinder } from "../shapes/cylinder.js";
-import { Opening } from "../shapes/opening.js";
-import { Polygon } from "../shapes/polygon.js";
-import { Sweep } from "../shapes/sweep.js";
-import { Sphere } from "../shapes/sphere.js";
-import { Wedge } from "../shapes/wedge.js";
-/**
- * Adds a basic shapes showcase to the provided scene.
- */
-export declare function createShapesExample(scene: THREE.Scene): {
-    polygon: Polygon;
-    cuboid: Cuboid;
-    cylinder: Cylinder;
-    wedge: Wedge;
-    sphere: Sphere;
-    opening: Opening;
-    sweep: Sweep;
-};

package/src/examples/sweep.d.ts

@@ -1,9 +0,0 @@
-import * as THREE from "three";
-import { Polyline } from "../primitives/polyline.js";
-import { Rectangle } from "../primitives/rectangle.js";
-import { Sweep } from "../shapes/sweep.js";
-export declare function createSweepExample(scene: THREE.Scene): {
-    pathPrimitive: Polyline;
-    profilePrimitive: Rectangle;
-    sweep: Sweep;
-};

package/src/freeform/geometry.d.ts

@@ -1,82 +0,0 @@
-import { OGFreeformGeometry, Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import type { CreateFreeformGeometryOptions, FreeformSource, ObjectTransformation } from "./types.js";
-/**
- * Thin client-side wrapper around the kernel `OGFreeformGeometry` object.
- */
-export declare class FreeformGeometry {
-    private readonly geometry;
-    constructor(geometry: OGFreeformGeometry);
-    /**
-     * Returns the stable kernel-side id for this freeform geometry object.
-     */
-    getId(): string;
-    /**
-     * Returns the world-space serialized BRep payload.
-     */
-    getBrepSerialized(): string;
-    /**
-     * Returns the local-space serialized BRep payload.
-     */
-    getLocalBrepSerialized(): string;
-    /**
-     * Returns the serialized triangle position buffer emitted by the kernel.
-     */
-    getGeometrySerialized(): string;
-    /**
-     * Returns world-space triangle positions as a plain number array.
-     */
-    getGeometryBuffer(): number[];
-    /**
-     * Returns local-space triangle positions as a plain number array.
-     */
-    getLocalGeometryBuffer(): number[];
-    /**
-     * Returns the serialized outline buffer emitted by the kernel.
-     */
-    getOutlineGeometrySerialized(): string;
-    /**
-     * Returns world-space outline segment positions as a plain number array.
-     */
-    getOutlineGeometryBuffer(): number[];
-    /**
-     * Returns local-space outline segment positions as a plain number array.
-     */
-    getLocalOutlineGeometryBuffer(): number[];
-    /**
-     * Returns the current normalized placement for this freeform geometry.
-     */
-    getPlacement(): ObjectTransformation;
-    /**
-     * Replaces the full placement transform in one call.
-     */
-    setPlacement(transform: ObjectTransformation): void;
-    /**
-     * Sets translation, rotation, and scale without changing the current anchor.
-     */
-    setTransform(translation: Vector3, rotation: Vector3, scale: Vector3): void;
-    /**
-     * Updates only the translation component of the placement.
-     */
-    setTranslation(translation: Vector3): void;
-    /**
-     * Updates only the rotation component of the placement.
-     */
-    setRotation(rotation: Vector3): void;
-    /**
-     * Updates only the scale component of the placement.
-     */
-    setScale(scale: Vector3): void;
-    /**
-     * Updates the explicit modeling anchor used by downstream transforms.
-     */
-    setAnchor(anchor: Vector3): void;
-    /** @internal */
-    getKernelGeometry(): OGFreeformGeometry;
-}
-/**
- * Creates a `FreeformGeometry` wrapper from serialized BRep JSON, a parsed
- * BRep object, or another wrapper exposing BRep accessors.
- */
-export declare function createFreeformGeometry(source: FreeformSource, options?: CreateFreeformGeometryOptions): FreeformGeometry;
-/** Triangulates an explicitly faceted BRep, including its planar face holes. */
-export declare function tessellateFacetedBrep(serialized: string): Float64Array;

package/src/freeform/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Freeform geometry types and helpers for working with raw BRep-backed models.
- */
-export * from "./types.js";
-export { FreeformGeometry, createFreeformGeometry, tessellateFacetedBrep } from "./geometry.js";

package/src/freeform/types.d.ts

@@ -1,36 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-/**
- * Placement values accepted when constructing freeform geometry wrappers.
- */
-export interface FreeformPlacementInput {
-    anchor?: Vector3;
-    translation: Vector3;
-    rotation: Vector3;
-    scale: Vector3;
-}
-/**
- * Fully normalized placement state used by freeform editing APIs.
- */
-export interface ObjectTransformation {
-    anchor: Vector3;
-    translation: Vector3;
-    rotation: Vector3;
-    scale: Vector3;
-}
-/**
- * Options for building a `FreeformGeometry` wrapper from a BRep-like source.
- */
-export interface CreateFreeformGeometryOptions {
-    id?: string;
-    placement?: FreeformPlacementInput | ObjectTransformation;
-}
-/**
- * Accepted sources for creating a freeform wrapper.
- */
-export type FreeformSource = string | Record<string, unknown> | {
-    getLocalBrepSerialized?: () => string;
-    getLocalBrepData?: () => unknown;
-    getBrepSerialized?: () => string;
-    getBrepData?: () => unknown;
-    getBrep?: () => unknown;
-};

package/src/markup/spotMarker.d.ts

@@ -1,4 +0,0 @@
-import { CSS2DObject } from "three/examples/jsm/renderers/CSS2DRenderer.js";
-export declare class SpotLabel extends CSS2DObject {
-    constructor();
-}

package/src/operations/analytic-errors.d.ts

@@ -1,8 +0,0 @@
-export type AnalyticGeometryErrorCode = "math" | "invalid_geometry" | "invalid_topology" | "unsupported_geometry" | "ambiguous_profile_alignment" | "coverage_gap" | "singular_parameterization" | "missing_reference" | "unsupported_schema" | "unresolved_intersection" | "unresolved_tessellation" | "limit_exceeded" | "unknown";
-export declare class AnalyticGeometryError extends Error {
-    readonly code: AnalyticGeometryErrorCode;
-    readonly detail: unknown;
-    readonly families?: readonly [string, string];
-    constructor(code: AnalyticGeometryErrorCode, message: string, detail?: unknown);
-}
-export declare function parseAnalyticGeometryError(raw: unknown): AnalyticGeometryError;

package/src/operations/boolean-regions.d.ts

@@ -1,20 +0,0 @@
-import type { OffsetRegion } from "./offset-regions.js";
-export type PlanarBooleanOperation = "union" | "intersection" | "subtraction";
-export type CurvedRegionEdge = {
-    kind: "line";
-    from: [number, number];
-    to: [number, number];
-} | {
-    kind: "arc";
-    center: [number, number];
-    radius: number;
-    start_angle: number;
-    sweep_angle: number;
-};
-export interface CurvedRegion2D {
-    outer: CurvedRegionEdge[];
-    holes: CurvedRegionEdge[][];
-}
-export declare function booleanRegions2D(a: readonly OffsetRegion[], b: readonly OffsetRegion[], operation: PlanarBooleanOperation): OffsetRegion[];
-/** Analytic line/arc region Boolean; output arcs retain their exact circles. */
-export declare function booleanCurvedRegions2D(a: readonly CurvedRegion2D[], b: readonly CurvedRegion2D[], operation: PlanarBooleanOperation): CurvedRegion2D[];

package/src/operations/boolean.d.ts

@@ -1,16 +0,0 @@
-import * as THREE from "three";
-import { AnalyticSolid } from "../shapes/analytic-solid.js";
-/** Rendering and tessellation options applied to an analytic boolean result. */
-export interface BooleanExecutionOptions {
-    deflection?: number;
-    color?: THREE.ColorRepresentation;
-    opacity?: number;
-    transparent?: boolean;
-    side?: THREE.Side;
-    outline?: boolean;
-}
-export type BooleanOperand = AnalyticSolid;
-export declare function booleanUnion(lhs: AnalyticSolid, rhs: AnalyticSolid, options?: BooleanExecutionOptions): AnalyticSolid;
-export declare function booleanIntersection(lhs: AnalyticSolid, rhs: AnalyticSolid, options?: BooleanExecutionOptions): AnalyticSolid;
-export declare function booleanSubtraction(lhs: AnalyticSolid, rhs: AnalyticSolid, options?: BooleanExecutionOptions): AnalyticSolid;
-export declare function executeBooleanSubtractionMany(lhs: BooleanOperand, cutters: BooleanOperand[], options?: BooleanExecutionOptions): AnalyticSolid;

package/src/operations/editor/freeform.d.ts

@@ -1 +0,0 @@
-export { FreeformEditor, createFreeformEditor } from "../../editor/freeform.js";

package/src/operations/editor/index.d.ts

@@ -1 +0,0 @@
-export * from "../../editor.js";

package/src/operations/editor/parametric.d.ts

@@ -1 +0,0 @@
-export { clonePlacement, createParametricEditCapabilities, toObjectTransformation, } from "../../editor/parametric.js";

package/src/operations/editor/types.d.ts

@@ -1 +0,0 @@
-export * from "../../editor/types.js";

package/src/operations/extrude.d.ts

@@ -1,9 +0,0 @@
-import type { FreeformSource } from "../freeform.js";
-/**
- * Sources accepted by the BRep-face extrusion helper.
- */
-export type ExtrudeBrepSource = FreeformSource;
-/**
- * Extrudes the first face or wire in a local BRep payload into a closed solid BRep.
- */
-export declare function extrudeBrepFace(source: ExtrudeBrepSource, height: number): string;

package/src/operations/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * Kernel-backed boolean helpers and renderable result mesh.
- */
-export * from "./boolean.js";
-export * from "./boolean-regions.js";
-export * from "./analytic-errors.js";
-export * from "./extrude.js";
-export * from "./loft.js";
-export * from "./offset-regions.js";

package/src/operations/loft.d.ts

@@ -1,13 +0,0 @@
-import * as THREE from "three";
-import { AnalyticSolid, type AnalyticPolygonLoftAlignment } from "../shapes/analytic-solid.js";
-export type PolygonLoftPoint = readonly [number, number, number];
-export interface PolygonLoftOptions {
-    alignment?: AnalyticPolygonLoftAlignment;
-    deflection?: number;
-    color?: THREE.ColorRepresentation;
-}
-/**
- * Creates a capped ruled solid between two planar polygon sections.
- * Sections must have equal vertex counts and produce planar side faces.
- */
-export declare function loftPolygonSections(sections: readonly [readonly PolygonLoftPoint[], readonly PolygonLoftPoint[]], options?: PolygonLoftOptions): AnalyticSolid;