opengeometry 2.0.1 → 2.0.3

package/src/primitives/rectangle.d.ts

@@ -1,5 +1,8 @@
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
+/**
+ * Construction options for a rectangle profile wrapper.
+ */
 export interface IRectangleOptions {
     ogid?: string;
     center: Vector3;
@@ -12,18 +15,33 @@ export interface IRectangleOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Rectangle`.
+ */
 export interface RectanglePlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Rectangle.setConfig(...)`.
+ */
 export type RectangleConfigUpdate = Partial<Omit<IRectangleOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Rectangle` placement updates.
+ */
 export type RectanglePlacementUpdate = RectanglePlacementOptions;
+/**
+ * Offset result returned by `Rectangle.offset(...)`.
+ */
 export interface IRectangleOffsetResult {
     points: Vector3[];
     beveledVertexIndices: number[];
     isClosed: boolean;
 }
+/**
+ * Rectangle wrapper backed by the kernel OGRectangle primitive.
+ */
 export declare class Rectangle extends THREE.Line {
     ogid: string;
     options: IRectangleOptions;

package/src/shapes/boolean-subtract.d.ts

@@ -1,6 +1,15 @@
 import type { BooleanExecutionOptions, BooleanOperand, BooleanResult } from "../operations/boolean.js";
+/**
+ * Operand types accepted by shape instance `.subtract(...)` helpers.
+ */
 export type ShapeSubtractOperand = BooleanOperand;
+/**
+ * Options accepted by shape instance `.subtract(...)` helpers.
+ */
 export type ShapeSubtractOptions = BooleanExecutionOptions;
+/**
+ * Return type for shape instance `.subtract(...)` helpers.
+ */
 export type ShapeSubtractResult = BooleanResult;
 /**
  * Executes a kernel-backed subtraction for a shape wrapper against another boolean operand.

package/src/shapes/cuboid.d.ts

@@ -2,11 +2,17 @@ import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { ShapeOutlineMesh } from "./outline-utils.js";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Placement updates accepted by `Cuboid`.
+ */
 export interface CuboidPlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Construction options for a cuboid shape.
+ */
 export interface ICuboidOptions extends CuboidPlacementOptions {
     ogid?: string;
     center: Vector3;
@@ -17,8 +23,17 @@ export interface ICuboidOptions extends CuboidPlacementOptions {
     fatOutlines?: boolean;
     outlineWidth?: number;
 }
+/**
+ * Partial config payload accepted by `Cuboid.setConfig(...)`.
+ */
 export type CuboidConfigUpdate = Partial<Omit<ICuboidOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Cuboid` placement updates.
+ */
 export type CuboidPlacementUpdate = CuboidPlacementOptions;
+/**
+ * Box-shaped solid wrapper backed by the kernel cuboid primitive.
+ */
 export declare class Cuboid extends THREE.Mesh {
     #private;
     ogid: string;

package/src/shapes/cylinder.d.ts

@@ -1,6 +1,9 @@
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a cylinder shape.
+ */
 export interface ICylinderOptions {
     ogid?: string;
     center: Vector3;
@@ -15,13 +18,25 @@ export interface ICylinderOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Cylinder`.
+ */
 export interface CylinderPlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Cylinder.setConfig(...)`.
+ */
 export type CylinderConfigUpdate = Partial<Omit<ICylinderOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Cylinder` placement updates.
+ */
 export type CylinderPlacementUpdate = CylinderPlacementOptions;
+/**
+ * Cylinder wrapper backed by the kernel cylindrical primitive.
+ */
 export declare class Cylinder extends THREE.Mesh {
     #private;
     ogid: string;

package/src/shapes/extrusion.d.ts

@@ -0,0 +1,64 @@
+import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
+import * as THREE from "three";
+import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+export interface IExtrusionOptions {
+    ogid?: string;
+    vertices: Vector3[];
+    holes?: Vector3[][];
+    height: number;
+    color: number;
+    fatOutlines?: boolean;
+    outlineWidth?: number;
+    translation?: Vector3;
+    rotation?: Vector3;
+    scale?: Vector3;
+}
+export interface ExtrusionPlacementOptions {
+    translation?: Vector3;
+    rotation?: Vector3;
+    scale?: Vector3;
+}
+export type ExtrusionConfigUpdate = Partial<Omit<IExtrusionOptions, "translation" | "rotation" | "scale">>;
+export type ExtrusionPlacementUpdate = ExtrusionPlacementOptions;
+export declare class Extrusion extends THREE.Mesh {
+    #private;
+    ogid: string;
+    options: IExtrusionOptions;
+    private extrusion;
+    private _outlineEnabled;
+    private _fatOutlines;
+    private _outlineWidth;
+    private _outlineColor;
+    set color(color: number);
+    constructor(options?: IExtrusionOptions);
+    validateOptions(): void;
+    setConfig(options: ExtrusionConfigUpdate): void;
+    getConfig(): IExtrusionOptions;
+    getAnchor(): Vector3;
+    setAnchor(anchor: Vector3): void;
+    resetAnchor(): void;
+    setPlacement(placement: ExtrusionPlacementUpdate): 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;
+    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
+    canConvertToFreeform(): boolean;
+    toFreeform(id?: string): import("../freeform.js").FreeformGeometry;
+    cleanGeometry(): void;
+    generateGeometry(): void;
+    getBrepData(): any;
+    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    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;
+    discardGeometry(): void;
+    private writePositionsToGeometry;
+}

package/src/shapes/index.d.ts

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

package/src/shapes/opening.d.ts

@@ -2,6 +2,9 @@ import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { ShapeOutlineMesh } from "./outline-utils.js";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for an architectural opening volume.
+ */
 export interface IOpeningOptions {
     ogid?: string;
     center: Vector3;
@@ -15,13 +18,25 @@ export interface IOpeningOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Opening`.
+ */
 export interface OpeningPlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Opening.setConfig(...)`.
+ */
 export type OpeningConfigUpdate = Partial<Omit<IOpeningOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Opening` placement updates.
+ */
 export type OpeningPlacementUpdate = OpeningPlacementOptions;
+/**
+ * Opening wrapper used as a subtractive solid in architectural workflows.
+ */
 export declare class Opening extends THREE.Mesh {
     #private;
     ogid: string;

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

@@ -1,14 +1,35 @@
 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,8 +1,10 @@
 import * as THREE from "three";
-import * as OGKernel from "../../opengeometry/pkg/opengeometry.js";
 import { OGPolygon, Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import { ExtrudedShape } from "./extruded-shape.js";
+import { Solid } from "./solid.js";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a planar polygon.
+ */
 export interface IPolygonOptions {
     ogid?: string;
     vertices: Vector3[];
@@ -19,8 +21,17 @@ export interface PolygonPlacementOptions {
     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;
@@ -30,15 +41,13 @@ export declare class Polygon extends THREE.Mesh {
     private _fatOutlines;
     private _outlineWidth;
     private _outlineColor;
-    transformationMatrix: THREE.Matrix4;
     set color(color: number);
     get color(): number;
-    private _geometryCenterOffset;
     constructor(options?: IPolygonOptions);
     validateOptions(): void;
     setConfig(options: PolygonConfigUpdate): void;
     getConfig(): IPolygonOptions;
-    getAnchor(): OGKernel.Vector3;
+    getAnchor(): Vector3;
     setAnchor(anchor: Vector3): void;
     resetAnchor(): void;
     setPlacement(placement: PolygonPlacementUpdate): void;
@@ -47,15 +56,29 @@ export declare class Polygon extends THREE.Mesh {
     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;
-    saveTransformationToBREP(): void;
     addHole(holeVertices: Vector3[]): void;
-    extrude(height?: number, faceId?: number): ExtrudedShape;
+    /**
+     * Builds a kernel-backed `Solid` by extruding this polygon face by `height`.
+     */
+    extrude(height: number): Solid;
+    /**
+     * Returns the serialized BRep payload for this polygon.
+     */
     getBrepData(): string | null;
     /**
      * Subtracts another boolean operand from this polygon.
@@ -73,4 +96,5 @@ export declare class Polygon extends THREE.Mesh {
     private clearOutlineMesh;
     dispose(): void;
     private writePositionsToGeometry;
+    private disposeResources;
 }

package/src/shapes/solid.d.ts

@@ -0,0 +1,111 @@
+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";
+import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.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.
+     */
+    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;
+    /**
+     * Subtracts another boolean operand from this solid.
+     */
+    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    /**
+     * 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;
+}

package/src/shapes/sphere.d.ts

@@ -3,6 +3,9 @@ import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { ShapeOutlineMesh } from "./outline-utils.js";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a sphere shape.
+ */
 export interface ISphereOptions {
     ogid?: string;
     center: Vector3;
@@ -16,13 +19,25 @@ export interface ISphereOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Sphere`.
+ */
 export interface SpherePlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Sphere.setConfig(...)`.
+ */
 export type SphereConfigUpdate = Partial<Omit<ISphereOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Sphere` placement updates.
+ */
 export type SpherePlacementUpdate = SpherePlacementOptions;
+/**
+ * Sphere wrapper backed by the kernel sphere primitive.
+ */
 export declare class Sphere extends THREE.Mesh {
     #private;
     ogid: string;

package/src/shapes/sweep.d.ts

@@ -2,6 +2,9 @@ import * as OGKernel from "../../opengeometry/pkg/opengeometry.js";
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a swept solid.
+ */
 export interface ISweepOptions {
     ogid?: string;
     path: Vector3[];
@@ -15,13 +18,25 @@ export interface ISweepOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Sweep`.
+ */
 export interface SweepPlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Sweep.setConfig(...)`.
+ */
 export type SweepConfigUpdate = Partial<Omit<ISweepOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Sweep` placement updates.
+ */
 export type SweepPlacementUpdate = SweepPlacementOptions;
+/**
+ * Sweep wrapper backed by the kernel sweep primitive.
+ */
 export declare class Sweep extends THREE.Mesh {
     #private;
     ogid: string;

package/src/shapes/wedge.d.ts

@@ -2,6 +2,9 @@ import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { ShapeOutlineMesh } from "./outline-utils.js";
 import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a wedge/prism shape.
+ */
 export interface IWedgeOptions {
     ogid?: string;
     center: Vector3;
@@ -15,13 +18,25 @@ export interface IWedgeOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Wedge`.
+ */
 export interface WedgePlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Wedge.setConfig(...)`.
+ */
 export type WedgeConfigUpdate = Partial<Omit<IWedgeOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Wedge` placement updates.
+ */
 export type WedgePlacementUpdate = WedgePlacementOptions;
+/**
+ * Wedge wrapper backed by the kernel wedge primitive.
+ */
 export declare class Wedge extends THREE.Mesh {
     #private;
     ogid: string;

package/src/shapes/extruded-shape.d.ts

@@ -1,49 +0,0 @@
-import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
-import * as THREE from "three";
-import type { ObjectTransformation } from "../freeform/types.js";
-import { type BooleanExecutionOptions, type BooleanOperand, type BooleanResult } from "../operations/boolean.js";
-export interface ExtrudedShapeOptions {
-    ogid?: string;
-    color?: number;
-    outline?: boolean;
-    fatOutlines?: boolean;
-    outlineWidth?: number;
-    outlineColor?: number;
-    placement?: Partial<ObjectTransformation>;
-}
-export type ExtrudedShapePlacementUpdate = Partial<ObjectTransformation>;
-export declare class ExtrudedShape extends THREE.Mesh {
-    #private;
-    ogid: string;
-    private readonly freeform;
-    private _outlineEnabled;
-    private _fatOutlines;
-    private _outlineWidth;
-    private _outlineColor;
-    private _color;
-    constructor(localBrepSerialized: string, options?: ExtrudedShapeOptions);
-    set color(color: number);
-    get color(): number;
-    getBrepSerialized(): string;
-    getPlacement(): ObjectTransformation;
-    setPlacement(placement: ExtrudedShapePlacementUpdate): void;
-    setTransform(translation: Vector3, rotation: Vector3, scale: Vector3): void;
-    setTranslation(translation: Vector3): void;
-    setRotation(rotation: Vector3): void;
-    setScale(scale: Vector3): void;
-    union(operand: BooleanOperand, options?: BooleanExecutionOptions): BooleanResult;
-    intersection(operand: BooleanOperand, options?: BooleanExecutionOptions): BooleanResult;
-    subtract(operand: BooleanOperand, options?: BooleanExecutionOptions): BooleanResult;
-    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;
-    dispose(): void;
-    private generateGeometry;
-    private clearOutlineMesh;
-    private writePositionsToGeometry;
-}