babylonjs-editor 5.4.1-alpha.8 → 5.4.1-rc.1

package/declaration/src/editor/layout/inspector/sound/sound-node.d.ts

@@ -0,0 +1,23 @@
+import { Component, ReactNode } from "react";
+import { SoundNode } from "../../../nodes/sound";
+import { IEditorInspectorImplementationProps } from "../inspector";
+export interface IEditorSoundNodeInspectorState {
+    dragOver: boolean;
+}
+export declare class EditorSoundNodeInspector extends Component<IEditorInspectorImplementationProps<SoundNode>, IEditorSoundNodeInspectorState> {
+    /**
+     * Returns whether or not the given object is supported by this inspector.
+     * @param object defines the object to check.
+     * @returns true if the object is supported by this inspector.
+     */
+    static IsSupported(object: unknown): boolean;
+    constructor(props: IEditorInspectorImplementationProps<SoundNode>);
+    private _gizmoObserver;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): ReactNode;
+    private _getSoundInspector;
+    private _handlePlay;
+    private _handleStop;
+    private _getSoundDraggableZone;
+}

package/declaration/src/editor/layout/preview/{gizmo.d.ts → gizmo/gizmo.d.ts}

@@ -1,4 +1,5 @@
 import { GizmoCoordinatesMode, Node, Observable, PositionGizmo, RotationGizmo, ScaleGizmo, Scene, UtilityLayerRenderer, Sprite } from "babylonjs";
+import { IGizmoSnapPreferences } from "../../../../tools/scene/gizmo";
 export declare const onGizmoNodeChangedObservable: Observable<Node | Sprite>;
 export declare class EditorPreviewGizmo {
     /**
@@ -13,6 +14,7 @@ export declare class EditorPreviewGizmo {
     private _attachedNode;
     private _attachedSprite;
     private _spriteTransformNode;
+    private _snapPreferences;
     constructor(scene: Scene);
     /**
      * Gets the current gizmo.
@@ -23,6 +25,9 @@ export declare class EditorPreviewGizmo {
      * @param gizmo The gizmo to set.
      */
     setGizmoType(gizmo: "position" | "rotation" | "scaling" | "none"): void;
+    getSnapPreferences(): IGizmoSnapPreferences;
+    setSnapPreferences(prefs: IGizmoSnapPreferences): void;
+    private _applySnapToCurrentGizmos;
     /**
      * Gets the reference to the node that is attached and controlled by the gizmo.
      */

package/declaration/src/editor/layout/preview/gizmo/settings.d.ts

@@ -0,0 +1,18 @@
+import { Component, ReactNode } from "react";
+import { Editor } from "../../../main";
+export interface IEditorPreviewGizmoSettingsProps {
+    editor: Editor;
+}
+export interface IEditorPreviewGizmoSettingsState {
+}
+export declare class EditorPreviewGizmoSettings extends Component<IEditorPreviewGizmoSettingsProps, IEditorPreviewGizmoSettingsState> {
+    /**
+     * Mutable holder for gizmo snap step fields; EditorInspectorNumberField writes via setInspectorEffectivePropertyValue.
+     * Synced from state when rendering the gizmo snap toolbar.
+     */
+    private _gizmoSnapNumberFields;
+    constructor(props: IEditorPreviewGizmoSettingsProps);
+    render(): ReactNode;
+    private _getSnapFieldComponent;
+    private _commitGizmoSnap;
+}

package/declaration/src/editor/layout/preview/icons.d.ts

@@ -1,5 +1,5 @@
 import { Component, ReactNode } from "react";
-import { Node, Vector2, Sound } from "babylonjs";
+import { Node, Vector2 } from "babylonjs";
 import { Editor } from "../../main";
 export interface IEditorPreviewIconsProps {
     editor: Editor;
@@ -8,8 +8,8 @@ export interface IEditorPreviewIconsState {
     buttons: _IButtonData[];
 }
 interface _IButtonData {
+    node: Node;
     position: Vector2;
-    node: Node | Sound;
 }
 export declare class EditorPreviewIcons extends Component<IEditorPreviewIconsProps, IEditorPreviewIconsState> {
     private _tempMesh;

package/declaration/src/editor/layout/preview/import/sound.d.ts

@@ -1,2 +1,3 @@
+import { Scene, Node } from "babylonjs";
 import { Editor } from "../../../main";
-export declare function applySoundAsset(editor: Editor, object: any, absolutePath: string): Promise<import("../../../../ui/dialog").DialogReturnType | undefined>;
+export declare function applySoundAsset(editor: Editor, parent: Scene | Node, absolutePath: string): Promise<void>;

package/declaration/src/editor/layout/preview.d.ts

@@ -1,11 +1,12 @@
 import { Component, ReactNode } from "react";
 import { AbstractEngine, Camera, ISceneLoaderAsyncResult, Scene, PickingInfo, SelectionOutlineLayer, ClusteredLightContainer } from "babylonjs";
 import { Editor } from "../main";
+import { IGizmoSnapPreferences } from "../../tools/scene/gizmo";
 import { EditorCamera } from "../nodes/camera";
-import { EditorPreviewGizmo } from "./preview/gizmo";
 import { EditorPreviewIcons } from "./preview/icons";
 import { EditorPreviewAxisHelper } from "./preview/axis";
 import { EditorPreviewPlayComponent } from "./preview/play";
+import { EditorPreviewGizmo } from "./preview/gizmo/gizmo";
 import { Stats } from "./preview/stats/stats";
 import { StatsValuesType } from "./preview/stats/types";
 export interface IEditorPreviewProps {
@@ -26,6 +27,7 @@ export interface IEditorPreviewState {
     statsValues?: StatsValuesType;
     playEnabled: boolean;
     playSceneLoadingProgress: number;
+    gizmoSnap: IGizmoSnapPreferences;
     activeGizmo: "position" | "rotation" | "scaling" | "none";
     /**
      * Defines the fixed dimensions of the preview canvas.
@@ -140,6 +142,7 @@ export declare class EditorPreview extends Component<IEditorPreviewProps, IEdito
     private _highlightCurrentMeshUnderPointer;
     private _restoreCurrentMeshUnderPointer;
     private _getToolbar;
+    updateGizmoSnapPreferences(prefs: IGizmoSnapPreferences): void;
     private _getEditToolbar;
     private _switchToCamera;
     /**

package/declaration/src/editor/nodes/sound.d.ts

@@ -0,0 +1,42 @@
+import { Scene, TransformNode, StaticSound } from "babylonjs";
+export declare class SoundNode extends TransformNode {
+    /**
+     * Defines the reference to the sound associated with this node.
+     */
+    sound: StaticSound | null;
+    soundRelativePath: string | null;
+    private _volume;
+    private _spatial;
+    private _maxDistance;
+    private _distanceModel;
+    private _panningModel;
+    /**
+     * Constructor.
+     * @param name defines the name of the scene component.
+     * @param scene defines the reference to the scene where to add the scene component.
+     */
+    constructor(name: string, scene: Scene);
+    setSoundAbsolutePath(absolutePath: string): Promise<void>;
+    get volume(): number;
+    set volume(value: number);
+    get isSpatial(): boolean;
+    set isSpatial(value: boolean);
+    get maxDistance(): number;
+    set maxDistance(value: number);
+    get panningModel(): PanningModelType;
+    set panningModel(value: PanningModelType);
+    get distanceModel(): DistanceModelType;
+    set distanceModel(value: DistanceModelType);
+    disposeSound(): void;
+    /**
+     * Releases resources associated with this scene link.
+     */
+    dispose(): void;
+    /**
+     * Gets the current object class name.
+     * @return the class name
+     */
+    getClassName(): string;
+    serialize(): any;
+    static Parse(parsedData: any, scene: Scene, rootUrl: string): SoundNode;
+}

package/declaration/src/project/add/sound.d.ts

@@ -0,0 +1,4 @@
+import { Node } from "babylonjs";
+import { Editor } from "../../editor/main";
+import { SoundNode } from "../../editor/nodes/sound";
+export declare function addSoundNode(editor: Editor, parent?: Node): SoundNode;

package/declaration/src/project/load/plugins/sound-nodes.d.ts

@@ -0,0 +1,4 @@
+import { Scene } from "babylonjs";
+import { Editor } from "../../../editor/main";
+import { ISceneLoaderPluginOptions } from "../scene";
+export declare function loadSoundNodes(editor: Editor, soundNodeFiles: string[], scene: Scene, options: ISceneLoaderPluginOptions): Promise<void>;

package/declaration/src/project/load/scene.d.ts

@@ -1,5 +1,6 @@
 import { AbstractMesh, AnimationGroup, Camera, Light, TransformNode, IParticleSystem } from "babylonjs";
 import { Editor } from "../../editor/main";
+import { SoundNode } from "../../editor/nodes/sound";
 import { SceneLinkNode } from "../../editor/nodes/scene-link";
 import { SpriteMapNode } from "../../editor/nodes/sprite-map";
 import { SpriteManagerNode } from "../../editor/nodes/sprite-manager";
@@ -19,6 +20,7 @@ export type SceneLoadResult = {
     transformNodes: TransformNode[];
     animationGroups: AnimationGroup[];
     particleSystems: IParticleSystem[];
+    soundNodes: SoundNode[];
     spriteMaps: SpriteMapNode[];
     spriteManagers: SpriteManagerNode[];
 };

package/declaration/src/project/typings.d.ts

@@ -1,3 +1,4 @@
+import { IGizmoSnapPreferences } from "../tools/scene/gizmo";
 export interface IEditorProject {
     /**
      * The version of the editor that saved this project.
@@ -23,6 +24,10 @@ export interface IEditorProject {
      * The package manager being used by the project.
      */
     packageManager?: EditorProjectPackageManager;
+    /**
+     * Gizmo snap preferences (translate / rotate / scale).
+     */
+    gizmoSnap?: IGizmoSnapPreferences;
 }
 export interface IEditorProjectPlugin {
     /**
@@ -31,4 +36,4 @@ export interface IEditorProjectPlugin {
     nameOrPath: string;
 }
 export type EditorProjectPackageManager = "npm" | "yarn" | "pnpm" | "bun";
-export type EditorProjectTemplate = "nextjs" | "solidjs" | "vanillajs" | "electron";
+export type EditorProjectTemplate = "nextjs" | "nuxtjs" | "solidjs" | "vanillajs" | "electron";

package/declaration/src/tools/guards/sound.d.ts

@@ -1,6 +1,12 @@
 import { Sound } from "babylonjs";
+import { SoundNode } from "../../editor/nodes/sound";
 /**
  * Returns wether or not the given object is a Sound.
  * @param object defines the reference to the object to test its class name.
  */
 export declare function isSound(object: any): object is Sound;
+/**
+ * Returns wether or not the given object is a SoundNode.
+ * @param object defines the reference to the object to test its class name.
+ */
+export declare function isSoundNode(object: any): object is SoundNode;

package/declaration/src/tools/scene/gizmo.d.ts

@@ -0,0 +1,15 @@
+/** Minimum snap step (two-decimal increments cannot be smaller than 0.01). */
+export declare const gizmoSnapMinStep = 0.01;
+export interface IGizmoSnapPreferences {
+    translationEnabled: boolean;
+    translationStep: number;
+    rotationEnabled: boolean;
+    rotationStepDegrees: number;
+    scaleEnabled: boolean;
+    scaleStep: number;
+}
+/**
+ * Snap steps are stored and applied with at most two decimal places.
+ */
+export declare function roundGizmoSnapSteps(prefs: IGizmoSnapPreferences): IGizmoSnapPreferences;
+export declare const defaultGizmoSnapPreferences: IGizmoSnapPreferences;

package/declaration/src/tools/scene/screenshot.d.ts

@@ -1,11 +1,19 @@
-import { Scene } from "babylonjs";
+import { Scene, ISize } from "babylonjs";
 /**
  * Takes a screenshot of the scene and returns its base64 value.
  * @param scene defines the reference to the scene to take a screenshot.
+ * @param size defines the optional size of the screenshot. If not provided, the current canvas size will be used.
  */
-export declare function getBase64SceneScreenshot(scene: Scene): Promise<string | undefined>;
+export declare function getBase64SceneScreenshot(scene: Scene, size?: ISize): Promise<string | undefined>;
 /**
  * Takes a screenshot of the scene and returns its buffer value.
  * @param scene defines the reference to the scene to take a screenshot.
+ * @param size defines the optional size of the screenshot. If not provided, the current canvas size will be used.
  */
-export declare function getBufferSceneScreenshot(scene: Scene): Promise<Buffer<ArrayBuffer> | null>;
+export declare function getBufferSceneScreenshot(scene: Scene, size?: ISize): Promise<Buffer<ArrayBuffer> | null>;
+/**
+ * Takes a screenshot of the scene and asks the user to save the generate PNG file.
+ * @param scene defines the reference to the scene to take a screenshot.
+ * @param size defines the optional size of the screenshot. If not provided, the current canvas size will be used.
+ */
+export declare function saveSceneScreenshot(scene: Scene, size?: ISize): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "babylonjs-editor",
-	"version": "5.4.1-alpha.8",
+	"version": "5.4.1-rc.1",
 	"description": "Babylon.js Editor is a Web Application helping artists to work with Babylon.js",
 	"productName": "Babylon.js Editor",
 	"main": "build/src/index.js",