@planara/core 3.1.0 → 3.2.1

package/dist/index.public.d.ts

@@ -1,3 +1,8 @@
+import { BenchmarkConfig } from '@planara/types';
+import { BenchmarkMetrics } from '@planara/types';
+import { BenchmarkReport } from '@planara/types';
+import { BenchmarkRunResult } from '@planara/types';
+import { BenchmarkTestType } from '@planara/types';
 import { DisplayMode } from '@planara/types';
 import { Disposable as Disposable_2 } from 'tsyringe';
 import { ExportResult } from '@planara/types';
@@ -12,6 +17,66 @@ import { SelectMode } from '@planara/types';
 import * as THREE from 'three';
 import { ToolType } from '@planara/types';
 
+/**
+ * Хаб benchmark-тестирования.
+ *
+ * @remarks
+ * Предоставляет публичный API для запуска benchmark-тестов,
+ * получения итогового отчета и подписки на live-обновления метрик.
+ *
+ * @public
+ * @class
+ */
+export declare class BenchmarkHub implements Disposable_2 {
+    private _renderer;
+    private readonly _mediator;
+    private readonly _store;
+    private _worker;
+    constructor(_renderer: Renderer, _mediator: IMediator, _store: IMetricsStore, _worker: IWorker);
+    /**
+     * Запускает benchmark-тестирование.
+     *
+     * @param config - конфигурация benchmark-тестирования
+     *
+     * @returns Краткий результат выполнения запрошенных тестов
+     *
+     * @public
+     * @method
+     */
+    run(config: BenchmarkConfig): BenchmarkRunResult;
+    /**
+     * Возвращает отчет по успешно выполненным benchmark-тестам.
+     *
+     * @returns Отчет benchmark-тестирования
+     *
+     * @public
+     * @method
+     */
+    getReport(): BenchmarkReport;
+    /**
+     * Регистрирует слушатель обновления live-метрик.
+     *
+     * @param listener - обработчик обновления метрик
+     *
+     * @returns Функция отписки от обновлений
+     *
+     * @public
+     * @method
+     */
+    subscribeMetrics(listener: MetricsListener): () => void;
+    resizeRenderer(): void;
+    /**
+     * Запускает редактор.
+     * Вызывается после создания хаба.
+     */
+    start(): void;
+    /**
+     * Останавливает редактор.
+     */
+    stop(): void;
+    dispose(): Promise<void> | void;
+}
+
 /**
  * Тип позиции камеры в мире.
  * @public
@@ -22,6 +87,13 @@ export declare type CameraPosition = {
     z: number;
 };
 
+/**
+ * Инициализирует бенчмарк и возвращает хаб.
+ * Вызывать один раз при старте (когда есть canvas).
+ * @public
+ */
+export declare const createBenchmarkHub: (canvas: HTMLCanvasElement, rendererConfig?: RendererConfigInput) => BenchmarkHub;
+
 /**
  * Инициализирует редактор и возвращает хаб.
  * Вызывать один раз при старте (когда есть canvas).
@@ -63,8 +135,8 @@ export declare class EditorHub implements Disposable_2 {
     private _mediator;
     private _store;
     private _exportStore;
-    private _controller;
-    constructor(_renderer: Renderer, _mediator: IMediator, _store: ITransformStore, _exportStore: IExportStore, _controller: IController);
+    private _worker;
+    constructor(_renderer: Renderer, _mediator: IMediator, _store: ITransformStore, _exportStore: IExportStore, _worker: IWorker);
     setDisplayMode(mode: DisplayMode): IResponse | null;
     setSelectMode(mode: SelectMode): IResponse | null;
     setToolMode(mode: ToolType): IResponse | null;
@@ -228,9 +300,17 @@ export declare enum FeatureType {
     /** Выборка */
     Select = 2,
     /** Инструменты */
-    Tool = 3
+    Tool = 3,
+    /** Бенчмарк */
+    Benchmark = 4
 }
 
+/**
+ * Возвращает уже созданный хаб, если бенчмарк инициализирован.
+ * @public
+ */
+export declare const getBenchmarkHub: () => BenchmarkHub;
+
 /**
  * Возвращает уже созданный хаб, если редактор инициализирован.
  * @public
@@ -238,7 +318,7 @@ export declare enum FeatureType {
 export declare const getEditorHub: () => EditorHub;
 
 /**
- * Возвращает уже созданный хаб, если редактор инициализирован.
+ * Возвращает уже созданный хаб, если вьювер инициализирован.
  * @public
  */
 export declare const getViewerHub: () => ViewerHub;
@@ -251,43 +331,6 @@ export declare interface ICommand {
     payload: unknown[];
 }
 
-/**
- * Интерфейс для контроллера, управляющего жизненным циклом модулей.
- *
- * @remarks
- * Контроллер отвечает за:
- * - инициализацию модулей (`IRuntimeModule`)
- * - запуск цикла рендеринга
- * - обновление модулей каждый кадр (`IUpdatableModule`)
- * - рендеринг модулей (`IRenderableModule`)
- * - остановку и очистку ресурсов
- *
- * @public
- * @interface
- */
-export declare interface IController extends Disposable_2 {
-    /**
-     * Запускает контроллер.
-     *
-     * @remarks
-     * Инициализирует все модули и запускает цикл рендеринга.
-     *
-     * @public
-     * @method
-     */
-    start(): void;
-    /**
-     * Останавливает контроллер.
-     *
-     * @remarks
-     * Останавливает цикл рендеринга и освобождает ресурсы.
-     *
-     * @public
-     * @method
-     */
-    stop(): void;
-}
-
 /**
  * Интерфейс store для менеджеров и хендлеров, которые позволяют работать с Display фичей,
  * необходим для корректного взаимодействия между группами фичей.
@@ -363,6 +406,64 @@ export declare interface IMediator extends Disposable_2 {
     send(command: ICommand): IResponse | null;
 }
 
+/**
+ * Хранилище метрик benchmark-тестирования.
+ *
+ * @public
+ * @interface
+ */
+export declare interface IMetricsStore {
+    /**
+     * Очищает сохраненные метрики и текущие live-значения.
+     *
+     * @public
+     */
+    clear(): void;
+    /**
+     * Сохраняет метрики успешно выполненного benchmark-теста.
+     *
+     * @param type - тип benchmark-теста
+     * @param metrics - собранные метрики производительности
+     *
+     * @public
+     */
+    addMetrics(type: BenchmarkTestType, metrics: BenchmarkMetrics): void;
+    /**
+     * Обновляет текущие live-метрики.
+     *
+     * @param metrics - текущие метрики производительности
+     *
+     * @public
+     */
+    setCurrentMetrics(metrics: BenchmarkMetrics | null): void;
+    /**
+     * Возвращает текущие live-метрики.
+     *
+     * @returns Текущие метрики или `null`, если измерение не выполняется
+     *
+     * @public
+     */
+    getCurrentMetrics(): BenchmarkMetrics | null;
+    /**
+     * Регистрирует слушатель обновления live-метрик.
+     *
+     * @param listener - обработчик обновления метрик
+     *
+     * @returns Функция отписки
+     *
+     * @public
+     */
+    subscribe(listener: MetricsListener): () => void;
+    /**
+     * Возвращает отчет по успешно выполненным benchmark-тестам.
+     *
+     * @returns Отчет benchmark-тестирования
+     *
+     * @public
+     */
+    getReport(): BenchmarkReport;
+}
+
 /**
  * Интерфейс для объектов, которые могут быть отрисованы.
  *
@@ -528,6 +629,25 @@ export declare interface IRendererDomAccess {
     getDomElement(): HTMLElement;
 }
 
+/**
+ * API доступа к метрикам WebGL-рендерера.
+ *
+ * @remarks
+ * Предоставляет только статистику рендеринга без доступа к самому renderer.
+ * Используется модулями диагностики и сбора метрик.
+ *
+ * @public
+ * @interface
+ */
+export declare interface IRendererInfoAccess {
+    /**
+     * Возвращает текущую статистику рендерера.
+     *
+     * @returns Метрики WebGL-рендера за текущий кадр
+     */
+    getRendererInfo(): RendererInfoMetrics;
+}
+
 /**
  * Низкоуровневый доступ к сцене рендерера.
  *
@@ -647,6 +767,46 @@ export declare interface IToolStore {
 export declare interface ITransformStore extends ISelectStore, IToolStore {
 }
 
+/**
+ * Интерфейс для воркера, управляющего жизненным циклом модулей.
+ *
+ * @remarks
+ * Контроллер отвечает за:
+ * - инициализацию модулей (`IRuntimeModule`)
+ * - запуск цикла рендеринга
+ * - обновление модулей каждый кадр (`IUpdatableModule`)
+ * - рендеринг модулей (`IRenderableModule`)
+ * - остановку и очистку ресурсов
+ *
+ * @public
+ * @interface
+ */
+export declare interface IWorker extends Disposable_2 {
+    /**
+     * Запускает воркер.
+     *
+     * @remarks
+     * Инициализирует все модули и запускает цикл рендеринга.
+     *
+     * @public
+     * @method
+     */
+    start(): void;
+    /**
+     * Останавливает воркер.
+     *
+     * @remarks
+     * Останавливает цикл рендеринга и освобождает ресурсы.
+     *
+     * @public
+     * @method
+     */
+    stop(): void;
+}
+
+/** @public */
+export declare type MetricsListener = (metrics: BenchmarkMetrics | null) => void;
+
 /** @public */
 export declare class ObjLoader {
     /** Позиции вершин */
@@ -693,7 +853,7 @@ export declare class ObjLoader {
  * @public
  * @class
  */
-export declare class Renderer implements IRendererAccess, IRendererCameraAccess, IRendererDomAccess, IRendererSceneAccess, IRenderable, Disposable_2 {
+export declare class Renderer implements IRendererAccess, IRendererCameraAccess, IRendererDomAccess, IRendererSceneAccess, IRendererInfoAccess, IRenderable, Disposable_2 {
     private readonly _config;
     /**
      * Корневой объект сцены Three.js.
@@ -747,7 +907,7 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
      * Вызывается при изменении размеров canvas (например, при ресайзе окна браузера).
      *
      * @example
-     * ```typescript
+     * ```ts
      * window.addEventListener('resize', () => renderer.resize());
      * ```
      *
@@ -786,7 +946,7 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
      * **Важно:** вызывать метод только один раз.
      *
      * @example
-     * ```typescript
+     * ```ts
      * renderer.loop();
      * ```
      *
@@ -799,6 +959,7 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
     getCanvas(): HTMLCanvasElement;
     getDomElement(): HTMLElement;
     getScene(): THREE.Scene;
+    getRendererInfo(): RendererInfoMetrics;
     /**
      * Освобождает ресурсы рендерера.
      *
@@ -812,6 +973,14 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
     dispose(): Promise<void> | void;
 }
 
+/** @public */
+export declare type RendererInfoMetrics = {
+    drawCalls: number;
+    triangles: number;
+    geometries: number;
+    textures: number;
+};
+
 /** @public */
 export declare type SelectedListener = (obj: THREE.Object3D | null) => void;
 
@@ -825,8 +994,8 @@ export declare type TransformListener = () => void;
 export declare class ViewerHub implements Disposable_2 {
     private _renderer;
     private _mediator;
-    private _controller;
-    constructor(_renderer: Renderer, _mediator: IMediator, _controller: IController);
+    private _worker;
+    constructor(_renderer: Renderer, _mediator: IMediator, _worker: IWorker);
     addFigure(figure: FigureType): IResponse | null;
     loadFigure(content: string): IResponse | null;
     loadScene(content: string): IResponse | null;