@cadview/core 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -301,6 +301,50 @@ interface ThemeConfig {
 }
 declare const THEMES: Record<Theme, ThemeConfig>;
 
+interface RenderStats {
+    entitiesDrawn: number;
+    entitiesSkipped: number;
+    drawCalls: number;
+    byType: Record<string, number>;
+}
+interface DebugOptions {
+    showFps?: boolean;
+    showRenderStats?: boolean;
+    showDocumentInfo?: boolean;
+    showTimings?: boolean;
+    showCamera?: boolean;
+    position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+}
+interface DebugStats {
+    fps: number;
+    frameTime: number;
+    renderStats: RenderStats;
+    entityCount: number;
+    layerCount: number;
+    visibleLayerCount: number;
+    blockCount: number;
+    parseTime: number;
+    spatialIndexBuildTime: number;
+    totalLoadTime: number;
+    zoom: number;
+    pixelSize: number;
+    viewportBounds: {
+        minX: number;
+        minY: number;
+        maxX: number;
+        maxY: number;
+    };
+    fileName: string | null;
+    fileSize: number;
+    dxfVersion: string | null;
+}
+type ResolvedDebugOptions = Required<DebugOptions>;
+/**
+ * Render a debug overlay panel on the canvas in screen space.
+ * Follows the same pattern as renderMeasureOverlay — resets transform to screen space.
+ */
+declare function renderDebugOverlay(ctx: CanvasRenderingContext2D, stats: DebugStats, theme: Theme, options: ResolvedDebugOptions, canvasWidth: number, canvasHeight: number): void;
+
 /**
  * Resolve the display color for an entity.
  *
@@ -325,12 +369,12 @@ declare class CanvasRenderer {
     getWidth(): number;
     getHeight(): number;
     updateSize(): void;
-    render(doc: DxfDocument, vt: ViewTransform, theme: Theme, visibleLayers: Set<string>, selectedEntityIndex: number): void;
+    render(doc: DxfDocument, vt: ViewTransform, theme: Theme, visibleLayers: Set<string>, selectedEntityIndex: number): RenderStats;
     renderEmpty(theme: Theme): void;
     destroy(): void;
 }
 
-declare function drawEntity(ctx: CanvasRenderingContext2D, entity: DxfEntity, doc: DxfDocument, vt: ViewTransform, theme: Theme, pixelSize: number): void;
+declare function drawEntity(ctx: CanvasRenderingContext2D, entity: DxfEntity, doc: DxfDocument, vt: ViewTransform, theme: Theme, pixelSize: number, stats?: RenderStats): void;
 
 interface SelectEvent {
     entity: DxfEntity;
@@ -387,6 +431,11 @@ interface CadViewerOptions {
     initialTool?: Tool;
     /** Format converters for non-DXF file formats (e.g. DWG via @cadview/dwg). */
     formatConverters?: FormatConverter[];
+    /**
+     * Enable a debug overlay showing FPS, render stats, document info, timing, and camera data.
+     * Pass `true` for defaults, or an object for granular control.
+     */
+    debug?: boolean | DebugOptions;
 }
 declare class CadViewer {
     private canvas;
@@ -408,6 +457,18 @@ declare class CadViewer {
     private loadGeneration;
     private mouseScreenX;
     private mouseScreenY;
+    private debugEnabled;
+    private debugOptions;
+    private lastRenderStats;
+    private lastDebugStats;
+    private frameTimestamps;
+    private lastDoRenderTime;
+    private lastFrameTime;
+    private parseTime;
+    private spatialIndexBuildTime;
+    private loadedFileName;
+    private loadedFileSize;
+    private debugRafId;
     constructor(canvas: HTMLCanvasElement, options?: CadViewerOptions);
     /**
      * Throws if the viewer has been destroyed.
@@ -475,6 +536,19 @@ declare class CadViewer {
     /** @internal */
     requestRender(): void;
     private doRender;
+    /**
+     * Enable or disable the debug overlay.
+     * Pass `true` for defaults, `false` to disable, or an object for granular control.
+     */
+    setDebug(debug: boolean | DebugOptions): void;
+    private startDebugLoop;
+    private stopDebugLoop;
+    /**
+     * Get the latest debug stats snapshot, or null if debug mode is off.
+     */
+    getDebugStats(): DebugStats | null;
+    private buildDebugStats;
+    private computeViewportBounds;
     /** @internal */
     handlePan(dx: number, dy: number): void;
     /** @internal */
@@ -563,4 +637,4 @@ interface BBox {
 declare function computeEntitiesBounds(entities: DxfEntity[]): BBox | null;
 declare function computeEntityBBox(entity: DxfEntity): BBox | null;
 
-export { type BBox, CadViewer, type CadViewerEventMap, type CadViewerOptions, Camera, CanvasRenderer, type DxfArcEntity, type DxfAttrib, type DxfBlock, type DxfCircleEntity, type DxfDimensionEntity, type DxfDocument, type DxfEllipseEntity, type DxfEntity, type DxfEntityBase, type DxfHatchBoundaryPath, type DxfHatchEdge, type DxfHatchEntity, type DxfHeader, type DxfInsertEntity, type DxfLayer, type DxfLineEntity, type DxfLineType, type DxfLwPolylineEntity, type DxfLwPolylineVertex, type DxfMTextEntity, DxfParseError, type DxfPointEntity, type DxfPolylineEntity, type DxfSplineEntity, type DxfStyle, type DxfTextEntity, EventEmitter, type FormatConverter, LayerManager, type MeasureEvent, type MeasureState, MeasureTool, type Point2D, type Point3D, type SelectEvent, type SnapResult, type SnapType, SpatialIndex, THEMES, type Theme, type ThemeConfig, type Tool, type ViewTransform, aciToDisplayColor, aciToHex, applyTransform, computeEntitiesBounds, computeEntityBBox, drawEntity, findSnaps, fitToView, hitTest, parseDxf, renderMeasureOverlay, resolveEntityColor, screenToWorld, trueColorToHex, worldToScreen, zoomAtPoint };
+export { type BBox, CadViewer, type CadViewerEventMap, type CadViewerOptions, Camera, CanvasRenderer, type DebugOptions, type DebugStats, type DxfArcEntity, type DxfAttrib, type DxfBlock, type DxfCircleEntity, type DxfDimensionEntity, type DxfDocument, type DxfEllipseEntity, type DxfEntity, type DxfEntityBase, type DxfHatchBoundaryPath, type DxfHatchEdge, type DxfHatchEntity, type DxfHeader, type DxfInsertEntity, type DxfLayer, type DxfLineEntity, type DxfLineType, type DxfLwPolylineEntity, type DxfLwPolylineVertex, type DxfMTextEntity, DxfParseError, type DxfPointEntity, type DxfPolylineEntity, type DxfSplineEntity, type DxfStyle, type DxfTextEntity, EventEmitter, type FormatConverter, LayerManager, type MeasureEvent, type MeasureState, MeasureTool, type Point2D, type Point3D, type RenderStats, type SelectEvent, type SnapResult, type SnapType, SpatialIndex, THEMES, type Theme, type ThemeConfig, type Tool, type ViewTransform, aciToDisplayColor, aciToHex, applyTransform, computeEntitiesBounds, computeEntityBBox, drawEntity, findSnaps, fitToView, hitTest, parseDxf, renderDebugOverlay, renderMeasureOverlay, resolveEntityColor, screenToWorld, trueColorToHex, worldToScreen, zoomAtPoint };

package/dist/index.d.ts

@@ -301,6 +301,50 @@ interface ThemeConfig {
 }
 declare const THEMES: Record<Theme, ThemeConfig>;
 
+interface RenderStats {
+    entitiesDrawn: number;
+    entitiesSkipped: number;
+    drawCalls: number;
+    byType: Record<string, number>;
+}
+interface DebugOptions {
+    showFps?: boolean;
+    showRenderStats?: boolean;
+    showDocumentInfo?: boolean;
+    showTimings?: boolean;
+    showCamera?: boolean;
+    position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+}
+interface DebugStats {
+    fps: number;
+    frameTime: number;
+    renderStats: RenderStats;
+    entityCount: number;
+    layerCount: number;
+    visibleLayerCount: number;
+    blockCount: number;
+    parseTime: number;
+    spatialIndexBuildTime: number;
+    totalLoadTime: number;
+    zoom: number;
+    pixelSize: number;
+    viewportBounds: {
+        minX: number;
+        minY: number;
+        maxX: number;
+        maxY: number;
+    };
+    fileName: string | null;
+    fileSize: number;
+    dxfVersion: string | null;
+}
+type ResolvedDebugOptions = Required<DebugOptions>;
+/**
+ * Render a debug overlay panel on the canvas in screen space.
+ * Follows the same pattern as renderMeasureOverlay — resets transform to screen space.
+ */
+declare function renderDebugOverlay(ctx: CanvasRenderingContext2D, stats: DebugStats, theme: Theme, options: ResolvedDebugOptions, canvasWidth: number, canvasHeight: number): void;
+
 /**
  * Resolve the display color for an entity.
  *
@@ -325,12 +369,12 @@ declare class CanvasRenderer {
     getWidth(): number;
     getHeight(): number;
     updateSize(): void;
-    render(doc: DxfDocument, vt: ViewTransform, theme: Theme, visibleLayers: Set<string>, selectedEntityIndex: number): void;
+    render(doc: DxfDocument, vt: ViewTransform, theme: Theme, visibleLayers: Set<string>, selectedEntityIndex: number): RenderStats;
     renderEmpty(theme: Theme): void;
     destroy(): void;
 }
 
-declare function drawEntity(ctx: CanvasRenderingContext2D, entity: DxfEntity, doc: DxfDocument, vt: ViewTransform, theme: Theme, pixelSize: number): void;
+declare function drawEntity(ctx: CanvasRenderingContext2D, entity: DxfEntity, doc: DxfDocument, vt: ViewTransform, theme: Theme, pixelSize: number, stats?: RenderStats): void;
 
 interface SelectEvent {
     entity: DxfEntity;
@@ -387,6 +431,11 @@ interface CadViewerOptions {
     initialTool?: Tool;
     /** Format converters for non-DXF file formats (e.g. DWG via @cadview/dwg). */
     formatConverters?: FormatConverter[];
+    /**
+     * Enable a debug overlay showing FPS, render stats, document info, timing, and camera data.
+     * Pass `true` for defaults, or an object for granular control.
+     */
+    debug?: boolean | DebugOptions;
 }
 declare class CadViewer {
     private canvas;
@@ -408,6 +457,18 @@ declare class CadViewer {
     private loadGeneration;
     private mouseScreenX;
     private mouseScreenY;
+    private debugEnabled;
+    private debugOptions;
+    private lastRenderStats;
+    private lastDebugStats;
+    private frameTimestamps;
+    private lastDoRenderTime;
+    private lastFrameTime;
+    private parseTime;
+    private spatialIndexBuildTime;
+    private loadedFileName;
+    private loadedFileSize;
+    private debugRafId;
     constructor(canvas: HTMLCanvasElement, options?: CadViewerOptions);
     /**
      * Throws if the viewer has been destroyed.
@@ -475,6 +536,19 @@ declare class CadViewer {
     /** @internal */
     requestRender(): void;
     private doRender;
+    /**
+     * Enable or disable the debug overlay.
+     * Pass `true` for defaults, `false` to disable, or an object for granular control.
+     */
+    setDebug(debug: boolean | DebugOptions): void;
+    private startDebugLoop;
+    private stopDebugLoop;
+    /**
+     * Get the latest debug stats snapshot, or null if debug mode is off.
+     */
+    getDebugStats(): DebugStats | null;
+    private buildDebugStats;
+    private computeViewportBounds;
     /** @internal */
     handlePan(dx: number, dy: number): void;
     /** @internal */
@@ -563,4 +637,4 @@ interface BBox {
 declare function computeEntitiesBounds(entities: DxfEntity[]): BBox | null;
 declare function computeEntityBBox(entity: DxfEntity): BBox | null;
 
-export { type BBox, CadViewer, type CadViewerEventMap, type CadViewerOptions, Camera, CanvasRenderer, type DxfArcEntity, type DxfAttrib, type DxfBlock, type DxfCircleEntity, type DxfDimensionEntity, type DxfDocument, type DxfEllipseEntity, type DxfEntity, type DxfEntityBase, type DxfHatchBoundaryPath, type DxfHatchEdge, type DxfHatchEntity, type DxfHeader, type DxfInsertEntity, type DxfLayer, type DxfLineEntity, type DxfLineType, type DxfLwPolylineEntity, type DxfLwPolylineVertex, type DxfMTextEntity, DxfParseError, type DxfPointEntity, type DxfPolylineEntity, type DxfSplineEntity, type DxfStyle, type DxfTextEntity, EventEmitter, type FormatConverter, LayerManager, type MeasureEvent, type MeasureState, MeasureTool, type Point2D, type Point3D, type SelectEvent, type SnapResult, type SnapType, SpatialIndex, THEMES, type Theme, type ThemeConfig, type Tool, type ViewTransform, aciToDisplayColor, aciToHex, applyTransform, computeEntitiesBounds, computeEntityBBox, drawEntity, findSnaps, fitToView, hitTest, parseDxf, renderMeasureOverlay, resolveEntityColor, screenToWorld, trueColorToHex, worldToScreen, zoomAtPoint };
+export { type BBox, CadViewer, type CadViewerEventMap, type CadViewerOptions, Camera, CanvasRenderer, type DebugOptions, type DebugStats, type DxfArcEntity, type DxfAttrib, type DxfBlock, type DxfCircleEntity, type DxfDimensionEntity, type DxfDocument, type DxfEllipseEntity, type DxfEntity, type DxfEntityBase, type DxfHatchBoundaryPath, type DxfHatchEdge, type DxfHatchEntity, type DxfHeader, type DxfInsertEntity, type DxfLayer, type DxfLineEntity, type DxfLineType, type DxfLwPolylineEntity, type DxfLwPolylineVertex, type DxfMTextEntity, DxfParseError, type DxfPointEntity, type DxfPolylineEntity, type DxfSplineEntity, type DxfStyle, type DxfTextEntity, EventEmitter, type FormatConverter, LayerManager, type MeasureEvent, type MeasureState, MeasureTool, type Point2D, type Point3D, type RenderStats, type SelectEvent, type SnapResult, type SnapType, SpatialIndex, THEMES, type Theme, type ThemeConfig, type Tool, type ViewTransform, aciToDisplayColor, aciToHex, applyTransform, computeEntitiesBounds, computeEntityBBox, drawEntity, findSnaps, fitToView, hitTest, parseDxf, renderDebugOverlay, renderMeasureOverlay, resolveEntityColor, screenToWorld, trueColorToHex, worldToScreen, zoomAtPoint };