@gcode-viewer/plugins 0.3.0

package/dist/types/step-loader/StepModelLoader.d.ts

@@ -0,0 +1,39 @@
+import { BaseModelLoader, THREE, type ModelLoadContext, type ModelLoadFromBufferContext } from "@gcode-viewer/core";
+export declare const DEFAULT_OCCT_IMPORT_SCRIPT_URL = "https://cdn.jsdelivr.net/npm/occt-import-js@0.0.23/dist/occt-import-js.js";
+/** Folder containing `occt-import-js.wasm` (same layout as npm `dist/`). */
+export declare const DEFAULT_OCCT_WASM_BASE_URL = "https://cdn.jsdelivr.net/npm/occt-import-js@0.0.23/dist/";
+type OcctExchangeImportParams = {
+    linearUnit?: "millimeter" | "centimeter" | "meter" | "inch" | "foot";
+    linearDeflectionType?: "bounding_box_ratio" | "absolute_value";
+    linearDeflection?: number;
+    angularDeflection?: number;
+};
+/**
+ * occt-import-js defaults `linearUnit` to millimeter; gcode-viewer uses meters for scene and measurements.
+ * Applies to STEP and IGES readers. BREP ignores `linearUnit` on vertex positions; see `BREP_TO_METERS_SCALE` below.
+ */
+export declare const DEFAULT_STEP_IMPORT_PARAMS: OcctExchangeImportParams;
+export interface StepModelLoaderOptions {
+    /** Full URL to `occt-import-js.js`. Default: {@link DEFAULT_OCCT_IMPORT_SCRIPT_URL}. */
+    scriptUrl?: string;
+    /** Folder URL for wasm (trailing `/` optional). Default: {@link DEFAULT_OCCT_WASM_BASE_URL}. */
+    wasmBaseUrl?: string;
+}
+/**
+ * Loads STEP (`.step` / `.stp`), IGES (`.iges` / `.igs`), and BREP (`.brep` / `.rle`) via occt-import-js.
+ * BREP geometry is scaled from assumed millimeters to meters so it matches STEP/IGES with `linearUnit: "meter"`.
+ */
+export declare class StepModelLoader extends BaseModelLoader {
+    readonly id = "loader.plugin.step";
+    readonly priority = 10;
+    readonly formats: readonly ["step", "stp", "iges", "igs", "brep", "rle"];
+    private readonly scriptUrl;
+    private readonly wasmBaseUrl;
+    private readonly importParams;
+    constructor(options?: StepModelLoaderOptions);
+    load(ctx: ModelLoadContext): Promise<THREE.Object3D>;
+    loadFromBuffer(ctx: ModelLoadFromBufferContext): Promise<THREE.Object3D>;
+    private parseOcctToResult;
+    private reportProgress;
+}
+export {};

package/dist/types/step-loader/index.d.ts

@@ -0,0 +1,3 @@
+export { StepLoaderPlugin, type StepLoaderPluginConfig } from "./StepLoaderPlugin";
+export { StepModelLoader, DEFAULT_OCCT_IMPORT_SCRIPT_URL, DEFAULT_OCCT_WASM_BASE_URL, DEFAULT_STEP_IMPORT_PARAMS, type StepModelLoaderOptions, } from "./StepModelLoader";
+export { loadOcctImportOnce, type OcctImportFactory, type OcctImportRuntime } from "./OcctImportScriptLoader";

package/dist/types/step-loader/occtMeshBuilder.d.ts

@@ -0,0 +1,35 @@
+import { THREE } from "@gcode-viewer/core";
+export type OcctMeshNode = {
+    name?: string;
+    meshes?: number[];
+    children?: OcctMeshNode[];
+};
+export type OcctMeshAttributes = {
+    position?: {
+        array?: number[] | ArrayLike<number>;
+    };
+    normal?: {
+        array?: number[] | ArrayLike<number>;
+    };
+};
+export type OcctMeshData = {
+    name?: string;
+    color?: number[];
+    attributes?: OcctMeshAttributes;
+    index?: {
+        array?: number[] | ArrayLike<number>;
+    };
+};
+export type OcctMeshParseResult = {
+    success: boolean;
+    reason?: string;
+    root?: OcctMeshNode;
+    meshes?: OcctMeshData[];
+};
+/**
+ * Builds a Three.js group from occt-import-js `ReadStepFile` / `ReadIgesFile` / `ReadBrepFile` JSON result.
+ */
+export declare function buildOcctMeshGroup(result: OcctMeshParseResult, options: {
+    rootName: string;
+    defaultNodeName: string;
+}): THREE.Group;

package/dist/types/toolbars/Locale.d.ts

@@ -0,0 +1,57 @@
+import { i18n } from "@gcode-viewer/core";
+export declare const en: {
+    homeView: string;
+    orthoView: string;
+    measurement: string;
+    distanceMeasurement: string;
+    areaMeasurement: string;
+    angleMeasurement: string;
+    coordinateMeasurement: string;
+    clearMeasurement: string;
+    section: string;
+    axisSection: string;
+    pickSectionPlane: string;
+    sectionBox: string;
+    treeView: string;
+    viewpoint: string;
+    annotation: string;
+    property: string;
+    settings: string;
+    compared: string;
+    quitCompare: string;
+    fullscreen: string;
+    layers: string;
+    zoomToRectangle: string;
+    zoomToExtent: string;
+    screenshot: string;
+};
+export declare const zh: {
+    homeView: string;
+    orthoView: string;
+    measurement: string;
+    distanceMeasurement: string;
+    areaMeasurement: string;
+    angleMeasurement: string;
+    coordinateMeasurement: string;
+    clearMeasurement: string;
+    section: string;
+    axisSection: string;
+    pickSectionPlane: string;
+    sectionBox: string;
+    treeView: string;
+    viewpoint: string;
+    annotation: string;
+    property: string;
+    settings: string;
+    compared: string;
+    quitCompare: string;
+    fullscreen: string;
+    layers: string;
+    zoomToRectangle: string;
+    zoomToExtent: string;
+    screenshot: string;
+};
+export declare const TOOLBAR_I18N_NAMESPACE: "toolbar";
+export { i18n };
+export type ToolbarTranslationKey = keyof typeof en;
+export declare function t(key: ToolbarTranslationKey | string): string;

package/dist/types/toolbars/Toolbar.config.d.ts

@@ -0,0 +1,5 @@
+import { ToolbarConfig } from "./Toolbar.constants";
+/**
+ * @hidden
+ */
+export declare const DefaultViewer3dToolbarConfig: ToolbarConfig;

package/dist/types/toolbars/Toolbar.constants.d.ts

@@ -0,0 +1,71 @@
+import { type BaseViewer, IconClass } from "@gcode-viewer/core";
+import type { Toolbar } from "./Toolbar";
+/**
+ * @type
+ * 1: button
+ * 2: dropdown menu
+ * 3: toggle button
+ */
+export declare enum ToolbarMenuType {
+    Button = 1,
+    DropdownMenu = 2,
+    ToggleButton = 3
+}
+/**
+ * Buildin toolbar ids
+ */
+export declare enum ToolbarMenuId {
+    HomeView = "HomeView",
+    OrthoMode = "OrthoMode",
+    Measure = "Measure",
+    MeasureDistance = "MeasureDistance",
+    MeasureArea = "MeasureArea",
+    MeasureAngle = "MeasureAngle",
+    MeasureCoordinate = "MeasureCoordinate",
+    MeasureClear = "MeasureClear",
+    Section = "Section",
+    SectionBox = "SectionBox",
+    SectionPlane = "SectionPlane",
+    SectionAxis = "SectionAxis",
+    TreeView = "Tree View",
+    Viewpoint = "Viewpoint",
+    Annotation = "Annotation",
+    Property = "Property",
+    Settings = "Settings",
+    Compared = "Compared",
+    QuitCompare = "QuitCompare",
+    Fullscreen = "FullScreen",
+    SceneClear = "SceneClear",
+    Layers = "Layers",
+    ZoomToRectangle = "ZoomToRectangle",
+    ZoomToExtent = "ZoomToExtent",
+    Screenshot = "GetScreenshot"
+}
+/**
+ * Toolbar menu config.
+ * Used to define menu item name, icon, child items, etc.
+ */
+export interface ToolbarMenuConfig {
+    menuName?: string;
+    icon?: IconClass;
+    children?: ToolbarConfig;
+    visible?: boolean;
+    mutexIds?: ToolbarMenuId[];
+    defaultActive?: boolean;
+    type?: ToolbarMenuType;
+    customElement?: (viewer: BaseViewer, menuId: string, cfg: ToolbarMenuConfig) => HTMLDivElement;
+    onActive?: (viewer: BaseViewer, toolbar: Toolbar) => void;
+    onDeactive?: (viewer: BaseViewer) => void;
+    onClick?: (viewer: BaseViewer, toolbar: Toolbar, event: MouseEvent | TouchEvent) => void;
+}
+/**
+ * Toolbar config.
+ * The key is ToolbarMenuId, and the value is a ToolbarMenuConfig.
+ */
+export type ToolbarConfig = {
+    [key in ToolbarMenuId]?: ToolbarMenuConfig;
+};
+/**
+ * @hidden
+ */
+export declare const GroupConfig: ToolbarMenuId[][];

package/dist/types/toolbars/Toolbar.d.ts

@@ -0,0 +1,112 @@
+import { type BaseViewer } from "@gcode-viewer/core";
+import { ToolbarConfig, ToolbarMenuConfig, ToolbarMenuId } from "./Toolbar.constants";
+/**
+ * @class Toolbar
+ * @description A customized toolbar.
+ *
+ * For example:
+ * #### Example 1:
+ * Using {@link updateMenu} to modify the toolbar configuration
+ * ```typescript
+ *     const toolbar = this.viewer.toolbar;
+ *     toolbar.updateMenu(ToolbarMenuId.Viewpoint, { onActive: this.handleActive });
+ *     toolbar.updateMenu(ToolbarMenuId.Annotation, { visible: false });
+ * ```
+ *
+ * #### Example 2:
+ * Using {@link addMenu} to add a new menu to the toolbar with specific position.
+ * ```typescript
+ *     const toolbar = this.viewer.toolbar;
+ *     toolbar.addMenu(
+ *         "newMenu",
+ *         { icon: { default: "icon-new" }, menuName: "New menu item", controller: TreeViewerController },
+ *         [2, 5]
+ *     );
+ * ```
+ *
+ * #### Example 3:
+ * Modify the configuration in to custmize the toolbar directly, and then {@link refresh} the whole toolbar.
+ * ```typescript
+ *     const toolbar = this.viewer.toolbar;
+ *     const toolbarGroupConfig = [
+ *         [ToolbarMenuId.OrthoMode, ToolbarMenuId.FullScreen],
+ *         [ToolbarMenuId.Measure, ToolbarMenuId.Section],
+ *         [ToolbarMenuId.TreeView, ToolbarMenuId.Viewpoint, ToolbarMenuId.Annotation, ToolbarMenuId.Property],
+ *         [ToolbarMenuId.Setting, "newMenu"],
+ *     ];
+ *     toolbar.toolbarGroupConfig = toolbarGroupConfig;
+ *     toolbar.refresh();
+ * ```
+ */
+export declare class Toolbar {
+    protected viewer: BaseViewer;
+    protected element: HTMLDivElement | undefined;
+    protected visible: boolean;
+    activateMenuId?: string;
+    menuList: Map<string, ToolbarMenu>;
+    protected menuCfg: ToolbarConfig;
+    protected groupCfg: ToolbarMenuId[][] | string[][];
+    protected screenshotDownloadFileName: string;
+    private collapsed;
+    private collapseToggleEl?;
+    constructor(viewer: BaseViewer, menuCfg: ToolbarConfig, groupCfg?: ToolbarMenuId[][] | string[][]);
+    private init;
+    private toggleCollapsed;
+    private syncCollapseUi;
+    keydown: (e: KeyboardEvent) => void;
+    clearActive(): void;
+    setActive(menuId: string, active: boolean): void;
+    isActive(menuId: string): boolean;
+    setScreenshotDownloadFileName(filename: string): void;
+    getScreenshotDownloadFileName(): string;
+    private createToolbarMenu;
+    /**
+     * @description Modify the menu configuration and update the toolbar.
+     * @param {ToolbarMenuId} menuId
+     * @param {Partial<ToolbarMenuConfig>} config
+     * @memberof Toolbar
+     */
+    updateMenu(menuId: ToolbarMenuId, config: Partial<ToolbarMenuConfig>): void;
+    /**
+     * @description Modify the menu configuration and update the toolbar.
+     * @param {{ menuId: ToolbarMenuId; config: Partial<ToolbarMenuConfig> }[]} configs
+     * @memberof Toolbar
+     */
+    updateMenus(configs: {
+        menuId: ToolbarMenuId;
+        config: Partial<ToolbarMenuConfig>;
+    }[]): void;
+    /**
+     * @description Add a custmized menu to toolbar.
+     * @param {string} menuId
+     * @param {ToolbarMenuConfig} config
+     * @param {[number, number]} [insertPosition]
+     * @return {*}
+     * @memberof Toolbar
+     */
+    addMenu(menuId: string, config: ToolbarMenuConfig, insertPosition?: [number, number]): void;
+    /**
+     * @description Update the whole toolbar element with the current configuration.
+     * @memberof Toolbar
+     */
+    refresh(): void;
+    setVisible(visible: boolean): void;
+    isVisible(): boolean;
+    /** Refresh menu button titles after {@link ViewerEvent.LanguageChange}. */
+    refreshLocalizedLabels(): void;
+    destroy(): void;
+}
+/**
+ * @hidden
+ */
+export declare class ToolbarMenu {
+    private eventBus;
+    active: boolean;
+    element: HTMLDivElement;
+    toolbar: Toolbar;
+    menuId: string;
+    constructor(viewer: BaseViewer, toolbar: Toolbar, menuId: string, cfg: ToolbarMenuConfig, parent?: ToolbarMenu);
+    private createButton;
+    setActive(active: boolean): void;
+    isActive(): boolean;
+}

package/dist/types/toolbars/Viewer3dToolbarPlugin.d.ts

@@ -0,0 +1,37 @@
+import { Plugin, type BaseViewer, PluginConfig } from "@gcode-viewer/core";
+import { Toolbar } from "./Toolbar";
+import { ToolbarConfig, ToolbarMenuId } from "./Toolbar.constants";
+/**
+ * Viewer3d toolbar plugin config.
+ */
+export interface Viewer3dToolbarPluginConfig extends Partial<PluginConfig> {
+    menuConfig: ToolbarConfig;
+    groupConfig?: ToolbarMenuId[][] | string[][];
+}
+/**
+ * Viewer3d toolbar plugin.
+ */
+export declare class Viewer3dToolbarPlugin extends Plugin {
+    static readonly DEFAULT_ID = "Viewer3dToolbarPlugin";
+    protected cfg: Viewer3dToolbarPluginConfig;
+    constructor(viewer: BaseViewer, cfg?: Viewer3dToolbarPluginConfig);
+    private onLanguageChange;
+    getToolbar(): Toolbar;
+    /**
+     * Sets a menu item to be active or inactive.
+     */
+    setActive(menuId: string, active: boolean): void;
+    /**
+     * Gets if a menu item is active.
+     */
+    isActive(menuId: string): boolean;
+    setVisible(visible: boolean): void;
+    isVisible(): boolean;
+    /**
+     * When taking a screenshot, user may want to set a custom filename.
+     * If not set, it will be "download", so the file is "download.png" or "download.jpg".
+     * @param filename The filename, e.g., "thumbnail".
+     */
+    setScreenshotDownloadFileName(filename: string): void;
+    destroy(): void;
+}

package/dist/types/toolbars/index.d.ts

@@ -0,0 +1,5 @@
+import "./toolbar.scss";
+export * from "./Toolbar.config";
+export * from "./Toolbar.constants";
+export * from "./Toolbar";
+export * from "./Viewer3dToolbarPlugin";

package/dist/types/transform/Locale.d.ts

@@ -0,0 +1,21 @@
+import { i18n } from "@gcode-viewer/core";
+export declare const en: {
+    select: string;
+    move: string;
+    rotate: string;
+    scale: string;
+    worldSpace: string;
+    localSpace: string;
+};
+export declare const zh: {
+    select: string;
+    move: string;
+    rotate: string;
+    scale: string;
+    worldSpace: string;
+    localSpace: string;
+};
+export declare const TRANSFORM_I18N_NAMESPACE: "transform";
+export { i18n };
+export type TransformTranslationKey = keyof typeof en;
+export declare function t(key: TransformTranslationKey): string;

package/dist/types/transform/TransformPlugin.d.ts

@@ -0,0 +1,38 @@
+import { BaseViewer, Plugin, PluginConfig } from "@gcode-viewer/core";
+import "./transform.css";
+export interface TransformPluginConfig extends Partial<PluginConfig> {
+    /** Host element id; if omitted, a bar is appended to {@link BaseViewer.widgetContainer}. */
+    containerId?: string;
+}
+/**
+ * Adds a transform gizmo UI to {@link Viewer3d}: attach on {@link ViewerEvent.ObjectSelected},
+ * detach on deselect, and controls for translate / rotate / scale and world vs local space.
+ */
+export declare class TransformPlugin extends Plugin {
+    static readonly DEFAULT_ID = "TransformPlugin";
+    private readonly viewer3d;
+    private readonly cfg;
+    private root?;
+    private btnSelect?;
+    private btnTranslate?;
+    private btnRotate?;
+    private btnScale?;
+    private btnSpace?;
+    private enabled;
+    /** When true the gizmo is suppressed even if an object is selected. Select is the default state. */
+    private inSelectMode;
+    private readonly onObjectSelected;
+    private readonly onObjectDeselected;
+    constructor(viewer: BaseViewer, cfg?: TransformPluginConfig);
+    private readonly onLanguageChange;
+    private mount;
+    private applyLocalizedChrome;
+    private applySelectMode;
+    private applyMode;
+    private toggleSpace;
+    private refreshSpaceButton;
+    private refreshModeButtons;
+    setEnabled(enable: boolean): void;
+    isEnabled(): boolean;
+    destroy(): void;
+}

package/dist/types/transform/index.d.ts

@@ -0,0 +1 @@
+export * from "./TransformPlugin";

package/dist/types/tree-view/Locale.d.ts

@@ -0,0 +1,29 @@
+import { i18n } from "@gcode-viewer/core";
+export declare const en: {
+    treeView: string;
+    treeSearchPlaceholder: string;
+    nothingLoaded: string;
+    focus: string;
+    select: string;
+    deselect: string;
+    hide: string;
+    show: string;
+    delete: string;
+    export: string;
+};
+export declare const zh: {
+    treeView: string;
+    treeSearchPlaceholder: string;
+    nothingLoaded: string;
+    focus: string;
+    select: string;
+    deselect: string;
+    hide: string;
+    show: string;
+    delete: string;
+    export: string;
+};
+export declare const TREE_VIEW_I18N_NAMESPACE: "treeView";
+export { i18n };
+export type TreeViewTranslationKey = keyof typeof en;
+export declare function t(key: TreeViewTranslationKey): string;

package/dist/types/tree-view/TreeNodeTypeIcons.d.ts

@@ -0,0 +1,15 @@
+import { THREE } from "@gcode-viewer/core";
+/**
+ * Visual category for the scene-graph tree (outline) icon.
+ * Kept in TS with the SVG markup so icons stay co-located with type logic.
+ */
+export type TreeNodeVisualKind = "group" | "scene" | "mesh" | "line" | "points" | "sprite" | "light" | "camera" | "object3d" | "unknown";
+/**
+ * Map a Three.js object to a stable outline icon kind.
+ * Order follows the class hierarchy (specific types before {@link THREE.Object3D}).
+ */
+export declare function getTreeNodeVisualKind(node: THREE.Object3D): TreeNodeVisualKind;
+/**
+ * Full inline SVG for the tree row; uses currentColor so .node-type { color } in SCSS themes the icon.
+ */
+export declare function getTreeNodeTypeIconMarkup(kind: TreeNodeVisualKind): string;

package/dist/types/tree-view/TreeViewDragDrop.d.ts

@@ -0,0 +1,17 @@
+import { type THREE } from "@gcode-viewer/core";
+export type TreeDropPosition = "before" | "after" | "inside";
+export interface TreeViewDragDropContext {
+    canEdit: () => boolean;
+    findObjectByUuid: (uuid: string) => THREE.Object3D | undefined;
+    isModelNode: (node: THREE.Object3D) => boolean;
+    onReparent: (object: THREE.Object3D, newParent: THREE.Object3D, targetIndex: number) => boolean;
+    /** Called when the pointer was dragged past the threshold (suppress tree click selection). */
+    onDragEnded?: (moved: boolean) => void;
+}
+export interface TreeViewDragDropHandle {
+    destroy: () => void;
+}
+/**
+ * Pointer drag-and-drop for the tree view (gltfeditor-style before / after / inside).
+ */
+export declare function attachTreeViewDragDrop(content: HTMLElement, ctx: TreeViewDragDropContext): TreeViewDragDropHandle;

package/dist/types/tree-view/TreeViewPlugin.d.ts

@@ -0,0 +1,66 @@
+import { Viewer3d, Plugin, PluginConfig, THREE } from "@gcode-viewer/core";
+import { BasePanel } from "@gcode-viewer/ui";
+/**
+ * Tree view plugin config.
+ */
+export interface TreeViewPluginConfig extends Partial<PluginConfig> {
+    /**
+     * Host element id: panel is embedded there (fills the box) with left-dock styling.
+     * If omitted, the panel floats over the viewer `widgetContainer` as before.
+     */
+    containerId?: string;
+    /**
+     * If panel is visible. It is visible by default.
+     */
+    visible?: boolean;
+}
+/**
+ * Tree view plugin events.
+ */
+type TreeViewPluginEvents = {
+    /**
+     * Panel visibility change event.
+     */
+    visibilitychange: boolean;
+};
+/**
+ * Tree view plugin.
+ */
+export declare class TreeViewPlugin extends Plugin<TreeViewPluginEvents> {
+    static readonly DEFAULT_ID = "TreeViewPlugin";
+    protected cfg: TreeViewPluginConfig;
+    protected basePanel?: BasePanel;
+    protected container?: HTMLDivElement;
+    protected content?: HTMLDivElement;
+    protected lastHighlightedObject?: THREE.Object3D;
+    /** Current tree name filter (persisted across panel rebuilds). */
+    private treeSearchQuery;
+    private treeSearchInput?;
+    private treeSearchDebounceId;
+    /** `null` = no filter; otherwise uuids kept visible for current `treeSearchQuery`. */
+    private treeSearchVisibleCache;
+    /** Ends inline tree rename if one is active (`commit`: apply input to `node.name`). */
+    private finishActiveTreeRename?;
+    private treeDragDrop?;
+    /** Suppresses the synthetic click after a tree drag (pointerup → click). */
+    private suppressTreeClickAfterDrag;
+    constructor(viewer: Viewer3d, cfg?: TreeViewPluginConfig);
+    private onLanguageChange;
+    protected applyLocalizedChrome(): void;
+    protected updateContent(): void;
+    setVisible(visible: boolean): void;
+    isVisible(): boolean;
+    protected onModelLoadOrRemove: () => void;
+    protected onObjectSelected: (evt: THREE.Object3D) => void;
+    protected onObjectDeselected: (evt: THREE.Object3D) => void;
+    protected onSceneObjectRemoved: (object: THREE.Object3D) => void;
+    protected onSceneObjectAdded: (object: THREE.Object3D) => void;
+    destroy(): void;
+    protected addContent(): void;
+    protected onSceneNodeReparented: (object: THREE.Object3D) => void;
+    private onTreeSearchInputClick;
+    private onTreeSearchKeydown;
+    private onTreeSearchInput;
+    private removeTreeDomForSceneObject;
+}
+export {};

package/dist/types/tree-view/index.d.ts

@@ -0,0 +1,2 @@
+import "./TreeView.scss";
+export * from "./TreeViewPlugin";

package/dist/types/view-cube/Locale.d.ts

@@ -0,0 +1,21 @@
+import { i18n } from "@gcode-viewer/core";
+export declare const en: {
+    front: string;
+    back: string;
+    top: string;
+    bottom: string;
+    left: string;
+    right: string;
+};
+export declare const zh: {
+    front: string;
+    back: string;
+    top: string;
+    bottom: string;
+    left: string;
+    right: string;
+};
+export declare const VIEW_CUBE_I18N_NAMESPACE: "viewCube";
+export { i18n };
+export type ViewCubeTranslationKey = keyof typeof en;
+export declare function t(key: ViewCubeTranslationKey | string): string;

package/dist/types/view-cube/ViewCube.d.ts

@@ -0,0 +1,86 @@
+import { THREE } from "@gcode-viewer/core";
+/**
+ * View cube config.
+ */
+export interface ViewCubeConfig {
+    showAxes?: boolean;
+    lineColor?: number;
+}
+/**
+ * View cube element names.
+ */
+export declare enum ViewCubeElement {
+    TopFace = "TopFace",
+    FrontFace = "FrontFace",
+    RightFace = "RightFace",
+    BackFace = "BackFace",
+    LeftFace = "LeftFace",
+    BottomFace = "BottomFace",
+    TopFrontEdge = "TopFrontEdge",
+    TopRightEdge = "TopRightEdge",
+    TopBackEdge = "TopBackEdge",
+    TopLeftEdge = "TopLeftEdge",
+    FrontRightEdge = "FrontRightEdge",
+    BackRightEdge = "BackRightEdge",
+    BackLeftEdge = "BackLeftEdge",
+    FrontLeftEdge = "FrontLeftEdge",
+    BottomFrontEdge = "BottomFrontEdge",
+    BottomRightEdge = "BottomRightEdge",
+    BottomBackEdge = "BottomBackEdge",
+    BottomLeftEdge = "BottomLeftEdge",
+    TopFrontRightCorner = "TopFrontRightCorner",
+    TopBackRightCorner = "TopBackRightCorner",
+    TopBackLeftCorner = "TopBackLeftCorner",
+    TopFrontLeftCorner = "TopFrontLeftCorner",
+    BottomFrontRightCorner = "BottomFrontRightCorner",
+    BottomBackRightCorner = "BottomBackRightCorner",
+    BottomBackLeftCorner = "BottomBackLeftCorner",
+    BottomFrontLeftCorner = "BottomFrontLeftCorner"
+}
+/**
+ * ViewCube class.
+ */
+export declare class ViewCube extends THREE.Object3D {
+    readonly name = "ViewCube";
+    private readonly AXIS_COLOR_X;
+    private readonly AXIS_COLOR_Y;
+    private readonly AXIS_COLOR_Z;
+    private readonly FACE_BACKGROUND_COLOR;
+    private readonly FACE_HOVER_BACKGROUND_COLOR;
+    private readonly INNER_CUBE_WIDTH;
+    private readonly OUTER_CUBE_WIDTH;
+    private readonly CORNER_WIDTH;
+    private readonly AXIS_LENGTH;
+    private readonly EDGE_COLOUR;
+    private readonly EDGE_OPACITY;
+    private readonly EDGE_SIZE;
+    private readonly CORNER_COLOR;
+    private readonly CORNER_OPACITY;
+    private faces;
+    private innerViewCubeMesh?;
+    private showAxes;
+    private lineColor;
+    dirty: boolean;
+    activateMeshName?: string;
+    constructor(cfg?: ViewCubeConfig);
+    private init;
+    private createAxes;
+    private createViewCubeFaces;
+    private createViewCubeFace;
+    private createViewCubeEdges;
+    private createEdge;
+    private createViewCubeCorners;
+    private createCorner;
+    getBBox(): THREE.Box3;
+    /**
+     * Maps a Y-up view-cube direction into this product's Z-up world:
+     * `(x, y, z)_yup → (x, -z, y)_zup`.
+     */
+    private static toZUpDirection;
+    getDirectionByElement(viewCubeName: ViewCubeElement): THREE.Vector3 | undefined;
+    update(): void;
+    private updateViewCube;
+    private updateMeshTick;
+    /** Refresh face label textures after {@link ViewerEvent.LanguageChange}. */
+    updateLocalizedLabels(): void;
+}