opengeometry 2.0.1 → 2.0.3

package/src/editor/freeform.d.ts

@@ -1,28 +1,91 @@
 import { OGFreeformEditor as KernelFreeformEditor, Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import { FreeformGeometry } from "../freeform.js";
 import type { EdgeInfo, EditOperationOptions, FaceInfo, FreeformEditCapabilities, FreeformEditResult, FreeformFeatureEditCapabilities, TopologyId, TopologyRenderData, VertexInfo } from "./types.js";
+/**
+ * High-level editor facade over the kernel freeform editing API.
+ */
 export declare class FreeformEditor {
     private readonly geometry;
     private readonly editor;
     constructor(geometry: FreeformGeometry, editor?: KernelFreeformEditor);
+    /**
+     * Returns the freeform geometry currently managed by this editor.
+     */
     getFreeformGeometry(): FreeformGeometry;
+    /**
+     * Returns renderable topology buffers for faces, edges, and vertices.
+     */
     getTopologyRenderData(): TopologyRenderData;
+    /**
+     * Returns semantic and topological information for a face id.
+     */
     getFaceInfo(faceId: TopologyId): FaceInfo;
+    /**
+     * Returns semantic and topological information for an edge id.
+     */
     getEdgeInfo(edgeId: TopologyId): EdgeInfo;
+    /**
+     * Returns semantic and topological information for a vertex id.
+     */
     getVertexInfo(vertexId: TopologyId): VertexInfo;
+    /**
+     * Returns global edit capabilities for the current freeform model.
+     */
     getEditCapabilities(): FreeformEditCapabilities;
+    /**
+     * Returns edit capabilities scoped to a single face.
+     */
     getFaceEditCapabilities(faceId: TopologyId): FreeformFeatureEditCapabilities;
+    /**
+     * Returns edit capabilities scoped to a single edge.
+     */
     getEdgeEditCapabilities(edgeId: TopologyId): FreeformFeatureEditCapabilities;
+    /**
+     * Returns edit capabilities scoped to a single vertex.
+     */
     getVertexEditCapabilities(vertexId: TopologyId): FreeformFeatureEditCapabilities;
+    /**
+     * Offset a face along its editable normal direction.
+     */
     pushPullFace(faceId: TopologyId, distance: number, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Creates new side faces by extruding a face region.
+     */
     extrudeFace(faceId: TopologyId, distance: number, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Splits a face by connecting two points sampled on its boundary edges.
+     */
     cutFace(faceId: TopologyId, startEdgeId: TopologyId, startT: number, endEdgeId: TopologyId, endT: number, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Moves a face by a translation vector, subject to kernel constraints.
+     */
     moveFace(faceId: TopologyId, translation: Vector3, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Moves an edge by a translation vector, subject to kernel constraints.
+     */
     moveEdge(edgeId: TopologyId, translation: Vector3, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Moves a vertex by a translation vector, subject to kernel constraints.
+     */
     moveVertex(vertexId: TopologyId, translation: Vector3, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Inserts a vertex at parametric position `t` along an edge.
+     */
     insertVertexOnEdge(edgeId: TopologyId, t: number, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Splits an edge at parametric position `t`.
+     */
     splitEdge(edgeId: TopologyId, t: number, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Creates a loop cut that propagates from the selected edge when possible.
+     */
     loopCut(edgeId: TopologyId, t: number, options?: EditOperationOptions): FreeformEditResult;
+    /**
+     * Removes a vertex when the current topology allows the edit.
+     */
     removeVertex(vertexId: TopologyId, options?: EditOperationOptions): FreeformEditResult;
 }
+/**
+ * Convenience factory for creating a freeform editor around a geometry wrapper.
+ */
 export declare function createFreeformEditor(geometry: FreeformGeometry): FreeformEditor;

package/src/editor/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Public editor helpers for parametric and freeform modeling workflows.
+ */
 export * from "./types.js";
 export { clonePlacement, createParametricEditCapabilities, toObjectTransformation, } from "./parametric.js";
 export { FreeformEditor, createFreeformEditor } from "./freeform.js";

package/src/editor/parametric.d.ts

@@ -1,5 +1,15 @@
 import type { ParametricEditCapabilities, ParametricEditFamily, ParametricEntityType, ParametricPlacement } from "./types.js";
 import type { ObjectTransformation } from "../freeform/types.js";
+/**
+ * Returns the canonical capability payload exposed by parametric wrappers.
+ */
 export declare function createParametricEditCapabilities(entityType: ParametricEntityType, editFamily: ParametricEditFamily): ParametricEditCapabilities;
+/**
+ * Normalizes optional placement fields into concrete vectors.
+ */
 export declare function clonePlacement(placement: Partial<ParametricPlacement>): ParametricPlacement;
+/**
+ * Converts a parametric placement payload into the freeform/object transform
+ * structure expected by BRep-backed helpers.
+ */
 export declare function toObjectTransformation(placement: ParametricPlacement | ObjectTransformation): ObjectTransformation;

package/src/editor/types.d.ts

@@ -1,6 +1,12 @@
 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;
@@ -14,6 +20,9 @@ export interface FreeformOperationCapabilities {
     canLoopCut: boolean;
     reasons?: string[];
 }
+/**
+ * Global editing capabilities for a freeform geometry object.
+ */
 export interface FreeformEditCapabilities extends FreeformOperationCapabilities {
     editingMode: "freeform";
     entityType: "freeform";
@@ -22,29 +31,50 @@ export interface FreeformEditCapabilities extends FreeformOperationCapabilities
     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;
@@ -52,11 +82,17 @@ export interface FreeformDiagnostic {
     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;
@@ -67,6 +103,9 @@ export interface FaceInfo {
     vertex_ids: TopologyId[];
     adjacent_face_ids: TopologyId[];
 }
+/**
+ * Edge metadata returned by the freeform editor.
+ */
 export interface EdgeInfo {
     edge_id: TopologyId;
     curve_type: string;
@@ -76,30 +115,48 @@ export interface EdgeInfo {
     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;
@@ -114,6 +171,9 @@ export interface FreeformEditResult {
     validity: FreeformValidity;
     placement: ObjectTransformation;
 }
+/**
+ * Optional flags that control how much auxiliary data an edit returns.
+ */
 export interface EditOperationOptions {
     includeBrepSerialized?: boolean;
     includeLocalBrepSerialized?: boolean;
@@ -127,16 +187,25 @@ export interface EditOperationOptions {
     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" | "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;
@@ -145,6 +214,9 @@ export interface BaseEditCapabilities {
     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

@@ -2,11 +2,12 @@ import * as THREE from "three";
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import { BooleanExecutionOptions, BooleanResult } from "../operations/boolean.js";
 export type BooleanExampleOperation = "union" | "intersection" | "subtraction";
-export type BooleanExampleMode = "solid" | "polygon";
+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;

package/src/freeform/geometry.d.ts

@@ -1,21 +1,80 @@
 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;

package/src/freeform/index.d.ts

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

package/src/freeform/types.d.ts

@@ -1,20 +1,32 @@
 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;

package/src/operations/boolean.d.ts

@@ -1,23 +1,38 @@
 import * as THREE from "three";
 import { type CreateFreeformGeometryOptions, type FreeformGeometry } from "../freeform.js";
+/**
+ * Accepted operand formats for boolean helpers.
+ */
 export type BooleanOperand = string | Record<string, unknown> | {
     getBrep?: () => unknown;
     getBrepData?: () => unknown;
     getBrepSerialized?: () => string;
 };
+/**
+ * Kernel-side boolean tuning options.
+ */
 export interface BooleanKernelOptions {
     tolerance?: number;
     mergeCoplanarFaces?: boolean;
 }
+/**
+ * Rendering options applied to the boolean result mesh.
+ */
 export interface BooleanRenderOptions {
     color?: number;
     outline?: boolean;
     fatOutlines?: boolean;
     outlineWidth?: number;
 }
+/**
+ * Combined kernel and rendering options accepted by boolean helpers.
+ */
 export interface BooleanExecutionOptions extends BooleanRenderOptions {
     kernel?: BooleanKernelOptions;
 }
+/**
+ * Structured report returned by the kernel boolean pipeline.
+ */
 export interface BooleanReport {
     operation: string;
     operand_kind: string;

package/src/operations/extrude.d.ts

@@ -0,0 +1,9 @@
+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

@@ -2,3 +2,4 @@
  * Kernel-backed boolean helpers and renderable result mesh.
  */
 export * from "./boolean.js";
+export * from "./extrude.js";

package/src/primitives/arc.d.ts

@@ -1,5 +1,8 @@
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
+/**
+ * Construction options for an arc or full-circle primitive.
+ */
 export interface IArcOptions {
     ogid?: string;
     center: Vector3;
@@ -14,13 +17,25 @@ export interface IArcOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Arc`.
+ */
 export interface ArcPlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Arc.setConfig(...)`.
+ */
 export type ArcConfigUpdate = Partial<Omit<IArcOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Arc` placement updates.
+ */
 export type ArcPlacementUpdate = ArcPlacementOptions;
+/**
+ * Arc wrapper backed by the kernel OGArc primitive.
+ */
 export declare class Arc extends THREE.Line {
     ogid: string;
     options: IArcOptions;

package/src/primitives/curve.d.ts

@@ -1,5 +1,8 @@
 import * as THREE from "three";
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
+/**
+ * Construction options for a control-point-driven curve.
+ */
 export interface ICurveOptions {
     ogid?: string;
     controlPoints: Vector3[];
@@ -8,18 +11,33 @@ export interface ICurveOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Curve`.
+ */
 export interface CurvePlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Curve.setConfig(...)`.
+ */
 export type CurveConfigUpdate = Partial<Omit<ICurveOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Curve` placement updates.
+ */
 export type CurvePlacementUpdate = CurvePlacementOptions;
+/**
+ * Offset result returned by `Curve.offset(...)`.
+ */
 export interface ICurveOffsetResult {
     points: Vector3[];
     beveledVertexIndices: number[];
     isClosed: boolean;
 }
+/**
+ * Curve wrapper backed by the kernel OGCurve primitive.
+ */
 export declare class Curve extends THREE.Line {
     ogid: string;
     options: ICurveOptions;

package/src/primitives/line.d.ts

@@ -1,5 +1,8 @@
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
+/**
+ * Construction options for a line segment wrapper.
+ */
 export interface ILineOptions {
     ogid?: string;
     start: Vector3;
@@ -11,13 +14,25 @@ export interface ILineOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Line`.
+ */
 export interface LinePlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Line.setConfig(...)`.
+ */
 export type LineConfigUpdate = Partial<Omit<ILineOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Line` placement updates.
+ */
 export type LinePlacementUpdate = LinePlacementOptions;
+/**
+ * Offset result returned by `Line.offset(...)`.
+ */
 export interface ILineOffsetResult {
     points: Vector3[];
     beveledVertexIndices: number[];

package/src/primitives/polyline.d.ts

@@ -1,5 +1,8 @@
 import * as THREE from 'three';
 import { Vector3 } from '../../opengeometry/pkg/opengeometry.js';
+/**
+ * Construction options for an ordered polyline wrapper.
+ */
 export interface IPolylineOptions {
     ogid?: string;
     color: number;
@@ -10,18 +13,33 @@ export interface IPolylineOptions {
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Placement updates accepted by `Polyline`.
+ */
 export interface PolylinePlacementOptions {
     translation?: Vector3;
     rotation?: Vector3;
     scale?: Vector3;
 }
+/**
+ * Partial config payload accepted by `Polyline.setConfig(...)`.
+ */
 export type PolylineConfigUpdate = Partial<Omit<IPolylineOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Polyline` placement updates.
+ */
 export type PolylinePlacementUpdate = PolylinePlacementOptions;
+/**
+ * Offset result returned by `Polyline.offset(...)`.
+ */
 export interface IOffsetResult {
     points: Vector3[];
     beveledVertexIndices: number[];
     isClosed: boolean;
 }
+/**
+ * Polyline wrapper backed by the kernel OGPolyline primitive.
+ */
 export declare class Polyline extends THREE.Line {
     ogid: string;
     options: IPolylineOptions;