dazscript-framework 0.1.15 → 0.1.16

package/src/helpers/number-helper.ts

@@ -1,11 +1,11 @@
-export const tryParse = (input: string): { valid: boolean, value: number } => {
-    const parsedValue = Number(input);
-    if (isNaN(parsedValue)) {
-        return { valid: false, value: 0 }
-    }
-    return { valid: true, value: parsedValue }
-}
-
-export const clamp = (value: number, min: number, max: number): number => {
-    return Math.min(Math.max(value, min), max);
+export const tryParse = (input: string): { valid: boolean, value: number } => {
+    const parsedValue = Number(input);
+    if (isNaN(parsedValue)) {
+        return { valid: false, value: 0 }
+    }
+    return { valid: true, value: parsedValue }
+}
+
+export const clamp = (value: number, min: number, max: number): number => {
+    return Math.min(Math.max(value, min), max);
 }

package/src/helpers/numeric-property-helper.ts

@@ -1,92 +1,92 @@
-import { scene } from '@dsf/core/global';
-import { PropertyKey, PropertyKeys } from '@dsf/lib/frame-keys';
-import { isNumeric, toFloat } from './property-helper';
-import { timeToFrame } from './scene-helper';
-
-/**
- * Adjust the value of the property based on the contribution of property controllers.
- * @param property the property to adjust
- * @param value the 'final' value desired for the property
- * @param time the animation time to adjust the property at or current time if not specified
- * @param interpolation the animation interpolation of DzProperty
- * @deprecated use adjust instead
- */
-export const adjustFn = (property: DzFloatProperty | DzIntProperty, value: number, interpolation?: number, time?: DzTime) => {
-    return () => {
-        interpolation = interpolation ?? DzProperty.InterpConstant
-        time = time ?? scene.getTime()
-        property.setValue(time, property.adjustValue(time, value), interpolation)
-    };
-}
-
-/**
- * Adjust the value of the property based on the contribution of property controllers.
- * @param property the property to adjust
- * @param value the 'final' value desired for the property
- * @param time the animation time to adjust the property at or current time if not specified
- * @param interpolation the animation interpolation of DzProperty
- */
-export const adjust = (property: DzFloatProperty | DzIntProperty, value: number, interpolation?: number, time?: DzTime) => {
-    interpolation = interpolation ?? DzProperty.InterpConstant
-    time = time ?? scene.getTime()
-
-    adjustFn(property, value, interpolation, time)()
-}
-
-export const nudge = (property: DzFloatProperty | DzIntProperty, value: number, interpolation?: number, time?: DzTime) => {
-    interpolation = interpolation ?? DzProperty.InterpConstant
-    time = time ?? scene.getTime()
-
-    const sensitivity = property.getSensitivity()
-    adjust(property, property.getValue() + value * sensitivity, interpolation, time)
-    //property.setValue(time, property.getValue() + value * sensitivity, interpolation)
-}
-
-export const clamp = (property: DzFloatProperty | DzIntProperty, interpolation?: number, time?: DzTime) => {
-    interpolation = interpolation ?? DzProperty.InterpConstant
-    time = time ?? scene.getTime()
-
-    property.setIsClamped(true)
-
-    if (property.getRawValue() > property.getMax()) {
-        property.setValue(time, property.getMax(), interpolation)
-    }
-    else if (property.getRawValue() < property.getMin()) {
-        property.setValue(time, property.getMin(), interpolation)
-    }
-
-}
-
-export const setInterpolation = (property: DzProperty, keyIndex: number, interpolationType: number) => {
-    toFloat(property)?.setKeyInterpolation(keyIndex, interpolationType)
-}
-
-/**
- * Gets a collection of numeric property keys
- * @param property the property to get the keys from
- * @returns an array of keys
- */
-export const getKeys = (property: DzNumericProperty): PropertyKeys => {
-    if (!isNumeric(property)) throw Error(`The property "${property.getLabel()}" is not numeric`)
-
-    const keys: PropertyKey[] = []
-
-    for (let i = 0; i < property.getNumKeys(); i++) {
-        const key = new PropertyKey()
-        key.index = i
-        key.time = property.getKeyTime(i)
-        key.value = property.getDoubleValue(key.time)
-        key.frame = timeToFrame(key.time)
-        keys.push(key)
-    }
-
-    const keyCollection = new PropertyKeys(keys);
-
-    // This would make frame the index, but it would not be zero based and
-    // could lead to trouble
-    // keys.forEach((key) => {
-    //     keyCollection[key.frame] = key
-    // })
-
-    return keyCollection
+import { scene } from '@dsf/core/global';
+import { PropertyKey, PropertyKeys } from '@dsf/lib/frame-keys';
+import { isNumeric, toFloat } from './property-helper';
+import { timeToFrame } from './scene-helper';
+
+/**
+ * Adjust the value of the property based on the contribution of property controllers.
+ * @param property the property to adjust
+ * @param value the 'final' value desired for the property
+ * @param time the animation time to adjust the property at or current time if not specified
+ * @param interpolation the animation interpolation of DzProperty
+ * @deprecated use adjust instead
+ */
+export const adjustFn = (property: DzFloatProperty | DzIntProperty | DzBoolProperty, value: number, interpolation?: number, time?: DzTime) => {
+    return () => {
+        interpolation = interpolation ?? DzProperty.InterpConstant
+        time = time ?? scene.getTime()
+        property.setValue(time, property.adjustValue(time, value), interpolation)
+    };
+}
+
+/**
+ * Adjust the value of the property based on the contribution of property controllers.
+ * @param property the property to adjust
+ * @param value the 'final' value desired for the property
+ * @param time the animation time to adjust the property at or current time if not specified
+ * @param interpolation the animation interpolation of DzProperty
+ */
+export const adjust = (property: DzFloatProperty | DzIntProperty | DzBoolProperty, value: number, interpolation?: number, time?: DzTime) => {
+    interpolation = interpolation ?? DzProperty.InterpConstant
+    time = time ?? scene.getTime()
+
+    adjustFn(property, value, interpolation, time)()
+}
+
+export const nudge = (property: DzFloatProperty | DzIntProperty, value: number, interpolation?: number, time?: DzTime) => {
+    interpolation = interpolation ?? DzProperty.InterpConstant
+    time = time ?? scene.getTime()
+
+    const sensitivity = property.getSensitivity()
+    adjust(property, property.getValue() + value * sensitivity, interpolation, time)
+    //property.setValue(time, property.getValue() + value * sensitivity, interpolation)
+}
+
+export const clamp = (property: DzFloatProperty | DzIntProperty, interpolation?: number, time?: DzTime) => {
+    interpolation = interpolation ?? DzProperty.InterpConstant
+    time = time ?? scene.getTime()
+
+    property.setIsClamped(true)
+
+    if (property.getRawValue() > property.getMax()) {
+        property.setValue(time, property.getMax(), interpolation)
+    }
+    else if (property.getRawValue() < property.getMin()) {
+        property.setValue(time, property.getMin(), interpolation)
+    }
+
+}
+
+export const setInterpolation = (property: DzProperty, keyIndex: number, interpolationType: number) => {
+    toFloat(property)?.setKeyInterpolation(keyIndex, interpolationType)
+}
+
+/**
+ * Gets a collection of numeric property keys
+ * @param property the property to get the keys from
+ * @returns an array of keys
+ */
+export const getKeys = (property: DzNumericProperty): PropertyKeys => {
+    if (!isNumeric(property)) throw Error(`The property "${property.getLabel()}" is not numeric`)
+
+    const keys: PropertyKey[] = []
+
+    for (let i = 0; i < property.getNumKeys(); i++) {
+        const key = new PropertyKey()
+        key.index = i
+        key.time = property.getKeyTime(i)
+        key.value = property.getDoubleValue(key.time)
+        key.frame = timeToFrame(key.time)
+        keys.push(key)
+    }
+
+    const keyCollection = new PropertyKeys(keys);
+
+    // This would make frame the index, but it would not be zero based and
+    // could lead to trouble
+    // keys.forEach((key) => {
+    //     keyCollection[key.frame] = key
+    // })
+
+    return keyCollection
 }

package/src/helpers/object-helper.ts

@@ -1,3 +1,3 @@
-export const keys = (o: {}): string[] => {
-    return Object.keys(o)
+export const keys = (o: {}): string[] => {
+    return Object.keys(o)
 }

package/src/helpers/pane-helper.ts

@@ -1,21 +1,29 @@
-import { mainWindow } from '@dsf/core/global'
-
-const findPane = <T extends DzPane>(className: string): T => {
-    return mainWindow.getPaneMgr().findPane(className) as T
-}
-
-export const getSmartContentPane = (): DzSmartContentPane => {
-    return <DzSmartContentPane>findPane("DzSmartContentPane")
-}
-
-export const getSurfacesPane = (): DzSurfacesPane => {
-    return findPane<DzSurfacesPane>("DzSurfacesPane")
-}
-
-export const getAuxViewPort = (): DzAuxViewportPane => {
-    return findPane<DzAuxViewportPane>("DzAuxViewportPane")
-}
-
-export const getParametersPane = (): DzParametersPane => {
-    return findPane<DzParametersPane>("DzParametersPane")
+import { mainWindow } from '@dsf/core/global'
+
+const findPane = <T extends DzPane>(className: string): T => {
+    return mainWindow.getPaneMgr().findPane(className) as T
+}
+
+export const getSmartContentPane = (): DzSmartContentPane => {
+    return <DzSmartContentPane>findPane("DzSmartContentPane")
+}
+
+export const getSurfacesPane = (): DzSurfacesPane => {
+    return findPane<DzSurfacesPane>("DzSurfacesPane")
+}
+
+export const getAuxViewPortPane = (): DzAuxViewportPane => {
+    return findPane<DzAuxViewportPane>("DzAuxViewportPane")
+}
+
+export const getParametersPane = (): DzParametersPane => {
+    return findPane<DzParametersPane>("DzParametersPane")
+}
+
+export const getParametersPaneNodeEditor = (): DzPropertySideNavHierarchy => {
+    return findPane<DzParametersPane>("DzParametersPane")?.getNodeEditor() ?? null
+}
+
+export const getPaneNodeEditor = (pane: DzAbstractNodeEditorPane): DzPropertySideNavHierarchy => {
+    return pane.getNodeEditor ? pane.getNodeEditor() : null
 }

package/src/helpers/progress-helper.ts

@@ -1,34 +1,52 @@
-/**
- * Displays a progress dialog to the user if one is not already being displayed and starts a progress tracking operation.
- * @param info The string to display in the progress dialog as the current description of the operation.
- * @param items The items to process
- * @param callback The function to run for every item
- * @param isCancellable  If true, the user is given the option to cancel the operation.
- * @param showTimeElapsed If true, the amount of time since the progress operation was started will be displayed in the dialog.
- * @param totalSteps The number of progress steps for the operation to be complete.
- */
-export const progress = <T>(info: string, items: T[], callback: (item: T) => boolean | void, isCancellable: boolean = true, showTimeElapsed: boolean = true, totalSteps?: number) => {
-    totalSteps = totalSteps ?? items.length;
-
-    startProgress(info, totalSteps, isCancellable, showTimeElapsed);
-
-    for (let item of items) {
-        if (isCancellable) {
-            if (progressIsCancelled()) {
-                break;
-            } else {
-                // This is too slow
-                //if(progress) processEvents();
-            }
-        }
-
-        //============
-        if (callback && callback(item) === false)
-            return
-        //============
-
-        stepProgress(1);
-    }
-
-    finishProgress();
+import { status } from '@dsf/common/log';
+
+/**
+ * Displays a progress dialog to the user if one is not already being displayed and starts a progress tracking operation.
+ * @param info The string to display in the progress dialog as the current description of the operation.
+ * @param items The items to process
+ * @param callback The function to run for every item
+ * @param isCancellable  If true, the user is given the option to cancel the operation.
+ * @param showTimeElapsed If true, the amount of time since the progress operation was started will be displayed in the dialog.
+ * @param totalSteps The number of progress steps for the operation to be complete.
+ */
+export const progress = <T>(info: string | string[], items: T[], callback: (item: T) => boolean | void,
+    options?: { isCancellable?: boolean, showTimeElapsed?: boolean, totalSteps?: number }) => {
+
+    options = {
+        isCancellable: true,
+        showTimeElapsed: true,
+        totalSteps: items.length,
+        ...options
+    };
+
+    const infoMessage = Array.isArray(info) ? '' : info;
+    startProgress(infoMessage, options.totalSteps, options.isCancellable, options.showTimeElapsed);
+
+    if (Array.isArray(info)) info.forEach(line => status(line));
+
+    // const total = Math.max(1, options.totalSteps ?? items.length);
+    // let lastQuarter = -1; // -1 so first boundary triggers
+
+    for (let i = 0; i < items.length; i++) {
+        // cancellation
+        if (options.isCancellable && progressIsCancelled()) {
+            processEvents(); // flush once on cancel
+            break;
+        }
+
+        // work
+        if (callback && callback(items[i]) === false) return;
+
+        // progress
+        stepProgress(1);
+
+        // 25/50/75/100 checkpoints
+        // const quarter = Math.floor(((i + 1) * 2) / total); // 0..4
+        // if (quarter > lastQuarter) {
+        //     processEvents();
+        //     lastQuarter = quarter;
+        // }
+    }
+
+    finishProgress();
 }

package/src/helpers/property-helper.ts

@@ -1,53 +1,62 @@
-import { sceneHelper } from '@dsf/core/global'
-
-/**
- * Sets the DzPropertyGroup path (and appropriate geometryregion_dz) for the given property.
- * @param property  The property to change the path of.
- * @param path The new path for the given property.
- */
-export const setPath = (property: DzProperty, path: string) => {
-    sceneHelper.setPropertyPath(property, path)
-}
-
-/**
- * Get the internal name of property (or its alias target), or “Unknown”.
- * @param property
- * @returns The internal name of property (or its alias target), or “Unknown”.
- */
-export const getName = (property: DzProperty): string => {
-    return sceneHelper.getInternalName(property).valueOf()
-}
-
-/**
- * Unlocks a property temporarily and executes the specified callback while it's unlocked
- * @param property the property to unlock
- * @param then the callback to exectue while the property is unlocked
- */
-export const unlock = (property: DzProperty, then: (property: DzProperty) => void) => {
-    let locked = property.isLocked()
-    if (locked) property.lock(true)
-    then(property)
-    if (locked) property.lock(false)
-}
-
-export const isNumeric = (property: DzProperty): boolean => {
-    return property.inherits('DzNumericProperty')
-}
-
-export const cast = <T extends DzProperty>(property: DzProperty, type: 'DzNumericProperty' | 'DzFloatProperty' | 'DzIntProperty'): T | null => {
-    return property.inherits(type)
-        ? property as T
-        : null
-}
-
-export const toNumeric = (property: DzProperty): DzFloatProperty | DzIntProperty | null => {
-    return toFloat(property) ?? toInt(property)
-}
-
-export const toFloat = (property: DzProperty): DzFloatProperty | null => {
-    return cast<DzFloatProperty>(property, 'DzFloatProperty')
-}
-
-export const toInt = (property: DzProperty): DzIntProperty | null => {
-    return cast<DzIntProperty>(property, 'DzIntProperty')
+import { sceneHelper } from '@dsf/core/global'
+
+/**
+ * Sets the DzPropertyGroup path (and appropriate geometryregion_dz) for the given property.
+ * @param property  The property to change the path of.
+ * @param path The new path for the given property.
+ */
+export const setPath = (property: DzProperty, path: string) => {
+    sceneHelper.setPropertyPath(property, path)
+}
+
+/**
+ * Get the internal name of property (or its alias target), or “Unknown”.
+ * @param property
+ * @returns The internal name of property (or its alias target), or “Unknown”.
+ */
+export const getName = (property: DzProperty): string => {
+    return sceneHelper.getInternalName(property).valueOf()
+}
+
+export const ensureNameIsUnique = (property: DzProperty): string => {
+    const name = getName(property)
+    const uniqueName = sceneHelper.getUniqueMorphName(sceneHelper.getNode(property), name)
+    if (name !== uniqueName) {
+        sceneHelper.setInternalName(property, uniqueName.valueOf())
+    }
+    return uniqueName.valueOf()
+}
+
+/**
+ * Unlocks a property temporarily and executes the specified callback while it's unlocked
+ * @param property the property to unlock
+ * @param then the callback to exectue while the property is unlocked
+ */
+export const unlock = (property: DzProperty, then: (property: DzProperty) => void) => {
+    let locked = property.isLocked()
+    if (locked) property.lock(true)
+    then(property)
+    if (locked) property.lock(false)
+}
+
+export const isNumeric = (property: DzProperty): boolean => {
+    return property.inherits('DzNumericProperty')
+}
+
+export const cast = <T extends DzProperty>(property: DzProperty, type: 'DzNumericProperty' | 'DzFloatProperty' | 'DzIntProperty'): T | null => {
+    return property.inherits(type)
+        ? property as T
+        : null
+}
+
+export const toNumeric = (property: DzProperty): DzFloatProperty | DzIntProperty | null => {
+    return toFloat(property) ?? toInt(property)
+}
+
+export const toFloat = (property: DzProperty): DzFloatProperty | null => {
+    return cast<DzFloatProperty>(property, 'DzFloatProperty')
+}
+
+export const toInt = (property: DzProperty): DzIntProperty | null => {
+    return cast<DzIntProperty>(property, 'DzIntProperty')
 }

package/src/helpers/record-helper.ts

@@ -1,16 +1,16 @@
-function objectEntries(obj: any) {
-    const ownProps = Object.keys(obj);
-    let i = ownProps.length;
-    const result = new Array(i); // preallocate the Array
-    while (i--) {
-        result[i] = [ownProps[i], obj[ownProps[i]]];
-    }
-    return result;
-};
-
-export function entries<K extends string, T>(
-    record: Record<K, T[]>
-): Array<[K, T[]]> {
-    return (objectEntries(record) as Array<[K, T[]]>);
-}
-
+function objectEntries(obj: any) {
+    const ownProps = Object.keys(obj);
+    let i = ownProps.length;
+    const result = new Array(i); // preallocate the Array
+    while (i--) {
+        result[i] = [ownProps[i], obj[ownProps[i]]];
+    }
+    return result;
+};
+
+export function entries<K extends string, T>(
+    record: Record<K, T[]>
+): Array<[K, T[]]> {
+    return (objectEntries(record) as Array<[K, T[]]>);
+}
+