opengeometry 2.0.8 → 2.0.10

package/src/operations/pipe.d.ts

@@ -0,0 +1,17 @@
+export interface PipeOptions {
+    /** Number of segments around each circular cross-section (default 32). */
+    segments?: number;
+}
+/**
+ * Sweeps a circle along a 3D path, producing a pipe solid.
+ *
+ * `pathFlat` is a flat array of xyz coordinates: [x0,y0,z0, x1,y1,z1, …].
+ * The path must contain at least 3 points.
+ *
+ * `radiusCurve` is either a single number (constant radius along the whole
+ * path) or an array of numbers with the same length as the path point count
+ * (variable radius — one value per station).
+ *
+ * Returns a JSON-serialised BRep of the pipe solid.
+ */
+export declare function pipe(pathFlat: number[], radiusCurve: number | number[], options?: PipeOptions): string;

package/src/operations/revolve.d.ts

@@ -0,0 +1,29 @@
+export interface RevolveProfileOptions {
+    axisOrigin?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    axisDirection?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    startAngleRad?: number;
+    sweepAngleRad?: number;
+    segments?: number;
+    capStart?: boolean;
+    capEnd?: boolean;
+    tolerance?: number;
+}
+/**
+ * Sweeps a planar generatrix profile around an axis by the given angle.
+ *
+ * The profile is a flat array of xyz coordinates (3 floats per point).
+ * Returns a JSON-serialized BRep of the revolved surface.
+ *
+ * For full 2π sweeps, angular-seam caps are elided — the surface closes by
+ * periodicity. Axis is defined by an origin point and a unit-length direction.
+ * On-axis points generate triangle fans rather than degenerate quads.
+ */
+export declare function revolveProfile(profileFlat: number[], options?: RevolveProfileOptions): string;

package/src/operations/sweep.d.ts

@@ -0,0 +1,13 @@
+export interface SweepOptions {
+    capStart?: boolean;
+    capEnd?: boolean;
+}
+/**
+ * Sweeps a planar profile along a 3D path, producing a solid BRep.
+ *
+ * `pathFlat` is a flat array of xyz coordinates: [x0,y0,z0, x1,y1,z1, …].
+ * `profileFlat` is a flat array of xyz coordinates for the cross-section.
+ *
+ * Returns a JSON-serialised BRep of the swept solid.
+ */
+export declare function sweepProfileAlongPath(pathFlat: number[], profileFlat: number[], options?: SweepOptions): string;

package/src/primitives/helix.d.ts

@@ -0,0 +1,31 @@
+import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
+import * as THREE from "three";
+/**
+ * Construction options for a helix path primitive.
+ */
+export interface IHelixOptions {
+    ogid?: string;
+    axisOrigin: Vector3;
+    axisDirection: Vector3;
+    radius: number;
+    pitch: number;
+    turns: number;
+    samplesPerTurn: number;
+    color: number;
+}
+/**
+ * Partial config payload accepted by `OGHelix.setConfig(...)`.
+ */
+export type HelixConfigUpdate = Partial<IHelixOptions>;
+/**
+ * Helix path primitive rendered as a Three.js line.
+ */
+export declare class OGHelix extends THREE.Line {
+    ogid: string;
+    options: IHelixOptions;
+    constructor(options?: Partial<IHelixOptions>);
+    setConfig(options: HelixConfigUpdate): void;
+    getConfig(): IHelixOptions;
+    getSamples(): Vector3[];
+    private generateGeometry;
+}

package/src/shapes/cone.d.ts

@@ -0,0 +1,64 @@
+import * as THREE from "three";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a cone shape.
+ */
+export interface IConeOptions {
+    ogid?: string;
+    /** Apex position in world space. */
+    apex: [number, number, number];
+    /** Base centre position in world space. */
+    baseCenter: [number, number, number];
+    baseRadius: number;
+    segments: number;
+    /** Sweep angle in degrees (default 360). */
+    angle: number;
+    color: number;
+    fatOutlines?: boolean;
+    outlineWidth?: number;
+}
+/**
+ * Partial config payload accepted by `Cone.setConfig(...)`.
+ */
+export type ConeConfigUpdate = Partial<IConeOptions>;
+/**
+ * Cone wrapper backed by the kernel `OGCone` revolve primitive.
+ */
+export declare class Cone extends THREE.Mesh {
+    #private;
+    ogid: string;
+    options: IConeOptions;
+    private cone;
+    private _outlineEnabled;
+    private _fatOutlines;
+    private _outlineWidth;
+    set color(color: number);
+    constructor(options?: Partial<IConeOptions>);
+    setConfig(options: ConeConfigUpdate): void;
+    getConfig(): IConeOptions;
+    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
+    canConvertToFreeform(): boolean;
+    toFreeform(id?: string): import("../freeform.js").FreeformGeometry;
+    cleanGeometry(): void;
+    generateGeometry(): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands from this cone.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    set outline(enable: boolean);
+    get outline(): boolean;
+    set fatOutlines(value: boolean);
+    get fatOutlines(): boolean;
+    set outlineWidth(value: number);
+    get outlineWidth(): number;
+    /** Sets position/rotation/scale placement. */
+    setPlacement(placement: {
+        translation?: THREE.Vector3Like;
+        rotation?: THREE.Vector3Like;
+        scale?: THREE.Vector3Like;
+    }): void;
+    private clearOutlineMesh;
+    discardGeometry(): void;
+    private writePositionsToGeometry;
+}

package/src/shapes/ellipsoid.d.ts

@@ -0,0 +1,86 @@
+import * as OGKernel from "../../opengeometry/pkg/opengeometry.js";
+import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
+import * as THREE from "three";
+import { ShapeOutlineMesh } from "./outline-utils.js";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for an ellipsoid shape.
+ */
+export interface IEllipsoidOptions {
+    ogid?: string;
+    center: Vector3;
+    semiA: number;
+    semiB: number;
+    semiC: number;
+    longitudeSegments: number;
+    latitudeSegments: number;
+    color: number;
+    fatOutlines?: boolean;
+    outlineWidth?: number;
+    translation?: Vector3;
+    rotation?: Vector3;
+    scale?: Vector3;
+}
+/**
+ * Placement updates accepted by `Ellipsoid`.
+ */
+export interface EllipsoidPlacementOptions {
+    translation?: Vector3;
+    rotation?: Vector3;
+    scale?: Vector3;
+}
+/**
+ * Partial config payload accepted by `Ellipsoid.setConfig(...)`.
+ */
+export type EllipsoidConfigUpdate = Partial<Omit<IEllipsoidOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Ellipsoid` placement updates.
+ */
+export type EllipsoidPlacementUpdate = EllipsoidPlacementOptions;
+/**
+ * Ellipsoid wrapper backed by the kernel OGEllipsoid primitive.
+ *
+ * All three semi-axes (a, b, c) are independently configurable.
+ * When a === b === c the shape degenerates to a sphere.
+ */
+export declare class Ellipsoid extends THREE.Mesh {
+    #private;
+    ogid: string;
+    options: IEllipsoidOptions;
+    private ellipsoid;
+    private _outlineEnabled;
+    private _fatOutlines;
+    private _outlineWidth;
+    set color(color: number);
+    constructor(options?: IEllipsoidOptions);
+    validateOptions(): void;
+    setConfig(options: EllipsoidConfigUpdate): void;
+    getConfig(): IEllipsoidOptions;
+    getAnchor(): OGKernel.Vector3;
+    setPlacement(placement: EllipsoidPlacementUpdate): 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;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands, such as Opening volumes, from this ellipsoid.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    set outline(enable: boolean);
+    get outline(): boolean;
+    set fatOutlines(value: boolean);
+    get fatOutlines(): boolean;
+    set outlineWidth(value: number);
+    get outlineWidth(): number;
+    get outlineMesh(): ShapeOutlineMesh | null;
+    private clearOutlineMesh;
+    discardGeometry(): void;
+    private writePositionsToGeometry;
+}

package/src/shapes/frustum.d.ts

@@ -0,0 +1,44 @@
+import * as THREE from "three";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a frustum (truncated cone) shape.
+ */
+export interface IFrustumOptions {
+    ogid?: string;
+    baseCenter?: [number, number, number];
+    baseRadius: number;
+    topRadius: number;
+    height: number;
+    segments?: number;
+    angle?: number;
+    color: number;
+}
+/**
+ * Placement updates accepted by `Frustum`.
+ */
+export interface FrustumPlacementOptions {
+    translation?: THREE.Vector3;
+    rotation?: THREE.Vector3;
+    scale?: THREE.Vector3;
+}
+/**
+ * Partial config payload accepted by `Frustum.setConfig(...)`.
+ */
+export type FrustumConfigUpdate = Partial<IFrustumOptions>;
+/**
+ * Frustum (truncated cone) wrapper backed by the kernel OGFrustum primitive.
+ */
+export declare class Frustum extends THREE.Mesh {
+    ogid: string;
+    options: Required<IFrustumOptions>;
+    private frustum;
+    constructor(options?: IFrustumOptions);
+    setConfig(options: FrustumConfigUpdate): void;
+    setPlacement(placement: FrustumPlacementOptions): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands from this frustum.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    private generateGeometry;
+}

package/src/shapes/torus.d.ts

@@ -0,0 +1,44 @@
+import * as THREE from "three";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a torus shape.
+ */
+export interface ITorusOptions {
+    ogid?: string;
+    center?: [number, number, number];
+    axis?: [number, number, number];
+    majorRadius: number;
+    minorRadius: number;
+    majorSegments?: number;
+    minorSegments?: number;
+    color: number;
+}
+/**
+ * Placement updates accepted by `Torus`.
+ */
+export interface TorusPlacementOptions {
+    translation?: THREE.Vector3;
+    rotation?: THREE.Vector3;
+    scale?: THREE.Vector3;
+}
+/**
+ * Partial config payload accepted by `Torus.setConfig(...)`.
+ */
+export type TorusConfigUpdate = Partial<ITorusOptions>;
+/**
+ * Torus wrapper backed by the kernel OGTorus primitive.
+ */
+export declare class Torus extends THREE.Mesh {
+    ogid: string;
+    options: Required<ITorusOptions>;
+    private torus;
+    constructor(options?: ITorusOptions);
+    setConfig(options: TorusConfigUpdate): void;
+    setPlacement(placement: TorusPlacementOptions): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands from this torus.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    private generateGeometry;
+}