@needle-tools/engine 4.4.0-beta.3 → 4.4.0-beta.5

package/lib/engine/engine_time.d.ts

@@ -1,51 +1,51 @@
-import { type ITime } from './engine_types.js';
-/**
- * Time is a class that provides time-related information.
- * It is created and used within the Needle Engine Context.
- */
-export declare class Time implements ITime {
-    /** The time in seconds since the start of Needle Engine. */
-    get time(): number;
-    private set time(value);
-    private _time;
-    /** The time in seconds it took to complete the last frame (Read Only). */
-    get deltaTime(): number;
-    private set deltaTime(value);
-    private _deltaTime;
-    /** The time in seconds it took to complete the last frame (Read Only). Timescale is not applied. */
-    get deltaTimeUnscaled(): number;
-    private _deltaTimeUnscaled;
-    /** The scale at which time passes. This can be used for slow motion effects or to speed up time. */
-    timeScale: number;
-    /** same as frameCount */
-    get frame(): number;
-    private set frame(value);
-    private _frame;
-    /** The total number of frames that have passed (Read Only). Same as frame */
-    get frameCount(): number;
-    /** The time in seconds it took to complete the last frame (Read Only). */
-    get realtimeSinceStartup(): number;
-    /**
-     * @returns {Number} FPS for this frame.
-     * Note that this returns the raw value (e.g. 59.88023952362959) and will fluctuate a lot between frames.
-     * If you want a more stable FPS, use `smoothedFps` instead.
-    */
-    get fps(): number;
-    /**
-     * Approximated frames per second
-     * @returns the smoothed FPS value over the last 60 frames with decimals.
-    */
-    get smoothedFps(): number;
-    /** The smoothed time in seconds it took to complete the last frame (Read Only). */
-    get smoothedDeltaTime(): number;
-    private clock;
-    private _smoothedFps;
-    private _smoothedDeltaTime;
-    private readonly _fpsSamples;
-    private _fpsSampleIndex;
-    constructor();
-    /** Step the time. This is called automatically by the Needle Engine Context.
-     * @internal
-     */
-    update(): void;
-}
+import { type ITime } from './engine_types.js';
+/**
+ * Time is a class that provides time-related information.
+ * It is created and used within the Needle Engine Context.
+ */
+export declare class Time implements ITime {
+    /** The time in seconds since the start of Needle Engine. */
+    get time(): number;
+    private set time(value);
+    private _time;
+    /** The time in seconds it took to complete the last frame (Read Only). */
+    get deltaTime(): number;
+    private set deltaTime(value);
+    private _deltaTime;
+    /** The time in seconds it took to complete the last frame (Read Only). Timescale is not applied. */
+    get deltaTimeUnscaled(): number;
+    private _deltaTimeUnscaled;
+    /** The scale at which time passes. This can be used for slow motion effects or to speed up time. */
+    timeScale: number;
+    /** same as frameCount */
+    get frame(): number;
+    private set frame(value);
+    private _frame;
+    /** The total number of frames that have passed (Read Only). Same as frame */
+    get frameCount(): number;
+    /** The time in seconds it took to complete the last frame (Read Only). */
+    get realtimeSinceStartup(): number;
+    /**
+     * @returns {Number} FPS for this frame.
+     * Note that this returns the raw value (e.g. 59.88023952362959) and will fluctuate a lot between frames.
+     * If you want a more stable FPS, use `smoothedFps` instead.
+    */
+    get fps(): number;
+    /**
+     * Approximated frames per second
+     * @returns the smoothed FPS value over the last 60 frames with decimals.
+    */
+    get smoothedFps(): number;
+    /** The smoothed time in seconds it took to complete the last frame (Read Only). */
+    get smoothedDeltaTime(): number;
+    private clock;
+    private _smoothedFps;
+    private _smoothedDeltaTime;
+    private readonly _fpsSamples;
+    private _fpsSampleIndex;
+    constructor();
+    /** Step the time. This is called automatically by the Needle Engine Context.
+     * @internal
+     */
+    update(): void;
+}

package/lib/engine/engine_time.js

@@ -1,83 +1,83 @@
-import { Clock } from 'three';
-import { getParam } from './engine_utils.js';
-const timescaleUrl = getParam("timescale");
-let timeScale = 1;
-if (typeof timescaleUrl === "number")
-    timeScale = timescaleUrl;
-/**
- * Time is a class that provides time-related information.
- * It is created and used within the Needle Engine Context.
- */
-export class Time {
-    /** The time in seconds since the start of Needle Engine. */
-    get time() { return this._time; }
-    set time(value) { this._time = value; }
-    _time = 0;
-    /** The time in seconds it took to complete the last frame (Read Only). */
-    get deltaTime() { return this._deltaTime; }
-    set deltaTime(value) { this._deltaTime = value; }
-    _deltaTime = 0;
-    /** The time in seconds it took to complete the last frame (Read Only). Timescale is not applied. */
-    get deltaTimeUnscaled() { return this._deltaTimeUnscaled; }
-    _deltaTimeUnscaled = 0;
-    /** The scale at which time passes. This can be used for slow motion effects or to speed up time. */
-    timeScale = 1;
-    /** same as frameCount */
-    get frame() { return this._frame; }
-    set frame(value) { this._frame = value; }
-    _frame = 0;
-    /** The total number of frames that have passed (Read Only). Same as frame */
-    get frameCount() { return this.frame; }
-    /** The time in seconds it took to complete the last frame (Read Only). */
-    get realtimeSinceStartup() {
-        return this.clock.elapsedTime;
-    }
-    /**
-     * @returns {Number} FPS for this frame.
-     * Note that this returns the raw value (e.g. 59.88023952362959) and will fluctuate a lot between frames.
-     * If you want a more stable FPS, use `smoothedFps` instead.
-    */
-    get fps() {
-        return 1 / this.deltaTime;
-    }
-    /**
-     * Approximated frames per second
-     * @returns the smoothed FPS value over the last 60 frames with decimals.
-    */
-    get smoothedFps() { return this._smoothedFps; }
-    /** The smoothed time in seconds it took to complete the last frame (Read Only). */
-    get smoothedDeltaTime() { return 1 / this._smoothedFps; }
-    clock = new Clock();
-    _smoothedFps = 0;
-    _smoothedDeltaTime = 0;
-    _fpsSamples = [];
-    _fpsSampleIndex = 0;
-    constructor() {
-        if (typeof timeScale === "number")
-            this.timeScale = timeScale;
-    }
-    /** Step the time. This is called automatically by the Needle Engine Context.
-     * @internal
-     */
-    update() {
-        this.deltaTime = this.clock.getDelta();
-        // clamp delta time because if tab is not active clock.getDelta can get pretty big
-        this.deltaTime = Math.min(.1, this.deltaTime);
-        this._deltaTimeUnscaled = this.deltaTime;
-        if (this.deltaTime <= 0)
-            this.deltaTime = 0.000000000001;
-        this.deltaTime *= this.timeScale;
-        this.frame += 1;
-        this.time += this.deltaTime;
-        if (this._fpsSamples.length < 60)
-            this._fpsSamples.push(this.deltaTime);
-        else
-            this._fpsSamples[(this._fpsSampleIndex++) % 60] = this.deltaTime;
-        let sum = 0;
-        for (let i = 0; i < this._fpsSamples.length; i++)
-            sum += this._fpsSamples[i];
-        this._smoothedDeltaTime = sum / this._fpsSamples.length;
-        this._smoothedFps = 1 / this._smoothedDeltaTime;
-    }
-}
+import { Clock } from 'three';
+import { getParam } from './engine_utils.js';
+const timescaleUrl = getParam("timescale");
+let timeScale = 1;
+if (typeof timescaleUrl === "number")
+    timeScale = timescaleUrl;
+/**
+ * Time is a class that provides time-related information.
+ * It is created and used within the Needle Engine Context.
+ */
+export class Time {
+    /** The time in seconds since the start of Needle Engine. */
+    get time() { return this._time; }
+    set time(value) { this._time = value; }
+    _time = 0;
+    /** The time in seconds it took to complete the last frame (Read Only). */
+    get deltaTime() { return this._deltaTime; }
+    set deltaTime(value) { this._deltaTime = value; }
+    _deltaTime = 0;
+    /** The time in seconds it took to complete the last frame (Read Only). Timescale is not applied. */
+    get deltaTimeUnscaled() { return this._deltaTimeUnscaled; }
+    _deltaTimeUnscaled = 0;
+    /** The scale at which time passes. This can be used for slow motion effects or to speed up time. */
+    timeScale = 1;
+    /** same as frameCount */
+    get frame() { return this._frame; }
+    set frame(value) { this._frame = value; }
+    _frame = 0;
+    /** The total number of frames that have passed (Read Only). Same as frame */
+    get frameCount() { return this.frame; }
+    /** The time in seconds it took to complete the last frame (Read Only). */
+    get realtimeSinceStartup() {
+        return this.clock.elapsedTime;
+    }
+    /**
+     * @returns {Number} FPS for this frame.
+     * Note that this returns the raw value (e.g. 59.88023952362959) and will fluctuate a lot between frames.
+     * If you want a more stable FPS, use `smoothedFps` instead.
+    */
+    get fps() {
+        return 1 / this.deltaTime;
+    }
+    /**
+     * Approximated frames per second
+     * @returns the smoothed FPS value over the last 60 frames with decimals.
+    */
+    get smoothedFps() { return this._smoothedFps; }
+    /** The smoothed time in seconds it took to complete the last frame (Read Only). */
+    get smoothedDeltaTime() { return 1 / this._smoothedFps; }
+    clock = new Clock();
+    _smoothedFps = 0;
+    _smoothedDeltaTime = 0;
+    _fpsSamples = [];
+    _fpsSampleIndex = 0;
+    constructor() {
+        if (typeof timeScale === "number")
+            this.timeScale = timeScale;
+    }
+    /** Step the time. This is called automatically by the Needle Engine Context.
+     * @internal
+     */
+    update() {
+        this.deltaTime = this.clock.getDelta();
+        // clamp delta time because if tab is not active clock.getDelta can get pretty big
+        this.deltaTime = Math.min(.1, this.deltaTime);
+        this._deltaTimeUnscaled = this.deltaTime;
+        if (this.deltaTime <= 0)
+            this.deltaTime = 0.000000000001;
+        this.deltaTime *= this.timeScale;
+        this.frame += 1;
+        this.time += this.deltaTime;
+        if (this._fpsSamples.length < 60)
+            this._fpsSamples.push(this.deltaTime);
+        else
+            this._fpsSamples[(this._fpsSampleIndex++) % 60] = this.deltaTime;
+        let sum = 0;
+        for (let i = 0; i < this._fpsSamples.length; i++)
+            sum += this._fpsSamples[i];
+        this._smoothedDeltaTime = sum / this._fpsSamples.length;
+        this._smoothedFps = 1 / this._smoothedDeltaTime;
+    }
+}
 //# sourceMappingURL=engine_time.js.map

package/lib/engine/engine_time_utils.d.ts

@@ -1,88 +1,88 @@
-/** Gets the date formatted as 20240220-161993. When no Date is passed in, the current local date is used. */
-export declare function getFormattedDate(date?: Date): string;
-declare type ProgressOptions = {
-    message?: string;
-    progress?: number;
-    autoStep?: boolean | number;
-    currentStep?: number;
-    totalSteps?: number;
-};
-declare type ProgressStartOptions = {
-    /** This progress scope will be nested below parentScope */
-    parentScope?: string;
-    /** Callback with progress in 0..1 range. */
-    onProgress?: (progress: number) => void;
-    /** Log timings using console.time() and console.timeLog(). */
-    logTimings?: boolean;
-};
-/** Progress reporting utility.
- * See `Progress.start` for usage examples.
- */
-export declare class Progress {
-    /** Start a new progress reporting scope. Make sure to close it with Progress.end.
-     * @param scope The scope to start progress reporting for.
-     * @param options Parent scope, onProgress callback and logging. If only a string is provided, it's used as parentScope.
-     * @example
-     * // Manual usage:
-     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
-     * Progress.report("export-usdz", { message: "Exporting object 1", currentStep: 1, totalSteps: 3 });
-     * Progress.report("export-usdz", { message: "Exporting object 2", currentStep: 2, totalSteps: 3 });
-     * Progress.report("export-usdz", { message: "Exporting object 3", currentStep: 3, totalSteps: 3 });
-     *
-     * // Auto step usage:
-     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
-     * Progress.report("export-usdz", { message: "Exporting objects", autoStep: true, totalSteps: 3 });
-     * Progress.report("export-usdz", "Exporting object 1");
-     * Progress.report("export-usdz", "Exporting object 2");
-     * Progress.report("export-usdz", "Exporting object 3");
-     * Progress.end("export-usdz");
-     *
-     * // Auto step with weights:
-     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
-     * Progress.report("export-usdz", { message: "Exporting objects", autoStep: true, totalSteps: 10 });
-     * Progress.report("export-usdz", { message: "Exporting object 1", autoStep: 8 }); // will advance to 80% progress
-     * Progress.report("export-usdz", "Exporting object 2"); // 90%
-     * Progress.report("export-usdz", "Exporting object 3"); // 100%
-     *
-     * // Child scopes:
-     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
-     * Progress.report("export-usdz", { message: "Overall export", autoStep: true, totalSteps: 2 });
-     * Progress.start("export-usdz-objects", "export-usdz");
-     * Progress.report("export-usdz-objects", { message: "Exporting objects", autoStep: true, totalSteps: 3 });
-     * Progress.report("export-usdz-objects", "Exporting object 1");
-     * Progress.report("export-usdz-objects", "Exporting object 2");
-     * Progress.report("export-usdz-objects", "Exporting object 3");
-     * Progress.end("export-usdz-objects");
-     * Progress.report("export-usdz", "Exporting materials");
-     * Progress.end("export-usdz");
-     *
-     * // Enable console logging:
-     * Progress.start("export-usdz", { logTimings: true });
-     */
-    static start(scope: string, options?: ProgressStartOptions | string): void;
-    /** Report progress for a formerly started scope.
-     * @param scope The scope to report progress for.
-     * @param options Options for the progress report. If a string is passed, it will be used as the message.
-     * @example
-     * // auto step and show a message
-     * Progress.report("export-usdz", "Exporting object 1");
-     * // same as above
-     * Progress.report("export-usdz", { message: "Exporting object 1", autoStep: true });
-     * // show the current step and total steps and implicitly calculate progress as 10%
-     * Progress.report("export-usdz", { currentStep: 1, totalSteps: 10 });
-     * // enable auto step mode, following calls that have autoStep true will increase currentStep automatically.
-     * Progress.report("export-usdz", { totalSteps: 20, autoStep: true });
-     * // show the progress as 50%
-     * Progress.report("export-usdz", { progress: 0.5 });
-     * // give this step a weight of 20, which changes how progress is calculated. Useful for steps that take longer and/or have child scopes.
-     * Progress.report("export-usdz", { message. "Long process", autoStep: 20 });
-     * // show the current step and total steps and implicitly calculate progress as 10%
-     * Progress.report("export-usdz", { currentStep: 1, totalSteps: 10 });
-     */
-    static report(scope: string, options?: ProgressOptions | string): void;
-    /** End a formerly started scope. This will also report the progress as 100%.
-     * @remarks Will warn if any child scope is still running (progress < 1).
-    */
-    static end(scope: string): void;
-}
-export {};
+/** Gets the date formatted as 20240220-161993. When no Date is passed in, the current local date is used. */
+export declare function getFormattedDate(date?: Date): string;
+declare type ProgressOptions = {
+    message?: string;
+    progress?: number;
+    autoStep?: boolean | number;
+    currentStep?: number;
+    totalSteps?: number;
+};
+declare type ProgressStartOptions = {
+    /** This progress scope will be nested below parentScope */
+    parentScope?: string;
+    /** Callback with progress in 0..1 range. */
+    onProgress?: (progress: number) => void;
+    /** Log timings using console.time() and console.timeLog(). */
+    logTimings?: boolean;
+};
+/** Progress reporting utility.
+ * See `Progress.start` for usage examples.
+ */
+export declare class Progress {
+    /** Start a new progress reporting scope. Make sure to close it with Progress.end.
+     * @param scope The scope to start progress reporting for.
+     * @param options Parent scope, onProgress callback and logging. If only a string is provided, it's used as parentScope.
+     * @example
+     * // Manual usage:
+     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
+     * Progress.report("export-usdz", { message: "Exporting object 1", currentStep: 1, totalSteps: 3 });
+     * Progress.report("export-usdz", { message: "Exporting object 2", currentStep: 2, totalSteps: 3 });
+     * Progress.report("export-usdz", { message: "Exporting object 3", currentStep: 3, totalSteps: 3 });
+     *
+     * // Auto step usage:
+     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
+     * Progress.report("export-usdz", { message: "Exporting objects", autoStep: true, totalSteps: 3 });
+     * Progress.report("export-usdz", "Exporting object 1");
+     * Progress.report("export-usdz", "Exporting object 2");
+     * Progress.report("export-usdz", "Exporting object 3");
+     * Progress.end("export-usdz");
+     *
+     * // Auto step with weights:
+     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
+     * Progress.report("export-usdz", { message: "Exporting objects", autoStep: true, totalSteps: 10 });
+     * Progress.report("export-usdz", { message: "Exporting object 1", autoStep: 8 }); // will advance to 80% progress
+     * Progress.report("export-usdz", "Exporting object 2"); // 90%
+     * Progress.report("export-usdz", "Exporting object 3"); // 100%
+     *
+     * // Child scopes:
+     * Progress.start("export-usdz", undefined, (progress) => console.log("Progress: " + progress));
+     * Progress.report("export-usdz", { message: "Overall export", autoStep: true, totalSteps: 2 });
+     * Progress.start("export-usdz-objects", "export-usdz");
+     * Progress.report("export-usdz-objects", { message: "Exporting objects", autoStep: true, totalSteps: 3 });
+     * Progress.report("export-usdz-objects", "Exporting object 1");
+     * Progress.report("export-usdz-objects", "Exporting object 2");
+     * Progress.report("export-usdz-objects", "Exporting object 3");
+     * Progress.end("export-usdz-objects");
+     * Progress.report("export-usdz", "Exporting materials");
+     * Progress.end("export-usdz");
+     *
+     * // Enable console logging:
+     * Progress.start("export-usdz", { logTimings: true });
+     */
+    static start(scope: string, options?: ProgressStartOptions | string): void;
+    /** Report progress for a formerly started scope.
+     * @param scope The scope to report progress for.
+     * @param options Options for the progress report. If a string is passed, it will be used as the message.
+     * @example
+     * // auto step and show a message
+     * Progress.report("export-usdz", "Exporting object 1");
+     * // same as above
+     * Progress.report("export-usdz", { message: "Exporting object 1", autoStep: true });
+     * // show the current step and total steps and implicitly calculate progress as 10%
+     * Progress.report("export-usdz", { currentStep: 1, totalSteps: 10 });
+     * // enable auto step mode, following calls that have autoStep true will increase currentStep automatically.
+     * Progress.report("export-usdz", { totalSteps: 20, autoStep: true });
+     * // show the progress as 50%
+     * Progress.report("export-usdz", { progress: 0.5 });
+     * // give this step a weight of 20, which changes how progress is calculated. Useful for steps that take longer and/or have child scopes.
+     * Progress.report("export-usdz", { message. "Long process", autoStep: 20 });
+     * // show the current step and total steps and implicitly calculate progress as 10%
+     * Progress.report("export-usdz", { currentStep: 1, totalSteps: 10 });
+     */
+    static report(scope: string, options?: ProgressOptions | string): void;
+    /** End a formerly started scope. This will also report the progress as 100%.
+     * @remarks Will warn if any child scope is still running (progress < 1).
+    */
+    static end(scope: string): void;
+}
+export {};