@planara/core 3.0.0 → 3.2.0

package/dist/index.public.d.ts

@@ -1,13 +1,81 @@
+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';
+import { ExportSceneResult } from '@planara/types';
 import { Figure } from '@planara/types';
 import { FigureTransform } from '@planara/types';
 import { FigureType } from '@planara/types';
-import { SceneMode } from '@planara/types';
+import { IResponse } from '@planara/types';
+import { RendererConfig } from '@planara/types';
+import { RendererConfigInput } from '@planara/types';
 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 {
+    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;
+}
+
 /**
  * Тип позиции камеры в мире.
  * @public
@@ -18,12 +86,26 @@ export declare type CameraPosition = {
     z: number;
 };
 
+/**
+ * Инициализирует бенчмарк и возвращает хаб.
+ * Вызывать один раз при старте (когда есть canvas).
+ * @public
+ */
+export declare const createBenchmarkHub: (canvas: HTMLCanvasElement, rendererConfig?: RendererConfigInput) => BenchmarkHub;
+
 /**
  * Инициализирует редактор и возвращает хаб.
  * Вызывать один раз при старте (когда есть canvas).
  * @public
  */
-export declare const createAppHub: (canvas: HTMLCanvasElement) => EditorHub;
+export declare const createEditorHub: (canvas: HTMLCanvasElement, rendererConfig?: RendererConfigInput) => EditorHub;
+
+/**
+ * Инициализирует вьювер и возвращает хаб.
+ * Вызывать один раз при старте (когда есть canvas).
+ * @public
+ */
+export declare const createViewerHub: (canvas: HTMLCanvasElement, rendererConfig?: RendererConfigInput) => ViewerHub;
 
 /**
  * Типы событий редактора.
@@ -51,13 +133,17 @@ export declare class EditorHub implements Disposable_2 {
     private _renderer;
     private _mediator;
     private _store;
-    private _controller;
-    constructor(_renderer: Renderer, _mediator: IMediator, _store: ITransformStore, _controller: IController);
+    private _exportStore;
+    private _worker;
+    constructor(_renderer: Renderer, _mediator: IMediator, _store: ITransformStore, _exportStore: IExportStore, _worker: IWorker);
     setDisplayMode(mode: DisplayMode): IResponse | null;
-    setSceneMode(mode: SceneMode): IResponse | null;
     setSelectMode(mode: SelectMode): IResponse | null;
     setToolMode(mode: ToolType): IResponse | null;
-    addFigure(mode: SceneMode, figure: FigureType): IResponse | null;
+    addFigure(figure: FigureType): IResponse | null;
+    deleteFigure(): IResponse | null;
+    loadFigure(content: string): IResponse | null;
+    loadScene(content: string): IResponse | null;
+    exportScene(): ExportSceneResult;
     resizeRenderer(): void;
     /**
      * Запускает редактор.
@@ -213,58 +299,35 @@ export declare enum FeatureType {
     /** Выборка */
     Select = 2,
     /** Инструменты */
-    Tool = 3
+    Tool = 3,
+    /** Бенчмарк */
+    Benchmark = 4
 }
 
+/**
+ * Возвращает уже созданный хаб, если бенчмарк инициализирован.
+ * @public
+ */
+export declare const getBenchmarkHub: () => BenchmarkHub;
+
 /**
  * Возвращает уже созданный хаб, если редактор инициализирован.
  * @public
  */
-export declare const getAppHub: () => EditorHub;
+export declare const getEditorHub: () => EditorHub;
 
 /**
+ * Возвращает уже созданный хаб, если вьювер инициализирован.
  * @public
  */
-export declare interface ICommand {
-    type: FeatureType;
-    payload: unknown[];
-}
+export declare const getViewerHub: () => ViewerHub;
 
 /**
- * Интерфейс для контроллера, управляющего жизненным циклом модулей.
- *
- * @remarks
- * Контроллер отвечает за:
- * - инициализацию модулей (`IRuntimeModule`)
- * - запуск цикла рендеринга
- * - обновление модулей каждый кадр (`IUpdatableModule`)
- * - рендеринг модулей (`IRenderableModule`)
- * - остановку и очистку ресурсов
- *
  * @public
- * @interface
  */
-export declare interface IController extends Disposable_2 {
-    /**
-     * Запускает контроллер.
-     *
-     * @remarks
-     * Инициализирует все модули и запускает цикл рендеринга.
-     *
-     * @public
-     * @method
-     */
-    start(): void;
-    /**
-     * Останавливает контроллер.
-     *
-     * @remarks
-     * Останавливает цикл рендеринга и освобождает ресурсы.
-     *
-     * @public
-     * @method
-     */
-    stop(): void;
+export declare interface ICommand {
+    type: FeatureType;
+    payload: unknown[];
 }
 
 /**
@@ -287,6 +350,13 @@ export declare interface IDisplayStore {
     setDisplayMode(mode: DisplayMode): void;
 }
 
+/** @public */
+export declare interface IExportStore {
+    setResult(result: ExportResult): void;
+    getResult(): ExportResult | null;
+    clearResult(): void;
+}
+
 /**
  * Интерфейс медиатора команд редактора.
  *
@@ -335,6 +405,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;
+}
+
 /**
  * Интерфейс для объектов, которые могут быть отрисованы.
  *
@@ -500,6 +628,25 @@ export declare interface IRendererDomAccess {
     getDomElement(): HTMLElement;
 }
 
+/**
+ * API доступа к метрикам WebGL-рендерера.
+ *
+ * @remarks
+ * Предоставляет только статистику рендеринга без доступа к самому renderer.
+ * Используется модулями диагностики и сбора метрик.
+ *
+ * @public
+ * @interface
+ */
+export declare interface IRendererInfoAccess {
+    /**
+     * Возвращает текущую статистику рендерера.
+     *
+     * @returns Метрики WebGL-рендера за текущий кадр
+     */
+    getRendererInfo(): RendererInfoMetrics;
+}
+
 /**
  * Низкоуровневый доступ к сцене рендерера.
  *
@@ -544,27 +691,6 @@ export declare interface IRendererSceneAccess {
     getScene(): THREE.Scene;
 }
 
-/**
- * Тип ответа от менеджеров или политик редактора.
- *
- * @remarks
- * Используется для единого API на уровне Hub.
- * Все менеджеры возвращают `Response`, чтобы клиент знал статус вызова.
- *
- * @public
- * @interface
- */
-export declare interface IResponse {
-    /** Тип ответа (enum ResponseType) */
-    type: ResponseType_2;
-    /** Читаемое сообщение для отображения или логирования */
-    message: string;
-    /** Строковый код для логов или интеграций (опционально) */
-    code?: string;
-    /** Флаг блокировки действия (true, если вызов запрещён) */
-    blocked?: boolean;
-}
-
 /**
  * Интерфейс store для менеджеров и хендлеров, которые позволяют работать с Select фичей,
  * необходим для корректного взаимодействия между группами фичей.
@@ -640,6 +766,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 {
     /** Позиции вершин */
@@ -686,7 +852,8 @@ 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.
      *
@@ -719,22 +886,19 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
      * Конструктор рендерера.
      *
      * @param _canvas - HTMLCanvasElement для рендеринга
+     * @param _config - Конфиг для настройки рендерера
      *
      * @remarks
-     * Инициализирует сцену с тёмным фоном, перспективную камеру
-     * (45° FOV, near 0.1, far 1000) и базовое освещение:
-     * - `AmbientLight` (0xffffff, 0.5) — общий свет
-     * - `DirectionalLight` (0xffffff, 1) — направленный свет
+     * Инициализирует сцену, камеру, WebGLRenderer и базовое освещение
+     * на основе переданного `RendererConfig`.
      *
-     * @example
-     * ```typescript
-     * const renderer = new Renderer(canvas);
-     * ```
+     * По умолчанию используется тёмный фон, перспективная камера
+     * и два источника света: AmbientLight и DirectionalLight.
      *
      * @public
      * @constructor
      */
-    constructor(_canvas: HTMLCanvasElement);
+    constructor(_canvas: HTMLCanvasElement, _config: RendererConfig);
     /**
      * Обновляет размер рендерера и пропорции камеры.
      *
@@ -742,11 +906,11 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
      * Вызывается при изменении размеров canvas (например, при ресайзе окна браузера).
      *
      * @example
-     * ```typescript
+     * ```ts
      * window.addEventListener('resize', () => renderer.resize());
      * ```
      *
-     * @oublic
+     * @public
      * @method
      */
     resize(): void;
@@ -781,7 +945,7 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
      * **Важно:** вызывать метод только один раз.
      *
      * @example
-     * ```typescript
+     * ```ts
      * renderer.loop();
      * ```
      *
@@ -794,6 +958,7 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
     getCanvas(): HTMLCanvasElement;
     getDomElement(): HTMLElement;
     getScene(): THREE.Scene;
+    getRendererInfo(): RendererInfoMetrics;
     /**
      * Освобождает ресурсы рендерера.
      *
@@ -807,25 +972,13 @@ export declare class Renderer implements IRendererAccess, IRendererCameraAccess,
     dispose(): Promise<void> | void;
 }
 
-/**
- * Enum типов ответа от менеджеров и политик.
- *
- * @remarks
- * Используется в `IResponse.type`.
- *
- * @public
- * @enum
- */
-declare enum ResponseType_2 {
-    /** Действие заблокировано, инструмент недоступен */
-    ToolNotAllowed = "TOOL_NOT_ALLOWED",
-    /** Действие выполнено успешно */
-    Success = "SUCCESS",
-    /** Действие не выполнено, потому что нет изменений */
-    NoChange = "NO_CHANGE",
-    Error = "ERROR"
-}
-export { ResponseType_2 as ResponseType }
+/** @public */
+export declare type RendererInfoMetrics = {
+    drawCalls: number;
+    triangles: number;
+    geometries: number;
+    textures: number;
+};
 
 /** @public */
 export declare type SelectedListener = (obj: THREE.Object3D | null) => void;
@@ -833,4 +986,29 @@ export declare type SelectedListener = (obj: THREE.Object3D | null) => void;
 /** @public */
 export declare type TransformListener = () => void;
 
+/**
+ * Хаб для управления вьювером
+ * @public
+ */
+export declare class ViewerHub implements Disposable_2 {
+    private _renderer;
+    private _mediator;
+    private _worker;
+    constructor(_renderer: Renderer, _mediator: IMediator, _worker: IWorker);
+    addFigure(figure: FigureType): IResponse | null;
+    loadFigure(content: string): IResponse | null;
+    loadScene(content: string): IResponse | null;
+    resizeRenderer(): void;
+    /**
+     * Запускает вьювер.
+     * Вызывается после создания хаба.
+     */
+    start(): void;
+    /**
+     * Останавливает вьювер.
+     */
+    stop(): void;
+    dispose(): Promise<void> | void;
+}
+
 export { }