babylonjs-editor-tools 0.0.3 → 0.0.4

package/build/loader.js

@@ -6,7 +6,9 @@ const ssr_1 = require("./rendering/ssr");
 const ssao_1 = require("./rendering/ssao");
 const motion_blur_1 = require("./rendering/motion-blur");
 const default_pipeline_1 = require("./rendering/default-pipeline");
-async function loadScene(rootUrl, sceneFilename, scene, scriptsMap) {
+require("./texture");
+async function loadScene(rootUrl, sceneFilename, scene, scriptsMap, quality = "hight") {
+    scene.loadingQuality = quality;
     await sceneLoader_1.SceneLoader.AppendAsync(rootUrl, sceneFilename, scene);
     if (scene.metadata?.rendering) {
         const camera = scene.activeCamera ?? scene.cameras[0];
@@ -51,6 +53,14 @@ function loadScriptsFor(scene, object, scriptsMap) {
                 scene.onBeforeRenderObservable.add(() => instance.onUpdate());
             }
         }
+        else {
+            if (exports.onStart) {
+                scene.onBeforeRenderObservable.addOnce(() => exports.onStart(object));
+            }
+            if (exports.onUpdate) {
+                scene.onBeforeRenderObservable.add(() => exports.onUpdate(object));
+            }
+        }
     });
     object.metadata.scripts = undefined;
 }

package/build/texture.js

@@ -1,81 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startTextureOptimizer = void 0;
-const guards_1 = require("./guards");
-const sceneMap = new Map();
-function startTextureOptimizer(scene) {
-    const engine = scene.getEngine();
-    const existingRenderLoop = sceneMap.get(scene);
-    if (existingRenderLoop) {
-        engine.stopRenderLoop(existingRenderLoop);
+const decorators_serialization_1 = require("@babylonjs/core/Misc/decorators.serialization");
+const scalar_1 = require("./tools/scalar");
+/**
+ * Defines the reference to the original texture parser function.
+ */
+const textureParser = decorators_serialization_1.SerializationHelper._TextureParser;
+decorators_serialization_1.SerializationHelper._TextureParser = (sourceProperty, scene, rootUrl) => {
+    if (scene.loadingQuality === "hight" || !sourceProperty.metadata?.baseSize) {
+        return textureParser(sourceProperty, scene, rootUrl);
     }
-    let time = 0;
-    const renderLoop = () => {
-        const camera = scene.activeCamera;
-        time += engine.getDeltaTime();
-        if (!camera || time < 1000) {
-            return;
-        }
-        scene.meshes.forEach((mesh) => {
-            if (!(0, guards_1.isMesh)(mesh) || !mesh.material) {
-                return;
-            }
-            handleMesh(camera, mesh);
-        });
-        time = 0;
-    };
-    sceneMap.set(scene, renderLoop);
-    engine.runRenderLoop(renderLoop);
-}
-exports.startTextureOptimizer = startTextureOptimizer;
-function handleMesh(camera, mesh) {
-    const material = mesh.material;
-    const textures = material.getActiveTextures();
-    if (!textures.length) {
-        return;
+    const width = sourceProperty.metadata.baseSize.width;
+    const height = sourceProperty.metadata.baseSize.height;
+    let suffix = "";
+    switch (scene.loadingQuality) {
+        case "medium":
+            const midWidth = (0, scalar_1.getPowerOfTwoUntil)(width * 0.66);
+            const midHeight = (0, scalar_1.getPowerOfTwoUntil)(height * 0.66);
+            suffix = `_${midWidth}_${midHeight}`;
+            break;
+        case "low":
+            const lowWidth = (0, scalar_1.getPowerOfTwoUntil)(width * 0.33);
+            const lowHeight = (0, scalar_1.getPowerOfTwoUntil)(height * 0.33);
+            suffix = `_${lowWidth}_${lowHeight}`;
+            break;
     }
-    let isInFrustrum = false;
-    if (mesh.instances.length) {
-        isInFrustrum = [mesh, ...mesh.instances].find((instance) => camera.isInFrustum(instance)) ? true : false;
+    const name = sourceProperty.name;
+    if (!name || !suffix) {
+        return textureParser(sourceProperty, scene, rootUrl);
     }
-    else {
-        isInFrustrum = camera.isInFrustum(mesh);
+    const finalUrl = name.split("/");
+    const filename = finalUrl.pop();
+    if (!filename) {
+        return textureParser(sourceProperty, scene, rootUrl);
     }
-    textures.forEach((texture) => {
-        if (!(0, guards_1.isTexture)(texture) || !texture.getInternalTexture() || !texture.isReady()) {
-            return;
-        }
-        texture.metadata ??= {};
-        texture.metadata.editor ??= {
-            ratio: 1,
-            url: texture.getInternalTexture()?.url,
-        };
-        const url = texture.metadata.editor.url;
-        if (!url) {
-            return;
-        }
-        let ratio = texture.metadata.editor.ratio;
-        if (isInFrustrum && ratio === 1) {
-            return;
-        }
-        let split = url.split("/");
-        const dirname = split.slice(0, -1).join("/");
-        const basename = split[split.length - 1];
-        split = basename.split(".");
-        ratio *= (isInFrustrum ? 2 : 0.5);
-        const width = texture.getBaseSize().width * ratio;
-        const height = texture.getBaseSize().height * ratio;
-        if (!isInFrustrum && (width <= 8 || height <= 8)) {
-            return;
-        }
-        if (ratio === 1 && texture.getInternalTexture().url !== url) {
-            texture.updateURL(url);
-        }
-        else if (ratio < 1) {
-            const newUrl = `${dirname}/${split[0]}_${width}_${height}.${split[1]}`;
-            texture.updateURL(newUrl);
-        }
-        texture.metadata.editor.ratio = ratio;
-    });
-}
+    const extension = filename.split(".").pop();
+    const baseFilename = filename.replace(`.${extension}`, "");
+    const newFilename = `${baseFilename}${suffix}.${extension}`;
+    finalUrl.push(newFilename);
+    sourceProperty.name = finalUrl.join("/");
+    return textureParser(sourceProperty, scene, rootUrl);
+};
 //# sourceMappingURL=texture.js.map

package/build/tools/math.js

@@ -0,0 +1 @@
+//# sourceMappingURL=math.js.map

package/build/tools/scalar.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPowerOfTwoUntil = void 0;
+function getPowerOfTwoUntil(limit) {
+    let size = 1;
+    while (size <= limit) {
+        size <<= 1;
+    }
+    return size >> 1;
+}
+exports.getPowerOfTwoUntil = getPowerOfTwoUntil;
+//# sourceMappingURL=scalar.js.map

package/declaration/loader.d.ts

@@ -1,9 +1,31 @@
 import { Scene } from "@babylonjs/core/scene";
+import "./texture";
+/**
+ * Defines the possible output type of a script.
+ * `default` is a class that will be instantiated with the object as parameter.
+ * `onStart` is a function that will be called once before the first render passing the reference to the object the script is attached to.
+ * `onUpdate` is a function that will be called every frame passing the reference to the object the script is attached to
+ */
 export type ScriptMap = Record<string, {
     default?: new (object: any) => {
         onStart?(): void;
         onUpdate?(): void;
     };
+    onStart?: (object: any) => void;
+    onUpdate?: (object: any) => void;
 }>;
-export declare function loadScene(rootUrl: string, sceneFilename: string, scene: Scene, scriptsMap: ScriptMap): Promise<void>;
+/**
+ * Defines the overall desired quality of the scene.
+ * In other words, defines the quality of textures that will be loaded in terms of dimensions.
+ * The editor computes automatic "hight (untouched)", "medium (half)", and "low (quarter)" quality levels for textures.
+ * Using "medium" or "low" quality levels will reduce the memory usage and improve the performance of the scene
+ * especially on mobiles where memory is limited.
+ */
+export type SceneLoaderQualitySelector = "low" | "medium" | "hight";
+declare module "@babylonjs/core/scene" {
+    interface Scene {
+        loadingQuality: SceneLoaderQualitySelector;
+    }
+}
+export declare function loadScene(rootUrl: string, sceneFilename: string, scene: Scene, scriptsMap: ScriptMap, quality?: SceneLoaderQualitySelector): Promise<void>;
 export declare function loadScriptsFor(scene: Scene, object: any, scriptsMap: ScriptMap): void;

package/declaration/texture.d.ts

@@ -1,2 +1 @@
-import { Scene } from "@babylonjs/core/scene";
-export declare function startTextureOptimizer(scene: Scene): void;
+export {};

package/declaration/tools/scalar.d.ts

@@ -0,0 +1 @@
+export declare function getPowerOfTwoUntil(limit: number): number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-editor-tools",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "description": "Babylon.js Editor Tools is a set of tools to help you create, edit and manage your Babylon.js scenes made using the Babylon.JS Editor",
     "productName": "Babylon.js Editor Tools",
     "scripts": {