@planara/core 1.4.9 → 1.6.0

package/dist/index.full.d.ts

@@ -0,0 +1,315 @@
+import { Camera } from 'ogl';
+import { DisplayMode } from '@planara/types';
+import { Figure } from '@planara/types';
+import { Mesh } from 'ogl';
+import { MeshOptions } from 'ogl/types/core/Mesh';
+import { MeshRenderCallback } from 'ogl';
+import { OGLRenderingContext } from 'ogl/types/core/Renderer';
+import { OGLRenderingContext as OGLRenderingContext_2 } from 'ogl';
+import { Program } from 'ogl';
+import { Renderer as Renderer_2 } from 'ogl';
+import { SelectMode } from '@planara/types';
+import { Transform } from 'ogl';
+
+/**
+ * Тип позиции камеры в мире.
+ * @public
+ */
+export declare type CameraPosition = {
+    x: number;
+    y: number;
+    z: number;
+};
+
+/**
+ * Создаёт или возвращает готовый экземпляр хаба.
+ * @public
+ */
+export declare function createAppHub(canvas: HTMLCanvasElement): EditorHub;
+
+/**
+ * Типы событий редактора.
+ * Используются в EventEmitter для типизированной публикации и подписки на события.
+ * @public
+ */
+export declare type EditorEvents = {
+    /** Событие наведения на объект (hover). Payload: объект с mesh или null */
+    [EventTopics.SelectHover]: {
+        mesh: Mesh;
+    } | null;
+    /** Событие клика по объекту. Payload: объект с mesh или null */
+    [EventTopics.SelectClick]: {
+        mesh: Mesh;
+    } | null;
+};
+
+/**
+ * Хаб для управления редактированием
+ * @public
+ */
+export declare class EditorHub {
+    private _displayManager;
+    private _selectManager;
+    private _renderer;
+    constructor(_displayManager: IDisplayManager, _selectManager: ISelectManager, _renderer: EditorRenderer);
+    setDisplayMode(mode: DisplayMode): void;
+    setSelectMode(mode: SelectMode): void;
+    resizeRenderer(): void;
+    updateRenderer(): void;
+    addFigure(figure: Figure): void;
+    destroy(): void;
+}
+
+/**
+ * Расширение для Mesh с добавлением поля isHit, необходимого для raycast
+ * @public
+ */
+export declare class EditorMesh extends Mesh {
+    isHit: boolean;
+    constructor(gl: OGLRenderingContext, options?: Partial<MeshOptions>);
+}
+
+/**
+ * Рендерер для редактора.
+ * Добавляет сетку, оси координат и поддержку Orbit для управления камерой.
+ * Наследуется от базового Renderer.
+ * @public
+ */
+export declare class EditorRenderer extends Renderer {
+    private _canvas;
+    private _bus;
+    /** Orbit-контроллер для управления камерой */
+    private _orbit;
+    /** Raycast для подсветки моделей при наведении */
+    private _raycast;
+    /** Курсор мыши для остлеживания наведения на 3D-модель */
+    private _mouse;
+    /** Были ли зарегистрированы обработчики событий для мыши */
+    private _isEventListenersAdded;
+    /**
+     * Инициализация сцены редактора.
+     * Создает сетку, оси координат и orbit-контроллер.
+     */
+    constructor(_canvas: HTMLCanvasElement, _bus: EventBus);
+    /**
+     * Обновление состояния рендерера.
+     */
+    protected update(): void;
+    /**
+     * Метод для добавления фигуры.
+     * Настройка raycast.
+     * @param figure - Данные фигуры: position, normal, uv
+     */
+    addFigure(figure: Figure): EditorMesh;
+    /**
+     * Устанавливает callback, который будет вызываться перед рендером конкретного меша.
+     *
+     * @param mesh - Меш, для которого нужно задать callback.
+     * @param f - Функция обратного вызова, выполняемая перед рендером меша.
+     * @internal
+     */
+    setMeshBeforeRender(mesh: Mesh, f: MeshRenderCallback): void;
+    /**
+     * Инициализация обработчиков мыши для raycast
+     */
+    private initMouseListeners;
+    /**
+     * Обработчик движения мыши
+     */
+    private _handleMouseMove;
+    /**
+     * Обработчик клика мыши
+     */
+    private _handleMouseClick;
+    /**
+     * Универсальная логика raycast-события
+     */
+    private _processRaycastEvent;
+    /** Деструктор */
+    destroy(): void;
+}
+
+/**
+ * Событийная шина редактора с топиками.
+ * Используется для publish/subscribe без прямых зависимостей.
+ * @public
+ */
+export declare class EventBus {
+    private _emitter;
+    constructor();
+    /** Публикация события */
+    emit<K extends keyof EditorEvents>(event: K, payload: EditorEvents[K]): void;
+    /** Подписка на событие */
+    on<K extends keyof EditorEvents>(event: K, listener: (payload: EditorEvents[K]) => void): void;
+    /** Отписка от события */
+    off<K extends keyof EditorEvents>(event: K, listener: (payload: EditorEvents[K]) => void): void;
+}
+
+/**
+ * Топики событий редактора.
+ * Используются для подписки/публикации через EventEmitter.
+ * @public
+ */
+export declare enum EventTopics {
+    /** Событие наведения на объект (hover). Payload: mesh: Mesh | null */
+    SelectHover = "select.hover",
+    /** Событие клика по объекту. Payload: mesh: Mesh | null */
+    SelectClick = "select.click"
+}
+
+/**
+ * Маркерный интерфейс для менеджеров отображения.
+ * @public
+ */
+export declare interface IDisplayManager extends IManager {
+}
+
+/**
+ * Общий интерфейс для всех менеджеров в хабе.
+ * Каждый менеджер отвечает за одну фичу.
+ * @public
+ */
+export declare interface IManager {
+    /**
+     * Выполняет основное действие менеджера.
+     */
+    manage(...args: unknown[]): void;
+    /**
+     * Освобождает ресурсы менеджера.
+     */
+    destroy(): void;
+}
+
+/**
+ * Маркерный интерфейс для менеджеров выборки.
+ * @public
+ */
+export declare interface ISelectManager extends IManager {
+}
+
+/** @public */
+export declare class ObjLoader {
+    /** Позиции вершин */
+    private _positions;
+    /** Нормали вершин */
+    private _normals;
+    /** UV-координаты (опционально) */
+    private _uvs;
+    private _tmpPositions;
+    private _tmpNormals;
+    private _tmpUVs;
+    /**
+     * Загружает OBJ-модель в Figure
+     * @param objContent - Строка содержимого .obj файла
+     */
+    load(objContent: string): Figure;
+    /**
+     * Обрабатывает строку face (f) и разворачивает индексы в массивы для рендеринга
+     */
+    private processFaceLine;
+}
+
+/**
+ * Рендерер для предпросмотра 3D-модели.
+ * Настраивает сцену, камеру и орбитальную навигацию (по горизонтали).
+ * Наследуется от базового Renderer.
+ * @alpha
+ */
+export declare class PreviewRenderer extends Renderer {
+    /** Orbit-контроллер для управления камерой */
+    private _orbit;
+    /**
+     * Инициализация сцены предпросмотра.
+     * @param canvas - HTMLCanvasElement для рендеринга
+     */
+    constructor(canvas: HTMLCanvasElement);
+    /**
+     * Обновление состояния рендерера.
+     */
+    protected update(): void;
+}
+
+/**
+ * Абстрактный базовый класс рендерера для работы с WebGL через OGL.
+ * Отвечает за инициализацию сцены, камеры и цикла рендеринга.
+ * @public
+ */
+export declare abstract class Renderer {
+    /** Экземпляр рендерера OGL */
+    protected gl: Renderer_2;
+    /** Корневой объект сцены */
+    protected scene: Transform;
+    /** Камера для сцены */
+    protected camera: Camera;
+    /** HTML-элемент canvas, на котором рендерится сцена */
+    protected canvas: HTMLCanvasElement;
+    /** Program для настройки рендеринга моделей */
+    protected program: Program;
+    /** Массив моделей на сцене */
+    protected meshes: Mesh[];
+    /**
+     * Конструктор рендерера
+     * @param canvas - HTMLCanvasElement для рендеринга
+     */
+    protected constructor(canvas: HTMLCanvasElement);
+    /**
+     * Обновляет размер рендерера и камеры при изменении размеров canvas.
+     */
+    resize(): void;
+    /**
+     * Выполняет рендеринг сцены с текущей камерой.
+     */
+    protected render(): void;
+    /**
+     * Метод для обновления логики рендерера.
+     */
+    protected update(): void;
+    /**
+     * Запускает основной цикл рендеринга.
+     */
+    loop(): void;
+    /**
+     * Публичный метод для добавления фигуры.
+     * @param figure - Данные фигуры: position, normal, uv
+     */
+    addFigure(figure: Figure): EditorMesh;
+    /**
+     * Добавляет фигуру в сцену и сохраняет его во внутреннем массиве.
+     *
+     * @param mesh - Фигура для добавления в сцену.
+     * @internal
+     */
+    addMesh(mesh: Mesh): void;
+    /**
+     * Возвращает WebGL контекст рендерера.
+     *
+     * @returns Контекст WebGL (OGLRenderingContext) текущей сцены.
+     * @internal
+     */
+    getContext(): OGLRenderingContext_2;
+    /**
+     * Убирает фигуру со сцены
+     *
+     * @param mesh - Фигура для удаления со сцены.
+     * @internal
+     */
+    removeMesh(mesh: Mesh): void;
+    /**
+     * Возвращает список всех фигур, находящихся в сцене.
+     *
+     * @returns Массив текущих фигур.
+     * @internal
+     */
+    getMeshes(): Mesh[];
+    /**
+     * Возвращает настройку для рендеринга.
+     *
+     * @returns Program для настройки рендеринга моделей.
+     * @internal
+     */
+    getProgram(): Program;
+    /** Деструктор */
+    destroy(): void;
+}
+
+export { }

package/dist/index.public.d.ts

@@ -0,0 +1,260 @@
+import { Camera } from 'ogl';
+import { DisplayMode } from '@planara/types';
+import { Figure } from '@planara/types';
+import { Mesh } from 'ogl';
+import { MeshOptions } from 'ogl/types/core/Mesh';
+import { MeshRenderCallback } from 'ogl';
+import { OGLRenderingContext } from 'ogl/types/core/Renderer';
+import { OGLRenderingContext as OGLRenderingContext_2 } from 'ogl';
+import { Program } from 'ogl';
+import { Renderer as Renderer_2 } from 'ogl';
+import { SelectMode } from '@planara/types';
+import { Transform } from 'ogl';
+
+/**
+ * Тип позиции камеры в мире.
+ * @public
+ */
+export declare type CameraPosition = {
+    x: number;
+    y: number;
+    z: number;
+};
+
+/**
+ * Создаёт или возвращает готовый экземпляр хаба.
+ * @public
+ */
+export declare function createAppHub(canvas: HTMLCanvasElement): EditorHub;
+
+/**
+ * Типы событий редактора.
+ * Используются в EventEmitter для типизированной публикации и подписки на события.
+ * @public
+ */
+export declare type EditorEvents = {
+    /** Событие наведения на объект (hover). Payload: объект с mesh или null */
+    [EventTopics.SelectHover]: {
+        mesh: Mesh;
+    } | null;
+    /** Событие клика по объекту. Payload: объект с mesh или null */
+    [EventTopics.SelectClick]: {
+        mesh: Mesh;
+    } | null;
+};
+
+/**
+ * Хаб для управления редактированием
+ * @public
+ */
+export declare class EditorHub {
+    private _displayManager;
+    private _selectManager;
+    private _renderer;
+    constructor(_displayManager: IDisplayManager, _selectManager: ISelectManager, _renderer: EditorRenderer);
+    setDisplayMode(mode: DisplayMode): void;
+    setSelectMode(mode: SelectMode): void;
+    resizeRenderer(): void;
+    updateRenderer(): void;
+    addFigure(figure: Figure): void;
+    destroy(): void;
+}
+
+/**
+ * Расширение для Mesh с добавлением поля isHit, необходимого для raycast
+ * @public
+ */
+export declare class EditorMesh extends Mesh {
+    isHit: boolean;
+    constructor(gl: OGLRenderingContext, options?: Partial<MeshOptions>);
+}
+
+/**
+ * Рендерер для редактора.
+ * Добавляет сетку, оси координат и поддержку Orbit для управления камерой.
+ * Наследуется от базового Renderer.
+ * @public
+ */
+export declare class EditorRenderer extends Renderer {
+    private _canvas;
+    private _bus;
+    /** Orbit-контроллер для управления камерой */
+    private _orbit;
+    /** Raycast для подсветки моделей при наведении */
+    private _raycast;
+    /** Курсор мыши для остлеживания наведения на 3D-модель */
+    private _mouse;
+    /** Были ли зарегистрированы обработчики событий для мыши */
+    private _isEventListenersAdded;
+    /**
+     * Инициализация сцены редактора.
+     * Создает сетку, оси координат и orbit-контроллер.
+     */
+    constructor(_canvas: HTMLCanvasElement, _bus: EventBus);
+    /**
+     * Обновление состояния рендерера.
+     */
+    protected update(): void;
+    /**
+     * Метод для добавления фигуры.
+     * Настройка raycast.
+     * @param figure - Данные фигуры: position, normal, uv
+     */
+    addFigure(figure: Figure): EditorMesh;
+    /* Excluded from this release type: setMeshBeforeRender */
+    /**
+     * Инициализация обработчиков мыши для raycast
+     */
+    private initMouseListeners;
+    /**
+     * Обработчик движения мыши
+     */
+    private _handleMouseMove;
+    /**
+     * Обработчик клика мыши
+     */
+    private _handleMouseClick;
+    /**
+     * Универсальная логика raycast-события
+     */
+    private _processRaycastEvent;
+    /** Деструктор */
+    destroy(): void;
+}
+
+/**
+ * Событийная шина редактора с топиками.
+ * Используется для publish/subscribe без прямых зависимостей.
+ * @public
+ */
+export declare class EventBus {
+    private _emitter;
+    constructor();
+    /** Публикация события */
+    emit<K extends keyof EditorEvents>(event: K, payload: EditorEvents[K]): void;
+    /** Подписка на событие */
+    on<K extends keyof EditorEvents>(event: K, listener: (payload: EditorEvents[K]) => void): void;
+    /** Отписка от события */
+    off<K extends keyof EditorEvents>(event: K, listener: (payload: EditorEvents[K]) => void): void;
+}
+
+/**
+ * Топики событий редактора.
+ * Используются для подписки/публикации через EventEmitter.
+ * @public
+ */
+export declare enum EventTopics {
+    /** Событие наведения на объект (hover). Payload: mesh: Mesh | null */
+    SelectHover = "select.hover",
+    /** Событие клика по объекту. Payload: mesh: Mesh | null */
+    SelectClick = "select.click"
+}
+
+/**
+ * Маркерный интерфейс для менеджеров отображения.
+ * @public
+ */
+export declare interface IDisplayManager extends IManager {
+}
+
+/**
+ * Общий интерфейс для всех менеджеров в хабе.
+ * Каждый менеджер отвечает за одну фичу.
+ * @public
+ */
+export declare interface IManager {
+    /**
+     * Выполняет основное действие менеджера.
+     */
+    manage(...args: unknown[]): void;
+    /**
+     * Освобождает ресурсы менеджера.
+     */
+    destroy(): void;
+}
+
+/**
+ * Маркерный интерфейс для менеджеров выборки.
+ * @public
+ */
+export declare interface ISelectManager extends IManager {
+}
+
+/** @public */
+export declare class ObjLoader {
+    /** Позиции вершин */
+    private _positions;
+    /** Нормали вершин */
+    private _normals;
+    /** UV-координаты (опционально) */
+    private _uvs;
+    private _tmpPositions;
+    private _tmpNormals;
+    private _tmpUVs;
+    /**
+     * Загружает OBJ-модель в Figure
+     * @param objContent - Строка содержимого .obj файла
+     */
+    load(objContent: string): Figure;
+    /**
+     * Обрабатывает строку face (f) и разворачивает индексы в массивы для рендеринга
+     */
+    private processFaceLine;
+}
+
+/* Excluded from this release type: PreviewRenderer */
+
+/**
+ * Абстрактный базовый класс рендерера для работы с WebGL через OGL.
+ * Отвечает за инициализацию сцены, камеры и цикла рендеринга.
+ * @public
+ */
+export declare abstract class Renderer {
+    /** Экземпляр рендерера OGL */
+    protected gl: Renderer_2;
+    /** Корневой объект сцены */
+    protected scene: Transform;
+    /** Камера для сцены */
+    protected camera: Camera;
+    /** HTML-элемент canvas, на котором рендерится сцена */
+    protected canvas: HTMLCanvasElement;
+    /** Program для настройки рендеринга моделей */
+    protected program: Program;
+    /** Массив моделей на сцене */
+    protected meshes: Mesh[];
+    /**
+     * Конструктор рендерера
+     * @param canvas - HTMLCanvasElement для рендеринга
+     */
+    protected constructor(canvas: HTMLCanvasElement);
+    /**
+     * Обновляет размер рендерера и камеры при изменении размеров canvas.
+     */
+    resize(): void;
+    /**
+     * Выполняет рендеринг сцены с текущей камерой.
+     */
+    protected render(): void;
+    /**
+     * Метод для обновления логики рендерера.
+     */
+    protected update(): void;
+    /**
+     * Запускает основной цикл рендеринга.
+     */
+    loop(): void;
+    /**
+     * Публичный метод для добавления фигуры.
+     * @param figure - Данные фигуры: position, normal, uv
+     */
+    addFigure(figure: Figure): EditorMesh;
+    /* Excluded from this release type: addMesh */
+    /* Excluded from this release type: getContext */
+    /* Excluded from this release type: removeMesh */
+    /* Excluded from this release type: getMeshes */
+    /* Excluded from this release type: getProgram */
+    /** Деструктор */
+    destroy(): void;
+}
+
+export { }