@xviewer.js/debug 1.0.4-alpha.0 → 1.0.4-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xviewer.js/debug",
-  "version": "1.0.4-alpha.0",
+  "version": "1.0.4-alpha.2",
   "license": "MIT",
   "type": "module",
   "main": "dist/main.cjs",
@@ -12,7 +12,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@xviewer.js/core": "1.0.4-alpha.0"
+    "@xviewer.js/core": "1.0.4-alpha.2"
+  },
+  "peerDependencies": {
+    "three": ">= 0.179.0"
   },
   "scripts": {
     "b:types": "tsc"

package/types/Inspector.d.ts

@@ -1,17 +1,18 @@
-import { Mount } from "@xviewer.js/core";
-export declare class Inspector extends Mount {
-    private _gui;
-    private _scene;
+import { Vector4 } from "three";
+import { Component } from "@xviewer.js/core";
+export declare class Inspector extends Component {
+    static viewport: Vector4;
     private _camera;
     private _sprite;
+    private _spriteUniforms;
+    private _gui;
+    private _tree;
     private _refCntMap;
     private _targetMap;
     onLoad(): void;
     onDestroy(): void;
     update(dt: number): void;
     resize(width: number, height: number): void;
-    private _addSprite;
-    private _renderScene;
     private _renderSprite;
     private _updateFolders;
     private _getPropertiesList;

package/types/Stats.d.ts

@@ -1,5 +1,5 @@
-import { Mount } from "@xviewer.js/core";
-export declare class Stats extends Mount {
+import { Component } from "@xviewer.js/core";
+export declare class Stats extends Component {
     private _stats;
     private _dcPanel;
     private _triPanel;

package/types/gui/GUI.d.ts

@@ -1,4 +1,4 @@
-import "./css/index.scss";
+import "./css/index.css";
 import { Controller } from "./controllers/Controller";
 import { OptionController } from "./controllers/OptionController";
 import { NumberController } from "./controllers/NumberController";
@@ -9,6 +9,7 @@ import { ColorController } from "./controllers/ColorController";
 import { VectorController } from "./controllers/VectorController";
 import { CurveController } from "./controllers/CurveController";
 import { TextureController } from "./controllers/TextureController";
+import { SceneTreeController } from "./controllers/SceneTreeController";
 export declare class GUI {
     id: string;
     parent: GUI;
@@ -91,6 +92,12 @@ export declare class GUI {
      */
     addVector(object: Object, property: string, min?: number, max?: number, step?: number): VectorController;
     addCurve(object: Object, property: string): CurveController;
+    /**
+     * Adds a scene tree controller to display Three.js scene hierarchy.
+     * @param {Scene} scene The Three.js scene to display
+     * @returns {SceneTreeController}
+     */
+    addSceneTree(scene: any): SceneTreeController;
     /**
      * Adds a folder to the GUI, which is just another GUI. This method returns
      * the nested GUI so you can add controllers to it.
@@ -100,8 +107,6 @@ export declare class GUI {
      * folder.add( position, 'y' );
      * folder.add( position, 'z' );
      *
-     * @param {string} title Name to display in the folder's title bar.
-     * @param {string} id Id
      * @returns {GUI}
      */
     addFolder(title: string, id?: string): GUI;
@@ -246,4 +251,12 @@ export declare class GUI {
      */
     foldersRecursive(): GUI[];
     update(): void;
+    /**
+     * Sets this folder as active and deactivates all other folders
+     */
+    setActive(): void;
+    /**
+     * Gets the currently active folder
+     */
+    getActiveFolder(): GUI | null;
 }

package/types/gui/controllers/SceneTreeController.d.ts

@@ -0,0 +1,67 @@
+import { GUI } from "../GUI";
+import { Controller } from "./Controller";
+import { Object3D, Scene } from "three";
+export interface SceneTreeNode {
+    object: Object3D;
+    name: string;
+    type: string;
+    visible: boolean;
+    children: SceneTreeNode[];
+    expanded: boolean;
+}
+export declare class SceneTreeController extends Controller {
+    private $treeContainer;
+    private _scene;
+    private _rootNode;
+    private _selectedObject;
+    private _onObjectSelect;
+    private _autoUpdate;
+    private _cachedObjectCount;
+    private _lastUpdateTime;
+    private _updateInterval;
+    private _visibleNodeCount;
+    private _contextMenu;
+    private _contextMenuTarget;
+    private _clipboardData;
+    constructor(parent: GUI, scene: Scene);
+    private _setupDOM;
+    private _createContextMenu;
+    private _setupGlobalEventListeners;
+    private _showContextMenu;
+    private _updateContextMenuState;
+    private _hideContextMenu;
+    private _handleContextMenuAction;
+    private _exportObject;
+    private _copyObject;
+    private _pasteObject;
+    private _serializeObject;
+    private _deserializeObject;
+    private _findParentNode;
+    private _buildSceneTree;
+    private _renderTree;
+    private _renderNode;
+    private _selectObject;
+    onObjectSelect(callback: (object: Object3D) => void): this;
+    refresh(): void;
+    getSelectedObject(): Object3D | null;
+    expandAll(): void;
+    collapseAll(): void;
+    update(): void;
+    private _shouldCheckForChanges;
+    setAutoUpdate(enabled: boolean): void;
+    setUpdateInterval(intervalMs: number): void;
+    getUpdateInterval(): number;
+    getAutoUpdate(): boolean;
+    forceUpdate(): void;
+    private _checkForStructuralChanges;
+    private _hasSceneStructureChanged;
+    private _checkObjectCount;
+    private _checkObjectReferences;
+    private _hasChildrenChanged;
+    private _countObjects;
+    private _rebuildSceneTree;
+    private _hasStructureChanged;
+    private _preserveExpandedStates;
+    private _updateVisibilityStates;
+    destroy(): void;
+}

package/types/gui/controllers/SceneTreeController.example.d.ts

@@ -0,0 +1,12 @@
+import { GUI } from "../GUI";
+import { SceneTreeController } from "./SceneTreeController";
+import { Scene } from "three";
+export declare function createSceneTreeExample(): {
+    gui: GUI;
+    scene: Scene;
+    sceneTree: SceneTreeController;
+};
+export declare function integrateWithViewer(viewer: any): {
+    gui: GUI;
+    sceneTree: SceneTreeController;
+};

package/types/gui/utils/getColorFormat.d.ts

@@ -1,12 +1,12 @@
 import { normalizeColorString } from './normalizeColorString';
 export declare function getColorFormat(value: any): {
     isPrimitive: boolean;
-    match: (v: any) => boolean;
+    match: (v: any) => v is string;
     fromHexString: typeof normalizeColorString;
     toHexString: typeof normalizeColorString;
 } | {
     isPrimitive: boolean;
-    match: (v: any) => boolean;
+    match: (v: any) => v is any[];
     fromHexString(string: any, target: any, rgbScale?: number): void;
     toHexString([r, g, b]: [any, any, any], rgbScale?: number): string;
 } | {

package/types/helpers/BoxProjectionHelper.d.ts

@@ -0,0 +1,10 @@
+import { Mount } from "@xviewer.js/core";
+export declare class BoxProjectionHelper extends Mount {
+    private _box3;
+    private _helper;
+    private _target;
+    onLoad(): void;
+    onEnable(): void;
+    onDisable(): void;
+    update(dt: number): void;
+}

package/types/helpers/ViewerHelper.d.ts

@@ -0,0 +1,30 @@
+import { ObjectInstance, Viewer } from "@xviewer.js/core";
+import { Color, ColorSpace, CubeTexture, Euler, Texture, ToneMapping } from "three";
+export declare class ViewerHelper extends ObjectInstance {
+    get outputColorSpace(): ColorSpace;
+    set outputColorSpace(v: ColorSpace);
+    get toneMapping(): ToneMapping;
+    set toneMapping(v: ToneMapping);
+    get toneMappingExposure(): number;
+    set toneMappingExposure(v: number);
+    get shadows(): boolean;
+    set shadows(v: boolean);
+    get backgroundBlurriness(): number;
+    set backgroundBlurriness(v: number);
+    get environment(): Texture;
+    set environment(v: Texture);
+    get environmentIntensity(): number;
+    set environmentIntensity(v: number);
+    get environmentRotation(): Euler;
+    set environmentRotation(v: Euler);
+    get background(): Texture | Color | CubeTexture;
+    set background(v: Texture | Color | CubeTexture);
+    get backgroundRotation(): Euler;
+    set backgroundRotation(v: Euler);
+    get targetFrameRate(): number;
+    set targetFrameRate(v: number);
+    private _scene;
+    private _renderer;
+    private _viewer;
+    constructor(viewer: Viewer);
+}

package/types/index.d.ts

@@ -1,4 +1,3 @@
 export { GUI } from "./gui/GUI";
 export { Inspector } from "./Inspector";
 export { Stats } from "./Stats";
-export { BoxProjectionHelper } from "./BoxProjectionHelper";