babylonjs-editor 4.4.0 → 4.5.0

package/index.d.ts

@@ -9,7 +9,6 @@
 //   ../../@blueprintjs/select
 //   renderer/editor/graph/node.d.ts
 //   ../../xterm
-//   ../../rc-tree/lib/interface
 //   ../../node-pty
 
 declare module 'babylonjs-editor' {
@@ -243,11 +242,12 @@ declare module 'babylonjs-editor/renderer/editor/editor' {
     import { IStringDictionary, Nullable, Undefinable } from "babylonjs-editor/shared/types";
     import { Toaster, Intent, IconName, MaybeElement } from "@blueprintjs/core";
     import { Layout, Rect } from "flexlayout-react";
-    import { Engine, Scene, Observable, ISize, Node, BaseTexture, Material, SubMesh, IParticleSystem, Sound, KeyboardInfo, Skeleton } from "babylonjs";
+    import { Engine, Scene, Observable, ISize, Node, BaseTexture, Material, SubMesh, IParticleSystem, Sound, KeyboardInfo, Skeleton, ReflectionProbe } from "babylonjs";
     import { IObjectModified, IEditorPreferences, EditorPlayMode } from "babylonjs-editor/renderer/editor/tools/types";
     import { AbstractEditorPlugin } from "babylonjs-editor/renderer/editor/tools/plugin";
     import { SceneUtils } from "babylonjs-editor/renderer/editor/scene/utils";
     import { IPlugin } from "babylonjs-editor/renderer/editor/plugins/plugin";
+    import "./scene/register";
     import "./painting/material-mixer/material";
     import { Inspector } from "babylonjs-editor/renderer/editor/components/inspector";
     import { Graph } from "babylonjs-editor/renderer/editor/components/graph";
@@ -276,19 +276,23 @@ declare module 'babylonjs-editor/renderer/editor/editor' {
     import "./components/inspectors/cameras/camera-inspector";
     import "./components/inspectors/cameras/free-camera-inspector";
     import "./components/inspectors/cameras/arc-rotate-camera-inspector";
+    import "./components/inspectors/cameras/target-camera-inspector";
     import "./components/inspectors/materials/standard-inspector";
     import "./components/inspectors/materials/pbr-inspector";
+    import "./components/inspectors/materials/pbr-metallic-rougness-inspector";
     import "./components/inspectors/materials/sky-inspector";
     import "./components/inspectors/materials/node-inspector";
     import "./components/inspectors/materials/cell-inspector";
     import "./components/inspectors/materials/fire-inspector";
     import "./components/inspectors/materials/lava-inspector";
     import "./components/inspectors/materials/water-inspector";
+    import "./components/inspectors/materials/gradient-inspector";
     import "./components/inspectors/materials/tri-planar-inspector";
     import "./components/inspectors/textures/texture-inspector";
     import "./components/inspectors/particle-systems/particle-system-inspector";
     import "./components/inspectors/particle-systems/particle-system-gradients-inspector";
     import "./components/inspectors/sound/sound-inspector";
+    import "./components/inspectors/textures/reflection-probe-inspector";
     export interface ILayoutTabNodeConfiguration {
             /**
                 * Defines the name of the layout tab node.
@@ -388,6 +392,10 @@ declare module 'babylonjs-editor/renderer/editor/editor' {
                 * Notifies observers that a particle system has been selected in the editor (preview or graph).
                 */
             selectedParticleSystemObservable: Observable<IParticleSystem>;
+            /**
+                * Notifies observers that a reflection probe has been selected in the editor (preview or graph).
+                */
+            selectedReflectionProbeObservable: Observable<ReflectionProbe>;
             /**
                 * Notifies observers that a texture has been selected in the editor (assets).
                 */
@@ -815,6 +823,12 @@ declare module 'babylonjs-editor/renderer/editor/tools/fs' {
                 * @param directoryPath defines the absolute path to the directory to remove.
                 */
             static RemoveDirectory(directoryPath: string): Promise<void>;
+            /**
+                * Waits until the given file (absolute path) exists.
+                * @param filePath defines the absolute path to the file to test until it exists.
+                * @param timeout defines the optional timeout to resolve the promise @default 10000
+                */
+            static WaitUntilFileExists(filePath: string, timeout?: number): Promise<void>;
     }
 }
 
@@ -1282,6 +1296,10 @@ declare module 'babylonjs-editor/renderer/editor/components/assets-browser/files
                 * Computes the image to render as a preview.
                 */
             abstract computePreview(): React.ReactNode | Promise<React.ReactNode>;
+            /**
+                * Refreshes the preview thumbnail of the asset.
+                */
+            _handleRefreshPreview(): Promise<void>;
             /**
                 * Called on the user clicks on the asset.
                 * @param ev defines the reference to the event object.
@@ -1592,6 +1610,11 @@ declare module 'babylonjs-editor/renderer/editor/components/inspector' {
                 * @param callback defines the callback called on the update is done.
                 */
             forceUpdate(callback?: (() => void) | undefined): void;
+            /**
+                * Catches exceptions generated in descendant components.
+                * Unhandled exceptions will cause the entire component tree to unmount.
+                */
+            componentDidCatch(error: Error, errorInfo: React.ErrorInfo): void;
             /**
                 * Sets the selected object in the scene or graph to be edited.
                 * @param object the selected object reference used by the inspector to be modified.
@@ -1611,7 +1634,7 @@ declare module 'babylonjs-editor/renderer/editor/components/inspector' {
 declare module 'babylonjs-editor/renderer/editor/components/inspectors/abstract-inspector' {
     import { Nullable } from "babylonjs-editor/shared/types";
     import * as React from "react";
-    import { Texture, Material, ISize } from "babylonjs";
+    import { Texture, Material, ISize, BaseTexture } from "babylonjs";
     import { IObjectInspectorProps } from "babylonjs-editor/renderer/editor/components/inspector";
     import { IInspectorListItem } from "babylonjs-editor/renderer/editor/gui/inspector/fields/list";
     import { IInspectorNotifierUndoRedo } from "babylonjs-editor/renderer/editor/gui/inspector/utils";
@@ -1675,11 +1698,15 @@ declare module 'babylonjs-editor/renderer/editor/components/inspectors/abstract-
             /**
                 * Returns the list of available textures in the assets to be drawn.
                 */
-            getTexturesList(): IInspectorListItem<Nullable<Texture>>[];
+            getTexturesList(predicate?: (t: BaseTexture) => unknown): IInspectorListItem<Nullable<Texture>>[];
             /**
                 * Returns the list of available materials in the assets to be drawn.
                 */
             getMaterialsList(): IInspectorListItem<Nullable<Material>>[];
+            /**
+                * Gets all nodes in the current scene, or returns an empty array if no scene.
+                */
+            getSceneNodes(allowedType?: "TransformNode" | "Mesh" | "Light" | "Camera" | "AbstractMesh"): IInspectorListItem<string>[];
     }
 }
 
@@ -2932,6 +2959,15 @@ declare module 'babylonjs-editor/renderer/editor/project/typings' {
                         */
                     url: string;
             };
+            /**
+                * Defines the options of the Basis compression tool.
+                */
+            basisCompressedTextures?: {
+                    /**
+                        * Defines wether or not Basis compressed texture is enabled using KTX Software.
+                        */
+                    enabled?: boolean;
+            };
             /**
                 * Defines the options of the KTX2 compression tool.
                 */
@@ -2941,9 +2977,16 @@ declare module 'babylonjs-editor/renderer/editor/project/typings' {
                         */
                     enabled?: boolean;
                     /**
-                        * Defines the path to the PVRTexToolCLI program executed to
+                        * Defines the path to the PVRTexToolCLI program executed to generate all compressed textures files.
                         */
-                    pvrTexToolCliPath?: string;
+                    pvrTexToolCliPath?: string | Record<string, string>;
+                    /**
+                        * Defines the path to the NVidia Texture Tools program executed to generate DXT and ASTC files.
+                        */
+                    nvidiaTextureTools?: {
+                            enabled?: boolean;
+                            cliPath?: string;
+                    };
                     /**
                         * Defines wether or not the Editor automatically generates compressed textures
                         * to be used in the Editor's preview scene.
@@ -2966,6 +3009,10 @@ declare module 'babylonjs-editor/renderer/editor/project/typings' {
                         * Defines the options of the PVRTC format.
                         */
                     pvrtcOptions?: {
+                            /**
+                                * Defines wether or not PVRTC is enabled.
+                                */
+                            enabled?: boolean;
                             /**
                                 * Defines the quality of the PVRTC generated textures.
                                 */
@@ -3087,6 +3134,10 @@ declare module 'babylonjs-editor/renderer/editor/project/typings' {
                 * Defines the list of all scene's morph target managers.
                 */
             morphTargetManagers?: string[];
+            /**
+                * Defines the list of all reflection probes.
+                */
+            reflectionProbes?: string[];
             /**
                 * Saves the scene's settings.
                 */
@@ -4370,66 +4421,40 @@ declare module 'babylonjs-editor/renderer/editor/scene/utils' {
 
 declare module 'babylonjs-editor/renderer/editor/components/graph' {
     import * as React from "react";
-    import { DataNode } from "rc-tree/lib/interface";
-    import { Nullable, Undefinable } from "babylonjs-editor/shared/types";
-    import { Node, Scene, IParticleSystem, Sound } from "babylonjs";
+    import { TreeNodeInfo } from "@blueprintjs/core";
     import { Editor } from "babylonjs-editor/renderer/editor/editor";
+    export interface _IDragAndDroppedItem {
+            nodeId: string;
+            onDropInInspector: (ev: React.DragEvent<HTMLElement>, object: any, property: string) => Promise<void>;
+    }
     export interface IGraphProps {
             /**
-                * Defines the editor reference.
+                * Defines the reference to the editor.
                 */
             editor: Editor;
-            /**
-                * Defines the reference to the scene to traverse.
-                */
-            scene?: Undefinable<Scene>;
     }
     export interface IGraphState {
             /**
-                * Defines the list of all nodes to be draws in the editor.
-                */
-            nodes: DataNode[];
-            /**
-                * Defines the list of all expanded nodes.
-                */
-            expandedNodeIds?: Undefinable<string[]>;
-            /**
-                * Defines the list of all selected nodes.
-                */
-            selectedNodeIds?: Undefinable<string[]>;
-            /**
-                * Defines the current filter to search nodes.
+                * Defines the current string of the filter box.
                 */
             filter: string;
             /**
-                * Defines the panel's width.
-                */
-            width?: number;
-            /**
-                * Defines wether or not the graphs options should be drawn.
-                */
-            showOptions: boolean;
-            /**
-                * Defines wether or not the instances should be shown in the graph.
+                * Defines the list of all nodes drawn in the graph.
                 */
-            showInstances: boolean;
+            nodes: TreeNodeInfo<any>[];
             /**
-                * Defines wether or not the lights should be shown in the graph.
+                * Defines the list of all selected nodes in the graph.
                 */
-            showLights: boolean;
-    }
-    export interface _IDragAndDroppedItem {
-            nodeId: string;
-            onDropInInspector: (ev: React.DragEvent<HTMLElement>, object: any, property: string) => Promise<void>;
+            selectedNodes: TreeNodeInfo<any>[];
     }
     export class Graph extends React.Component<IGraphProps, IGraphState> {
             /**
-                * Defines the last selected node in the graph.
+                * Defines the reference to the last selected object.
                 */
-            lastSelectedObject: Nullable<Node | IParticleSystem | Sound>;
+            lastSelectedObject: any;
             /**
                 * Constructor.
-                * @param props the component's props.
+                * @param props defines the component's props.
                 */
             constructor(props: IGraphProps);
             /**
@@ -4437,68 +4462,33 @@ declare module 'babylonjs-editor/renderer/editor/components/graph' {
                 */
             render(): React.ReactNode;
             /**
-                * Resizes the panel
-                */
-            resize(): void;
-            /**
-                * Refreshes the graph.
-                * @param done called on the refresh process finished.
-                */
-            refresh(done?: Undefinable<() => void>): void;
-            /**
-                * Clears the graph.
-                */
-            clear(): void;
-            /**
-                * Selecs the given node in the graph.
-                * @param node the node to select in the graph.
-                * @param appendToSelected defines wether or not the selected node should be appended to the currently selected nodes.
-                */
-            setSelected(node: Node | IParticleSystem | Sound, appendToSelected?: boolean): void;
-            /**
-                * Refreshes the graph and selects the given node. Mainly used by assets.
-                * @param node the node to select in the graph.
+                * Removes the given object from the scene graph.
+                * @param node defines the reference to the object to remove.
                 */
-            refreshAndSelect(node: Node): void;
+            removeObject(node: any): void;
             /**
-                * Returns the list of all selected nodes (node, particle system, sound).
+                * Resizes the component.
                 */
-            getAllSelected(): (Node | IParticleSystem | Sound)[];
+            resize(): void;
             /**
-                * Clones the given node.
-                * @param node the node to clone.
+                * Called on the user clicks on a node.
                 */
-            cloneObject(node: Node | IParticleSystem): Nullable<Node | IParticleSystem>;
+            _handleNodeClick(node: TreeNodeInfo<any>, event: React.MouseEvent<HTMLElement, MouseEvent>): void;
             /**
-                * Removes the given node.
-                * @param node the node to remove.
+                * Refreshes the entire graph.
+                * @param done defines the reference to the callback called on the graph has been updated.
                 */
-            removeObject(node: Node | IParticleSystem | Sound): void;
+            refresh(done?: () => void): void;
             /**
-                * Removes the given node.
-                * @param node the node to remove.
-                * @hidden
+                * Updates the current graph state without parsing the scene nodes.
                 */
-            _removeObject(node: Node | IParticleSystem | Sound): {
-                    redo: () => void;
-                    undo: () => void;
-            };
+            update(): void;
             /**
-                * Removes the given node from the graph and destroys its data.
-                * @hidden
+                * Sets the given object selected in the graph.
+                * @param object defines the reference to the object to set selected in the graph.
+                * @param appendToSelected defines wether or not the object should be added to the currently selected node(s) in the graph.
                 */
-            _handleRemoveObject(): void;
-            /**
-                * Clones all selected nodes.
-                * @hidden
-                */
-            _handleCloneObject(): void;
-            /**
-                * Returns the node in the stage identified by the given id.
-                * @param id the id of the node to find.
-                * @hidden
-                */
-            _getNodeById(id: string): Undefinable<Node | IParticleSystem | Sound>;
+            setSelected(object: any, appendToSelected?: boolean): void;
     }
 }
 
@@ -4629,7 +4619,7 @@ declare module 'babylonjs-editor/renderer/editor/components/assets-browser' {
 declare module 'babylonjs-editor/renderer/editor/components/preview' {
     import { Nullable } from "babylonjs-editor/shared/types";
     import * as React from "react";
-    import { Node, IParticleSystem, AbstractMesh, Sound, Observable } from "babylonjs";
+    import { Node, IParticleSystem, AbstractMesh, Sound, Observable, ReflectionProbe } from "babylonjs";
     import { Editor } from "babylonjs-editor/renderer/editor/editor";
     import { ScenePicker } from "babylonjs-editor/renderer/editor/scene/picker";
     import { SceneGizmo, GizmoType } from "babylonjs-editor/renderer/editor/scene/gizmo";
@@ -4793,7 +4783,7 @@ declare module 'babylonjs-editor/renderer/editor/components/preview' {
                 * @param node defines the reference to the node to focus.
                 * @param mode defines the focus mode (animate target, position, etc.).
                 */
-            focusNode(node: Node | IParticleSystem | Sound, mode: PreviewFocusMode): void;
+            focusNode(node: Node | IParticleSystem | Sound | ReflectionProbe, mode: PreviewFocusMode): void;
             /**
                 * Copies the currently selected node.
                 */
@@ -4812,6 +4802,7 @@ declare module 'babylonjs-editor/renderer/editor/components/preview' {
 declare module 'babylonjs-editor/renderer/editor/components/main-toolbar' {
     import { Undefinable } from "babylonjs-editor/shared/types";
     import * as React from "react";
+    import { Node } from "babylonjs";
     import { Editor } from "babylonjs-editor/renderer/editor/editor";
     import { IPluginToolbar } from "babylonjs-editor/renderer/editor/plugins/toolbar";
     export interface IToolbarProps {
@@ -4844,6 +4835,18 @@ declare module 'babylonjs-editor/renderer/editor/components/main-toolbar' {
                 * Renders the component.
                 */
             render(): React.ReactNode;
+            /**
+                * Returns the list of all items of the "Add" menu.
+                */
+            getAddMenuItems(parent?: Node): React.ReactNode;
+            /**
+                * Returns the list of all items of the "Add Mesh" menu.
+                */
+            getAddMeshMenuItem(parent?: Node): React.ReactNode;
+            /**
+                * Called on the component did mount.
+                */
+            componentDidMount(): void;
     }
 }
 
@@ -5171,7 +5174,7 @@ declare module 'babylonjs-editor/renderer/editor/gui/inspector/utils' {
 
 declare module 'babylonjs-editor/renderer/sandbox/main' {
     import { Nullable } from "babylonjs-editor/shared/types";
-    import { Vector2, Vector3, Vector4, Color3, Color4 } from "babylonjs";
+    import { Vector2, Vector3, Vector4, Color3, Color4, Quaternion } from "babylonjs";
     export interface IExportedInspectorValueOptions {
             /**
                 * Defines the section of the inspector.
@@ -5189,6 +5192,10 @@ declare module 'babylonjs-editor/renderer/sandbox/main' {
                 * In case of numbers, defines the step applied in the editor.
                 */
             step?: number;
+            /**
+                * In case of node, restricts the type of node that can be assigned
+                */
+            allowedNodeType?: "TransformNode" | "Mesh" | "Light" | "Camera";
     }
     export interface IExportedInspectorValue {
             /**
@@ -5202,11 +5209,11 @@ declare module 'babylonjs-editor/renderer/sandbox/main' {
             /**
                 * Defines the default value of the decorated property.
                 */
-            defaultValue: number | string | boolean | Vector2 | Vector3 | Vector4 | Color3 | Color4;
+            defaultValue: number | string | boolean | Vector2 | Vector3 | Vector4 | Color3 | Color4 | Quaternion;
             /**
                 * Defines the type of the decorated property.
                 */
-            type: "number" | "string" | "boolean" | "KeyMap" | "Vector2" | "Vector3" | "Vector4" | "Color3" | "Color4" | "Texture";
+            type: "number" | "string" | "boolean" | "KeyMap" | "Vector2" | "Vector3" | "Vector4" | "Color3" | "Color4" | "Texture" | "Quaternion" | "Node";
             /**
                 * Defines the optional options available for the exported value.
                 */
@@ -5306,6 +5313,10 @@ declare module 'babylonjs-editor/renderer/editor/tools/ktx' {
                 * Returns the list of all support Ktx formats.
                 */
             static GetAllKtxFormats(): KTXToolsType[];
+            /**
+                * Returns the path to the CLI according to the current platform.
+                */
+            static GetCliPath(): Nullable<string>;
             /**
                 * Returns the of the given texture path by applying the ktx extension to it.
                 * @param texturePath defines the path to the texture to gets its Ktx name.
@@ -5602,6 +5613,10 @@ declare module 'babylonjs-editor/renderer/editor/components/assets-browser/files
                 * Renders the component.
                 */
             render(): React.ReactNode;
+            /**
+                * Returns the list of all items drawn in the "Add..." menu.
+                */
+            getAddMenuItems(): React.ReactNode;
             /**
                 * Sets the new favorite to read and draw its items.
                 * @param favorite defines the id of the favorite to show in the view.
@@ -5616,6 +5631,11 @@ declare module 'babylonjs-editor/renderer/editor/components/assets-browser/files
                 * Refreshes the current list of files.
                 */
             refresh(): Promise<void>;
+            /**
+                * Refreshes the preview thmbnail of the asset located at the given relative path.
+                * @param relativePath defines the relative path to the asset.
+                */
+            refreshItemPreview(relativePath: string): Promise<void>;
             /**
                 * Calls the given function in all the selected items (if exists).
                 * @param methodName defines the name of the function to call.
@@ -5665,7 +5685,7 @@ declare module 'babylonjs-editor/renderer/editor/scene/picker' {
 }
 
 declare module 'babylonjs-editor/renderer/editor/scene/gizmo' {
-    import { UtilityLayerRenderer, Node, IParticleSystem, Sound } from "babylonjs";
+    import { UtilityLayerRenderer, Node, IParticleSystem, Sound, ReflectionProbe } from "babylonjs";
     import { Nullable } from "babylonjs-editor/shared/types";
     import { Editor } from "babylonjs-editor/renderer/editor/editor";
     export enum GizmoType {
@@ -5700,7 +5720,7 @@ declare module 'babylonjs-editor/renderer/editor/scene/gizmo' {
                 * Sets the given node attached to the current gizmos if exists.
                 * @param node the node to attach to current gizmos if exists.
                 */
-            setAttachedNode(node: Nullable<Node | IParticleSystem | Sound>): void;
+            setAttachedNode(node: Nullable<Node | IParticleSystem | Sound | ReflectionProbe>): void;
     }
 }
 
@@ -5795,7 +5815,7 @@ declare module 'babylonjs-editor/renderer/editor/components/console/log' {
                 * Sets the new body of the log.
                 * @param body defines the reference to the custom body.
                 */
-            setBody(body: React.ReactNode): void;
+            setBody(body: React.ReactNode): Promise<void>;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-editor",
-    "version": "4.4.0",
+    "version": "4.5.0",
     "description": "Babylon.js Editor is a Web Application helping artists to work with Babylon.js",
     "productName": "Babylon.js Editor",
     "typings": "index.d.ts",