opengeometry 2.0.18 → 3.0.0

package/src/shapes/analytic-solid.d.ts

@@ -1,304 +0,0 @@
-import * as THREE from "three";
-import { type AnalyticTessellationData } from "../rendering/analytic-tessellation.js";
-import { AnalyticExchangeBodyV2 } from "../export/analytic-ifc.js";
-export interface AnalyticFrame {
-    origin: [number, number, number];
-    x: [number, number, number];
-    y: [number, number, number];
-    z: [number, number, number];
-}
-export interface AnalyticAccuracy {
-    geometric: number;
-    intersection: number;
-    tessellation: number;
-    exchange: number;
-}
-export interface AnalyticAnnularSectorOpening {
-    id: string;
-    angle: number;
-    width: number;
-    bottom: number;
-    height: number;
-}
-export type AnalyticProfileEdge = {
-    kind: "line";
-    from: [number, number];
-    to: [number, number];
-} | {
-    kind: "arc";
-    center: [number, number];
-    radius: number;
-    startAngle: number;
-    sweepAngle: number;
-};
-export type AnalyticPolygonLoftAlignment = "auto" | {
-    upperStartIndex: number;
-    reverseUpper?: boolean;
-};
-export interface AnalyticProjectionCamera {
-    position: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    target: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    up: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    near: number;
-    projection_mode: "Orthographic" | "Perspective";
-}
-export interface AnalyticProjectionHlr {
-    hide_hidden_edges: boolean;
-}
-interface AnalyticOptions {
-    ogid?: string;
-    frame?: AnalyticFrame;
-    accuracy?: AnalyticAccuracy;
-    deflection?: number;
-    color?: THREE.ColorRepresentation;
-}
-export type AnalyticPrimitiveOptions = AnalyticOptions & ({
-    kind: "cuboid";
-    width: number;
-    depth: number;
-    height: number;
-} | {
-    kind: "linearExtrusion";
-    outer: [number, number][];
-    holes: [number, number][][];
-    height: number;
-} | {
-    kind: "arcEdgedExtrusion";
-    outer: AnalyticProfileEdge[];
-    holes?: AnalyticProfileEdge[][];
-    height: number;
-} | {
-    kind: "polygonLoft";
-    lower: [number, number, number][];
-    upper: [number, number, number][];
-    alignment?: AnalyticPolygonLoftAlignment;
-} | {
-    kind: "boxWithArchedOpening";
-    width: number;
-    depth: number;
-    height: number;
-    opening: {
-        id: string;
-        station: number;
-        width: number;
-        bottom: number;
-        height: number;
-    };
-} | {
-    kind: "planarPolyhedron";
-    vertices: [number, number, number][];
-    faces: number[][];
-} | {
-    kind: "cylinder" | "cone";
-    radius: number;
-    height: number;
-} | {
-    kind: "cylinderSector";
-    radius: number;
-    height: number;
-    startAngle: number;
-    sweepAngle: number;
-} | {
-    kind: "sphere";
-    radius: number;
-} | {
-    kind: "frustum";
-    lowerRadius: number;
-    upperRadius: number;
-    height: number;
-} | {
-    kind: "torus";
-    majorRadius: number;
-    minorRadius: number;
-} | {
-    kind: "annularSectorExtrusion";
-    radius: number;
-    thickness: number;
-    height: number;
-    startAngle: number;
-    sweepAngle: number;
-} | {
-    kind: "annularSectorExtrusionWithOpenings";
-    radius: number;
-    thickness: number;
-    height: number;
-    startAngle: number;
-    sweepAngle: number;
-    openings: AnalyticAnnularSectorOpening[];
-} | {
-    kind: "annularSectorExtrusionWithArchedOpening";
-    radius: number;
-    thickness: number;
-    height: number;
-    startAngle: number;
-    sweepAngle: number;
-    opening: AnalyticAnnularSectorOpening;
-} | {
-    kind: "coaxialCircleLoft";
-    lowerRadius: number;
-    upperRadius: number;
-    height: number;
-} | {
-    kind: "revolvedRectangle";
-    innerRadius: number;
-    outerRadius: number;
-    height: number;
-} | {
-    kind: "chamferedCuboid";
-    width: number;
-    depth: number;
-    height: number;
-    chamfer: number;
-} | {
-    kind: "filletedCylinder";
-    radius: number;
-    height: number;
-    filletRadius: number;
-});
-export type AnalyticBooleanOp = "union" | "intersection" | "subtraction";
-export type AnalyticPointClassification = "inside" | "outside" | "boundary" | "unknown";
-export interface AnalyticBooleanReport {
-    operation: AnalyticBooleanOp;
-    quality: {
-        kind: "Analytic";
-    };
-    contacts: [number, number, number][];
-    coincident: boolean;
-    face_mappings: {
-        source: {
-            entity: string;
-            body: string;
-            key: string;
-            face: number;
-        };
-        result_faces: number[];
-    }[];
-}
-export interface AnalyticBrepOptions extends Omit<AnalyticOptions, "ogid" | "frame" | "accuracy"> {
-    kind: "brep";
-    serialized: string;
-}
-export interface AnalyticTessellationStats {
-    requestedDeflection: number;
-    achievedDeflection: number;
-    triangleCount: number;
-    faceCount: number;
-    revision: bigint;
-}
-export interface AnalyticTessellationOptions {
-    maxTriangles?: number;
-}
-export interface AnalyticStepExport {
-    text: string;
-    report: {
-        schema_version: 2;
-        revision: string;
-        length_unit: "metre" | "millimetre";
-        quality: {
-            kind: string;
-        };
-        faces: number;
-        edges: number;
-        solids: number;
-        cavity_shells: number;
-        collapsed_chart_uses: number;
-        geometric_tolerance: number;
-        exchange_error_bound: number;
-        validation_level: string;
-    };
-}
-export interface AnalyticStlExport {
-    bytes: Uint8Array;
-    report: {
-        schema_version: 2;
-        revision: string;
-        triangle_count: number;
-        requested_deflection: number;
-        achieved_deflection: number;
-        float32_encoding_error: number;
-        quality: "tessellated_from_analytic_brep";
-    };
-}
-export declare class AnalyticSolid extends THREE.Group {
-    readonly ogid: string;
-    readonly surface: THREE.Mesh<THREE.BufferGeometry, THREE.MeshStandardMaterial>;
-    readonly featureOutline: THREE.LineSegments<THREE.BufferGeometry, THREE.LineBasicMaterial>;
-    private kernel;
-    private triangleFaces;
-    private outlineEdges;
-    private disposed;
-    private lastDeflection;
-    private booleanReport?;
-    get report(): AnalyticBooleanReport | undefined;
-    get isDisposed(): boolean;
-    get modelRevision(): bigint;
-    get deflection(): number;
-    get color(): THREE.Color;
-    set color(value: THREE.ColorRepresentation);
-    get outline(): boolean;
-    set outline(value: boolean);
-    constructor(options: AnalyticPrimitiveOptions | AnalyticBrepOptions);
-    static fromBrep(serialized: string, options?: Omit<AnalyticBrepOptions, "kind" | "serialized">): AnalyticSolid;
-    boolean(other: AnalyticSolid, operation: AnalyticBooleanOp, options?: {
-        deflection?: number;
-        color?: THREE.ColorRepresentation;
-    }): AnalyticSolid;
-    union(other: AnalyticSolid, options?: {
-        deflection?: number;
-        color?: THREE.ColorRepresentation;
-    }): AnalyticSolid;
-    intersection(other: AnalyticSolid, options?: {
-        deflection?: number;
-        color?: THREE.ColorRepresentation;
-    }): AnalyticSolid;
-    subtract(cutters: AnalyticSolid[], options?: {
-        deflection?: number;
-        color?: THREE.ColorRepresentation;
-    }): AnalyticSolid;
-    shell(thickness: number, options?: {
-        deflection?: number;
-        color?: THREE.ColorRepresentation;
-    }): AnalyticSolid;
-    getBrepSerialized(): string;
-    getBrepData(): Record<string, unknown>;
-    /** Rebuilds authored analytic geometry while preserving the wrapper and placement. */
-    protected replaceDefinition(options: AnalyticPrimitiveOptions): AnalyticTessellationStats;
-    getWorldBrepSerialized(): string;
-    prepareIfcExchange(): AnalyticExchangeBodyV2;
-    exportIfc(): {
-        text: string;
-        report: AnalyticExchangeBodyV2;
-    };
-    /** Exports world placement and authored metre geometry, converted once to the selected STEP unit. */
-    exportStep(lengthUnit?: "metre" | "millimetre"): AnalyticStepExport;
-    /** Exports a binary STL tessellated from the placed analytic BRep at an explicit error budget. */
-    exportStl(deflection?: number): AnalyticStlExport;
-    faceIdForTriangle(triangle: number): number | undefined;
-    edgeIdForOutlineSegment(segment: number): number | undefined;
-    /** Evaluates the oriented support normal at a projected model-space point; this does not classify trim membership. */
-    normalAtFace(faceId: number, modelPoint: THREE.Vector3): THREE.Vector3;
-    /** Classifies a world-space point against the regularized material represented by this solid. */
-    classifyPoint(worldPoint: THREE.Vector3): AnalyticPointClassification;
-    projectTo2DLines(camera: AnalyticProjectionCamera, hlr: AnalyticProjectionHlr, deflection?: number): string;
-    getModelBounds(): THREE.Box3;
-    retessellate(deflection: number): AnalyticTessellationStats;
-    tessellate(deflection: number, options?: AnalyticTessellationOptions): AnalyticTessellationData;
-    /** Applies a transient worker mesh only when it still matches this authored model revision. */
-    applyTessellation(result: AnalyticTessellationData, deflection: number): AnalyticTessellationStats;
-    dispose(): void;
-    private checkActive;
-    private worldKernel;
-}
-export {};

package/src/shapes/cuboid.d.ts

@@ -1,62 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import * as THREE from "three";
-import { AnalyticSolid, type AnalyticAccuracy } from "./analytic-solid.js";
-export interface CuboidPlacementOptions {
-    translation?: Vector3;
-    rotation?: Vector3;
-    scale?: Vector3;
-}
-export interface ICuboidOptions extends CuboidPlacementOptions {
-    ogid?: string;
-    center?: Vector3;
-    width?: number;
-    height?: number;
-    depth?: number;
-    color?: THREE.ColorRepresentation;
-    deflection?: number;
-    accuracy?: AnalyticAccuracy;
-}
-export type CuboidConfigUpdate = Partial<Omit<ICuboidOptions, "ogid" | "translation" | "rotation" | "scale">>;
-export type CuboidPlacementUpdate = CuboidPlacementOptions;
-interface NormalizedCuboidOptions {
-    ogid?: string;
-    center: Vector3;
-    width: number;
-    height: number;
-    depth: number;
-    color: THREE.ColorRepresentation;
-    deflection: number;
-    accuracy?: AnalyticAccuracy;
-    translation: Vector3;
-    rotation: Vector3;
-    scale: Vector3;
-}
-/** Authoritative six-plane BRep with transient tessellation. */
-export declare class Cuboid extends AnalyticSolid {
-    options: NormalizedCuboidOptions;
-    constructor(options?: ICuboidOptions);
-    set width(value: number);
-    get width(): number;
-    set height(value: number);
-    get height(): number;
-    set depth(value: number);
-    get depth(): number;
-    set color(value: THREE.ColorRepresentation);
-    get color(): THREE.Color;
-    setConfig(update: CuboidConfigUpdate): void;
-    getConfig(): Readonly<NormalizedCuboidOptions>;
-    setPlacement(update: CuboidPlacementUpdate): void;
-    setTransform(translation: Vector3, rotation: Vector3, scale: Vector3): void;
-    setTranslation(translation: Vector3): void;
-    setRotation(rotation: Vector3): void;
-    setScale(scale: Vector3): void;
-    getPlacement(): Required<CuboidPlacementOptions>;
-    getAnchor(): Vector3;
-    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
-    canConvertToFreeform(): false;
-    toFreeform(): never;
-    cleanGeometry(): void;
-    discardGeometry(): void;
-    private applyPlacement;
-}
-export {};

package/src/shapes/cylinder.d.ts

@@ -1,36 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import * as THREE from "three";
-import { AnalyticSolid, type AnalyticAccuracy } from "./analytic-solid.js";
-export interface ICylinderOptions {
-    ogid?: string;
-    center?: Vector3;
-    radius?: number;
-    height?: number;
-    startAngle?: number;
-    sweepAngle?: number;
-    deflection?: number;
-    accuracy?: AnalyticAccuracy;
-    color?: THREE.ColorRepresentation;
-}
-interface NormalizedCylinderOptions {
-    ogid?: string;
-    center: Vector3;
-    radius: number;
-    height: number;
-    startAngle: number;
-    sweepAngle: number;
-    deflection: number;
-    accuracy?: AnalyticAccuracy;
-    color: THREE.ColorRepresentation;
-}
-/** Authoritative Plane/Cylinder BRep with transient deflection tessellation. */
-export declare class Cylinder extends AnalyticSolid {
-    readonly options: Readonly<NormalizedCylinderOptions>;
-    constructor(options?: ICylinderOptions);
-    get radius(): number;
-    get height(): number;
-    get startAngle(): number;
-    get sweepAngle(): number;
-    getAnchor(): THREE.Vector3;
-}
-export {};

package/src/shapes/index.d.ts

@@ -1,11 +0,0 @@
-/**
- * High-level 3D shape wrappers backed by the OpenGeometry kernel.
- */
-export * from './polygon.js';
-export * from './solid.js';
-export * from './cylinder.js';
-export * from './cuboid.js';
-export * from './opening.js';
-export * from './sphere.js';
-export * from './wedge.js';
-export * from './sweep.js';

package/src/shapes/opening.d.ts

@@ -1,31 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import * as THREE from "three";
-import { AnalyticSolid, type AnalyticAccuracy } from "./analytic-solid.js";
-import { Cuboid, type CuboidConfigUpdate, type CuboidPlacementOptions } from "./cuboid.js";
-export interface IOpeningOptions extends CuboidPlacementOptions {
-    ogid?: string;
-    center?: Vector3;
-    width?: number;
-    height?: number;
-    depth?: number;
-    color?: THREE.ColorRepresentation;
-    deflection?: number;
-    accuracy?: AnalyticAccuracy;
-}
-export type OpeningPlacementOptions = CuboidPlacementOptions;
-export type OpeningConfigUpdate = CuboidConfigUpdate;
-export type OpeningPlacementUpdate = OpeningPlacementOptions;
-/** Strict BRep v2 subtractive box. */
-export declare class Opening extends Cuboid {
-    constructor(options?: IOpeningOptions);
-    get dimensions(): {
-        width: number;
-        height: number;
-        depth: number;
-    };
-    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
-    subtractFrom(host: AnalyticSolid, options?: {
-        deflection?: number;
-        color?: THREE.ColorRepresentation;
-    }): AnalyticSolid;
-}

package/src/shapes/outline-utils.d.ts

@@ -1,35 +0,0 @@
-import * as THREE from "three";
-import { LineSegments2 } from "three/examples/jsm/lines/LineSegments2.js";
-/**
- * Outline mesh variants used by shape wrappers.
- */
-export type ShapeOutlineMesh = THREE.LineSegments | LineSegments2;
-/**
- * Options for building a shape outline mesh.
- */
-export interface ShapeOutlineMeshOptions {
-    positions: number[];
-    color?: number;
-    fatOutlines?: boolean;
-    outlineWidth?: number;
-}
-/**
- * Clamps outline width inputs to the supported positive finite range.
- */
-export declare function sanitizeOutlineWidth(width?: number): number;
-/**
- * Creates either a thin or fat outline mesh from line segment positions.
- */
-export declare function createShapeOutlineMesh({ positions, color, fatOutlines, outlineWidth, }: ShapeOutlineMeshOptions): ShapeOutlineMesh;
-/**
- * Disposes the geometry and material owned by an outline mesh.
- */
-export declare function disposeShapeOutlineMesh(mesh: ShapeOutlineMesh | null): void;
-/**
- * Updates the color of an existing outline mesh in place.
- */
-export declare function setShapeOutlineColor(mesh: ShapeOutlineMesh | null, color: number): void;
-/**
- * Reads the current outline color, falling back when no outline exists.
- */
-export declare function getShapeOutlineColor(mesh: ShapeOutlineMesh | null, fallback?: number): number;

package/src/shapes/polygon.d.ts

@@ -1,102 +0,0 @@
-import * as THREE from "three";
-import { OGPolygon, Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import { Solid } from "./solid.js";
-import { type PolygonLoftOptions } from "../operations/loft.js";
-/**
- * Construction options for a planar polygon.
- */
-export interface IPolygonOptions {
-    ogid?: string;
-    vertices: Vector3[];
-    holes?: Vector3[][];
-    color: number;
-    fatOutlines?: boolean;
-    outlineWidth?: number;
-    translation?: Vector3;
-    rotation?: Vector3;
-    scale?: Vector3;
-}
-export interface PolygonPlacementOptions {
-    translation?: Vector3;
-    rotation?: Vector3;
-    scale?: Vector3;
-}
-/**
- * Partial polygon config updates that regenerate the profile when geometry changes.
- */
-export type PolygonConfigUpdate = Partial<Omit<IPolygonOptions, "translation" | "rotation" | "scale">>;
-/**
- * Placement updates accepted by `Polygon`.
- */
-export type PolygonPlacementUpdate = PolygonPlacementOptions;
-/**
- * Planar polygon mesh with support for holes, booleans, and extrusion to `Solid`.
- */
-export declare class Polygon extends THREE.Mesh {
-    #private;
-    ogid: string;
-    options: IPolygonOptions;
-    polygon: OGPolygon;
-    private _outlineEnabled;
-    private _fatOutlines;
-    private _outlineWidth;
-    private _outlineColor;
-    set color(color: number);
-    get color(): number;
-    constructor(options?: IPolygonOptions);
-    validateOptions(): void;
-    setConfig(options: PolygonConfigUpdate): void;
-    getConfig(): IPolygonOptions;
-    getAnchor(): Vector3;
-    setAnchor(anchor: Vector3): void;
-    resetAnchor(): void;
-    setPlacement(placement: PolygonPlacementUpdate): void;
-    setTransform(translation: Vector3, rotation: Vector3, scale: Vector3): void;
-    setTranslation(translation: Vector3): void;
-    setRotation(rotation: Vector3): void;
-    setScale(scale: Vector3): void;
-    getPlacement(): import("../editor.js").ParametricPlacement;
-    /**
-     * Returns the editing capability payload advertised by parametric wrappers.
-     */
-    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
-    /**
-     * Polygon always supports conversion into the freeform editing wrapper.
-     */
-    canConvertToFreeform(): boolean;
-    /**
-     * Returns a freeform wrapper for direct BRep editing of this polygon.
-     */
-    toFreeform(id?: string): import("../freeform.js").FreeformGeometry;
-    cleanGeometry(): void;
-    generateGeometry(): void;
-    addVertices(vertices: Vector3[]): void;
-    addHole(holeVertices: Vector3[]): void;
-    /**
-     * Builds a kernel-backed `Solid` by extruding this polygon face by `height`.
-     *
-     * This is the recommended public path when a browser CAD or AEC workflow
-     * starts from a planar profile and needs a boolean-ready solid.
-     */
-    extrude(height: number): Solid;
-    /** Builds a capped analytic ruled loft from this profile to `other`. */
-    loftTo(other: Polygon, options?: PolygonLoftOptions): import("./analytic-solid.js").AnalyticSolid;
-    /**
-     * Returns the serialized BRep payload for this polygon.
-     */
-    getBrepData(): string | null;
-    private worldProfilePoints;
-    set outlineColor(color: number);
-    get outlineColor(): number;
-    set outline(enable: boolean);
-    get outline(): boolean;
-    set fatOutlines(value: boolean);
-    get fatOutlines(): boolean;
-    set outlineWidth(value: number);
-    get outlineWidth(): number;
-    disposeGeometryMaterial(): void;
-    private clearOutlineMesh;
-    dispose(): void;
-    private writePositionsToGeometry;
-    private disposeResources;
-}

package/src/shapes/solid.d.ts

@@ -1,108 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import * as THREE from "three";
-import { type FreeformGeometry } from "../freeform.js";
-import type { FreeformSource } from "../freeform/types.js";
-/**
- * Construction options for a generic BRep-backed solid.
- */
-export interface ISolidOptions {
-    ogid?: string;
-    brep: FreeformSource;
-    color: number;
-    fatOutlines?: boolean;
-    outlineWidth?: number;
-    anchor?: Vector3;
-    translation?: Vector3;
-    rotation?: Vector3;
-    scale?: Vector3;
-}
-/**
- * Placement updates accepted by `Solid`.
- */
-export interface SolidPlacementOptions {
-    translation?: Vector3;
-    rotation?: Vector3;
-    scale?: Vector3;
-}
-/**
- * Additional options accepted when creating a `Solid` through face extrusion.
- */
-export interface ExtrudeSolidOptions extends Omit<ISolidOptions, "brep" | "ogid" | "anchor" | "translation" | "rotation" | "scale"> {
-    ogid?: string;
-    anchor?: Vector3;
-    translation?: Vector3;
-    rotation?: Vector3;
-    scale?: Vector3;
-}
-/**
- * Generic renderable BRep-backed solid used for extrusion outputs and other
- * kernel results that are not dedicated parametric shapes.
- */
-export declare class Solid extends THREE.Mesh {
-    #private;
-    ogid: string;
-    options: ISolidOptions;
-    private solid;
-    private _outlineEnabled;
-    private _fatOutlines;
-    private _outlineWidth;
-    private _outlineColor;
-    set color(color: number);
-    get color(): number;
-    constructor(options: ISolidOptions);
-    /**
-     * Extrudes a face-like BRep source and wraps the result as a renderable solid.
-     *
-     * Prefer `polygon.extrude(height)` when the source is already a `Polygon`.
-     */
-    static extrude(source: FreeformSource, height: number, options: ExtrudeSolidOptions): Solid;
-    /**
-     * Returns the current placement values as cloned vectors.
-     */
-    getPlacement(): import("../editor.js").ParametricPlacement;
-    /**
-     * Applies translation, rotation, and scale updates to the wrapped BRep.
-     */
-    setPlacement(placement: SolidPlacementOptions): void;
-    setTransform(translation: Vector3, rotation: Vector3, scale: Vector3): void;
-    setTranslation(translation: Vector3): void;
-    setRotation(rotation: Vector3): void;
-    setScale(scale: Vector3): void;
-    getAnchor(): Vector3;
-    setAnchor(anchor: Vector3): void;
-    /**
-     * Solid is always convertible back to the freeform editing wrapper.
-     */
-    canConvertToFreeform(): boolean;
-    /**
-     * Returns a freeform wrapper for direct editing of this solid's BRep.
-     */
-    toFreeform(id?: string): FreeformGeometry;
-    /**
-     * Returns the world-space serialized BRep payload for this solid.
-     */
-    getBrepSerialized(): string;
-    /**
-     * Returns the local-space serialized BRep payload for this solid.
-     */
-    getLocalBrepSerialized(): string;
-    /**
-     * Returns the parsed world-space BRep object for this solid.
-     */
-    getBrepData(): any;
-    /**
-     * Rebuilds the visible mesh and outline from the current freeform geometry.
-     */
-    generateGeometry(): void;
-    set outlineColor(color: number);
-    get outlineColor(): number;
-    set outline(enable: boolean);
-    get outline(): boolean;
-    set fatOutlines(value: boolean);
-    get fatOutlines(): boolean;
-    set outlineWidth(value: number);
-    get outlineWidth(): number;
-    clearOutlineMesh(): void;
-    private getPlacementTransform;
-    private writePositionsToGeometry;
-}