opengeometry 0.0.2 → 0.0.4

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Vector3D, BasePolygon } from "../opengeometry/pkg/opengeometry";
+import { Vector3D, BasePolygon, OGPolygon } from "../opengeometry/pkg/opengeometry";
 import * as THREE from "three";
 import { CSS2DRenderer } from "three/examples/jsm/renderers/CSS2DRenderer.js";
 import { Pencil } from "./src/pencil";
@@ -14,13 +14,53 @@ export declare class OpenGeometry {
     protected container: HTMLElement | undefined;
     private _pencil;
     private _labelRenderer;
+    private _enableDebug;
+    set enablePencil(value: boolean);
+    get pencil(): Pencil | undefined;
+    get labelRenderer(): CSS2DRenderer | undefined;
+    get enableDebug(): boolean;
+    /**
+     * Enables or disables debug mode for OpenGeometry.
+     * When enabled, it logs debug information to the console.
+     * Addtionally,
+     * 1. The geometry will be rendered with a semi-transparent material.
+     * 2. The faces will be rendered with a random color.
+     * 3. The normals will be rendered for better visualization.
+     * @param value - A boolean indicating whether to enable or disable debug mode.
+     */
+    set enableDebug(value: boolean);
     constructor(container: HTMLElement, threeScene: THREE.Scene, camera: THREE.Camera);
+    /**
+     * Asynchronously creates and initializes an instance of OpenGeometry.
+     *
+     * This factory method sets up the OpenGeometry engine by linking it with the
+     * rendering context and the WebAssembly module. It ensures all required
+     * options are provided and prepares the instance for 3D geometry operations.
+     *
+     * @param options - Configuration object for initializing OpenGeometry.
+     * @returns A promise that resolves to a fully initialized OpenGeometry instance.
+     * @throws If any of the required options (`container`, `scene`, or `camera`) are missing.
+     *
+     * @example
+     * ```ts
+     * const openGeometry = await OpenGeometry.create({
+     *   container: document.getElementById('myContainer')!,
+     *   scene: threeScene,
+     *   camera: threeCamera,
+     *   wasmURL: '/assets/opengeometry.wasm'
+     * });
+     * ```
+     */
     static create(options: OpenGeometryOptions): Promise<OpenGeometry>;
     private setup;
-    get pencil(): Pencil | undefined;
-    get labelRenderer(): CSS2DRenderer | undefined;
-    setuplabelRenderer(): void;
-    setupEvent(): void;
+    private setuplabelRenderer;
+    private setupEvent;
+    /**
+     * Updates the label renderer to render the scene with the given camera.
+     * This method should be called in the animation loop or render loop of your application.
+     * @param scene - The Three.js scene containing the objects to be rendered.
+     * @param camera - The Three.js camera used for rendering the scene.
+     */
     update(scene: THREE.Scene, camera: THREE.Camera): void;
 }
 export declare class BasePoly extends THREE.Mesh {
@@ -40,7 +80,7 @@ export declare class BasePoly extends THREE.Mesh {
 }
 export declare class CirclePoly extends THREE.Mesh {
     ogid: string;
-    polygon: BasePolygon | null;
+    polygon: OGPolygon | null;
     baseCircle: BaseCircle;
     isExtruded: boolean;
     constructor(baseCircle: BaseCircle);
@@ -49,8 +89,10 @@ export declare class CirclePoly extends THREE.Mesh {
     addFlushBufferToScene(): void;
     clearGeometry(): void;
     extrude(height: number): void;
+    getBrepData(): void;
     getOutline(type: OUTLINE_TYPE): THREE.Line<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.MeshBasicMaterial, THREE.Object3DEventMap> | undefined;
     generateExtrudedGeometry(extruded_buff: string): void;
+    dispose(): void;
 }
 export declare class RectanglePoly extends THREE.Mesh {
     ogid: string;
@@ -74,3 +116,4 @@ export declare class FlatMesh extends THREE.Mesh {
 }
 export { Vector3D, SpotLabel, };
 export * from './src/primitives/';
+export * from './src/shapes/';