dazscript-framework 0.1.14 → 0.1.16

package/src/helpers/scene-helper.ts

@@ -1,96 +1,145 @@
-import { scene } from '@dsf/core/global'
-import { contains, distinct } from './array-helper'
-import { getRoot } from './node-helper'
-import { getParametersPane } from './pane-helper'
-
-export const getSelectedOf = <T>(typeName: string): DzNode[] => {
-    let nodes = []
-    for (let node of scene.getSelectedNodeList()) {
-        if (!node.inherits(typeName)) continue
-        nodes.push(node)
-    }
-    return nodes
-}
-
-export const getSelectedNode = (): DzNode | null => {
-    if (scene.getNumSelectedNodes() === 0) return null
-    return scene.getPrimarySelection()
-}
-
-export const getTopParent = (node: DzNode): DzNode => {
-    var parent = node.getNodeParent();
-    return parent ? getTopParent(parent) : node;
-}
-
-export const getNodes = (): DzNode[] => {
-    return scene.getNodeList()
-}
-
-export const getFigures = (): DzSkeleton[] => {
-    return distinct(getNodes().map(n => n.getSkeleton?.()), (n => n?.getLabel().valueOf())).filter(n => n !== null)
-}
-
-/**
- * Get the selected figure
- * @returns the figure skeleton, or null if there is no current selection or the selected node is not part of a figure
- */
-export const getSelectedFigure = (): DzSkeleton | null => {
-    return getSelectedNode()?.getSkeleton?.()
-}
-
-/**
- * Given the selected nodes in the scene, return the figures they are part of
- * @returns the selected figures
- */
-export const getSelectedFigures = (callback: (figure: DzSkeleton) => void | boolean = () => true): DzSkeleton[] => {
-    let nodes: DzSkeleton[] = []
-    for (let node of scene.getSelectedNodeList()) {
-        let skeleton = node.getSkeleton?.()
-        if (!skeleton || contains(nodes, node)) continue
-        nodes.push(skeleton)
-        if (!!callback?.(skeleton)) break
-    }
-    return nodes
-}
-
-export const getSelectedNodes = (): DzNode[] => {
-    return scene.getSelectedNodeList()
-}
-
-export const getSelectedRoot = (): DzNode => {
-    return getRoot(getSelectedNode())
-}
-
-export const getSelectedRoots = (): DzNode[] => {
-    return distinct(getSelectedNodes().map(n => getRoot(n)))
-}
-
-export const getSelectedProperties = (): DzProperty[] => {
-    return getParametersPane()?.getNodeEditor()?.getPropertySelections(true) ?? []
-}
-
-export const getSelectedPropertiesOfType = <TProperty extends DzProperty>(type: string): TProperty[] => {
-    return getSelectedProperties().filter(p => p.inherits(type)) as TProperty[]
-}
-
-export const clearSelection = () => {
-    for (let node of scene.getSelectedNodeList()) {
-        node.select(false)
-    }
-}
-
-export const currentTime = (): DzTime => {
-    return scene.getTime()
-}
-
-export const getCurrentFrame = (): number => {
-    return scene.getTime().valueOf() / scene.getTimeStep().valueOf()
-}
-
-export const getLastFrame = (): number => {
-    return scene.getAnimRange().end / scene.getTimeStep().valueOf()
-}
-
-export const timeToFrame = (time: DzTime): number => {
-    return time.valueOf() / scene.getTimeStep().valueOf()
+import { scene } from '@dsf/core/global'
+import { contains, distinct, group } from './array-helper'
+import { getRoot, isFigure } from './node-helper'
+import { getPaneNodeEditor, getParametersPane, getParametersPaneNodeEditor } from './pane-helper'
+
+export const getSelectedOf = <T>(typeName: string): DzNode[] => {
+    let nodes = []
+    for (let node of scene.getSelectedNodeList()) {
+        if (!node.inherits(typeName)) continue
+        nodes.push(node)
+    }
+    return nodes
+}
+
+export const getSelectedNode = (): DzNode | null => {
+    if (scene.getNumSelectedNodes() === 0) return null
+    return scene.getPrimarySelection()
+}
+
+export const getTopParent = (node: DzNode): DzNode => {
+    var parent = node.getNodeParent();
+    return parent ? getTopParent(parent) : node;
+}
+
+export const getParentFigure = (node: DzNode): DzSkeleton | null => {
+    if (!node) return null;
+    if (isFigure(node)) return node as DzSkeleton;
+    return getParentFigure(node.getNodeParent());
+}
+
+export const getNodes = (): DzNode[] => {
+    return scene.getNodeList()
+}
+
+export const getRootNodes = (): DzNode[] => {
+    return getNodes().map(n => getRoot(n)).filter(n => n !== null)
+}
+
+export const getFigures = (): DzSkeleton[] => {
+    return distinct(getNodes().map(n => n.getSkeleton?.()), (n => n?.getLabel().valueOf())).filter(n => n !== null)
+}
+
+/**
+ * Get the selected figure
+ * @returns the figure skeleton, or null if there is no current selection or the selected node is not part of a figure
+ */
+export const getSelectedFigure = (): DzSkeleton | null => {
+    return getSelectedNode()?.getSkeleton?.()
+}
+
+/**
+ * Given the selected nodes in the scene, return the figures they are part of
+ * @returns the selected figures
+ */
+export const getSelectedFigures = (): DzSkeleton[] => {
+    let nodes: DzSkeleton[] = []
+    for (let node of scene.getSelectedNodeList()) {
+        let skeleton = node.getSkeleton?.()
+        if (!skeleton || contains(nodes, node)) continue
+        nodes.push(skeleton)
+    }
+    return nodes
+}
+
+export const getSelectedNodes = (): DzNode[] => {
+    return scene.getSelectedNodeList()
+}
+
+export const getSelectedRoot = (): DzNode => {
+    return getRoot(getSelectedNode())
+}
+
+export const getSelectedRoots = (): DzNode[] => {
+    return distinct(getSelectedNodes().map(n => getRoot(n)))
+}
+
+export const getSelectedProperties = (): DzProperty[] => {
+    return getParametersPane()?.getNodeEditor()?.getPropertySelections(true) ?? []
+}
+
+export const getSelectedNumericProperties = (): (DzFloatProperty | DzIntProperty | DzBoolProperty)[] => {
+    return getParametersPane()?.getNodeEditor()?.getPropertySelections(true).map(p => p as DzFloatProperty | DzIntProperty | DzBoolProperty) ?? []
+}
+
+export const getSelectedPropertiesOfType = <TProperty extends DzProperty>(type: string): TProperty[] => {
+    return getSelectedProperties().filter(p => p.inherits(type)) as TProperty[]
+}
+
+export const getSelectedPropertiesOfTypes = <TProperty extends DzProperty>(types: string[]): TProperty[] => {
+    return getSelectedProperties().filter(p => types.some(type => p.inherits(type))) as TProperty[]
+}
+
+export const getSelectedPropertyGroups = (pane?: DzAbstractNodeEditorPane): string[] => {
+    var propertyGroups: string[] = [];
+    var paneNodeEditor = pane ? getPaneNodeEditor(pane) : getParametersPaneNodeEditor();
+
+    var selectedProperties = paneNodeEditor?.getPropertySelections(true)
+    if (selectedProperties.length == 0)
+        selectedProperties = paneNodeEditor?.getPropertySelections(false)
+
+    if (selectedProperties.length == 0)
+        return propertyGroups
+
+    var pathsGroup = group<DzProperty, string>(selectedProperties, p => p.getPath().valueOf().substr(1) + "/")
+    propertyGroups = Object.keys(pathsGroup)
+
+    return propertyGroups
+}
+
+export const clearSelection = () => {
+    for (let node of scene.getSelectedNodeList()) {
+        node.select(false)
+    }
+}
+
+export const currentTime = (): DzTime => {
+    return scene.getTime()
+}
+
+/**
+ * @returns the current frame number (0-based)
+ */
+export const getCurrentFrame = (): number => {
+    return scene.getTime().valueOf() / scene.getTimeStep().valueOf()
+}
+
+export const getEndFrame = (): number => {
+    return scene.getAnimRange().end / scene.getTimeStep().valueOf()
+}
+
+/**
+ * @deprecated Use getEndFrame
+ * @returns the last frame number (0-based)
+ */
+export const getLastFrame = (): number => {
+    return scene.getAnimRange().end / scene.getTimeStep().valueOf()
+}
+
+export const timeToFrame = (time: DzTime): number => {
+    return time.valueOf() / scene.getTimeStep().valueOf()
+}
+
+export const frameToTime = (frame: number): DzTime => {
+    return new DzTime(scene.getTimeStep().valueOf() * frame)
 }

package/src/helpers/script-helper.ts

@@ -1,16 +1,16 @@
-export const getScriptPath = (): string => {
-    var fileName = getScriptFileName();
-    var fileInfo = new DzFileInfo(fileName);
-
-    let path: string;
-
-    if (typeof (fileInfo.canonicalPath) == "function") {
-        path = fileInfo.canonicalPath();
-    } else {
-        path = fileInfo.path();
-    }
-
-    fileInfo.deleteLater();
-
-    return path;
+export const getScriptPath = (): string => {
+    var fileName = getScriptFileName();
+    var fileInfo = new DzFileInfo(fileName);
+
+    let path: string;
+
+    if (typeof (fileInfo.canonicalPath) == "function") {
+        path = fileInfo.canonicalPath();
+    } else {
+        path = fileInfo.path();
+    }
+
+    fileInfo.deleteLater();
+
+    return path;
 }

package/src/helpers/skeleton-helper.ts

@@ -1,27 +1,27 @@
-
-export const getModifiers = (figure: DzSkeleton): DzModifier[] => {
-    let modifiers: DzModifier[] = []
-    let obj = figure.getObject()
-
-    for (let i = 0; i < obj.getNumModifiers(); i++) {
-        modifiers.push(obj.getModifier(i))
-    }
-
-    return modifiers
-}
-
-export const getMirrorNodes = (figure: DzSkeleton, nodes: DzNode[]): DzNode[] => {
-    let mirrorNodes: DzNode[] = []
-
-    nodes.forEach((node) => {
-        const name = node.getName().valueOf()
-        let prefix = name[0]
-        if (prefix !== 'r' && prefix !== 'l') return
-        prefix = prefix === 'r' ? 'l' : 'r'
-        const mirrorName = `${prefix}${name.substring(1)}`
-        const mirrorNode = figure.findNodeChild(mirrorName, true)
-        if (mirrorNode) mirrorNodes.push(mirrorNode)
-    })
-
-    return mirrorNodes
+
+export const getModifiers = (figure: DzSkeleton): DzModifier[] => {
+    let modifiers: DzModifier[] = []
+    let obj = figure.getObject()
+
+    for (let i = 0; i < obj.getNumModifiers(); i++) {
+        modifiers.push(obj.getModifier(i))
+    }
+
+    return modifiers
+}
+
+export const getMirrorNodes = (figure: DzSkeleton, nodes: DzNode[]): DzNode[] => {
+    let mirrorNodes: DzNode[] = []
+
+    nodes.forEach((node) => {
+        const name = node.getName().valueOf()
+        let prefix = name[0]
+        if (prefix !== 'r' && prefix !== 'l') return
+        prefix = prefix === 'r' ? 'l' : 'r'
+        const mirrorName = `${prefix}${name.substring(1)}`
+        const mirrorNode = figure.findNodeChild(mirrorName, true)
+        if (mirrorNode) mirrorNodes.push(mirrorNode)
+    })
+
+    return mirrorNodes
 }

package/src/helpers/splitter-helper.ts

@@ -1,9 +1,9 @@
-export const restoreState = (splitter: DzSplitter, state: string) => {
-    if (!state) return
-    let base64Array = new ByteArray(state)
-    splitter.restoreState(base64Array.fromBase64(base64Array))
-}
-
-export const getState = (splitter: DzSplitter): string => {
-    return splitter.saveState().toBase64().convertToString()
+export const restoreState = (splitter: DzSplitter, state: string) => {
+    if (!state) return
+    let base64Array = new ByteArray(state)
+    splitter.restoreState(base64Array.fromBase64(base64Array))
+}
+
+export const getState = (splitter: DzSplitter): string => {
+    return splitter.saveState().toBase64().convertToString()
 }

package/src/helpers/string-helper.ts

@@ -1,32 +1,40 @@
-export const isNumeric = (value: string | number): boolean => {
-    return ((value != null) &&
-        (value !== '') &&
-        !isNaN(Number(value.toString())))
-}
-
-export const contains = (source: string, search: string | string[]): boolean => {
-    if (Array.isArray(search)) {
-        for (const s of search) {
-            if (source.indexOf(s) >= 0) return true
-        }
-        return false
-    }
-    return source.indexOf(search) >= 0
-}
-
-export const remove = (source: string, search: string): string => {
-    return source.replace(search, "")
-}
-
-export const trimEnd = (source: string, search: string): string => {
-    return source.endsWith(search) ? source.slice(0, -search.length) : source
-}
-
-export const count = (source: string, search: string): number => {
-    return source.split(search).length - 1
-}
-
-export const isGUID = (str: string): boolean => {
-    const GUIDPattern = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
-    return GUIDPattern.test(str);
+export const isNumeric = (value: string | number): boolean => {
+    return ((value != null) &&
+        (value !== '') &&
+        !isNaN(Number(value.toString())))
+}
+
+export const contains = (source: string, search: string | string[]): boolean => {
+    if (Array.isArray(search)) {
+        for (const s of search) {
+            if (source.indexOf(s) >= 0) return true
+        }
+        return false
+    }
+    return source.indexOf(search) >= 0
+}
+
+export const remove = (source: string, search: string): string => {
+    return source.replace(search, "")
+}
+
+export const trimEnd = (source: string, search: string): string => {
+    return source.endsWith(search) ? source.slice(0, -search.length) : source
+}
+
+export const count = (source: string, search: string): number => {
+    return source.split(search).length - 1
+}
+
+export const isGUID = (str: string): boolean => {
+    const GUIDPattern = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
+    return GUIDPattern.test(str);
+}
+
+export const getFileNameWithoutExtension = (filePath: string | null | undefined): string | null => {
+    if (!filePath) return null
+    const lastSlash = Math.max(filePath.lastIndexOf('/'), filePath.lastIndexOf('\\'))
+    const fileWithExt = filePath.substring(lastSlash + 1)
+    const lastDot = fileWithExt.lastIndexOf('.')
+    return lastDot > 0 ? fileWithExt.substring(0, lastDot) : fileWithExt
 }

package/src/helpers/surface-helper.ts

@@ -1,6 +1,6 @@
-import { getSurfacesPane } from './pane-helper'
-
-export const getSelectedSurfacePropertiesOfType = <TProperty extends DzProperty>(className: string): TProperty[] => {
-    return getSurfacesPane().getNodeEditor().getPropertySelections(true)
-        .filter(p => p.inherits(className)) as TProperty[]
+import { getSurfacesPane } from './pane-helper'
+
+export const getSelectedSurfacePropertiesOfType = <TProperty extends DzProperty>(className: string): TProperty[] => {
+    return getSurfacesPane().getNodeEditor().getPropertySelections(true)
+        .filter(p => p.inherits(className)) as TProperty[]
 }

package/src/helpers/undo-helper.ts

@@ -1,7 +1,8 @@
-const acceptUndoFor = (caption: string, callback: () => void) => {
-    beginUndo()
-    callback?.()
-    acceptUndo(caption)
-}
-
-export { acceptUndoFor as acceptUndo }
+const acceptUndoFor = (caption: string, callback: () => void) => {
+    beginUndo()
+    callback?.()
+    acceptUndo(caption)
+}
+
+export { acceptUndoFor as acceptUndo }
+

package/src/helpers/viewport-helper.ts

@@ -1,9 +1,22 @@
-import { mainWindow } from '@dsf/core/global'
-
-export const selectUniversalRotateTool = (coordinateSpace?: number): DzUniversalRotateTool => {
-    const viewportMgr = mainWindow.getViewportMgr()
-    const tool = viewportMgr.findTool('DzUniversalRotateTool') as DzUniversalRotateTool
-    viewportMgr.setActiveTool(tool)
-    if (coordinateSpace) tool.setCoordinateSpace(coordinateSpace)
-    return tool
+import { mainWindow } from '@dsf/core/global'
+
+export const selectUniversalRotateTool = (coordinateSpace?: number): DzUniversalRotateTool => {
+    const viewportMgr = mainWindow.getViewportMgr()
+    const tool = viewportMgr.findTool('DzUniversalRotateTool') as DzUniversalRotateTool
+    viewportMgr.setActiveTool(tool)
+    if (coordinateSpace) tool.setCoordinateSpace(coordinateSpace)
+    return tool
+}
+
+export const getActiveViewport = (): DzViewport => {
+    return mainWindow.getViewportMgr().getActiveViewport()
+}
+
+export const getAuxViewport = (): DzViewport | null => {
+    const viewportMgr = mainWindow.getViewportMgr()
+    for (let i = 0; i < viewportMgr.getNumViewports(); i++) {
+        const viewport = viewportMgr.getViewport(i)
+        if (viewport.name === 'AuxViewportView') return viewport
+    }
+    return null
 }

package/src/lib/delayed.ts

@@ -1,39 +1,39 @@
-export class Delayed {
-    private minDelay: number;
-    private maxDelay: number;
-    private timeout: any;
-    private action: () => void;
-
-    /**
-     * Perform an action delayed
-     * @param action action to delay
-     * @param minDelay min delay in milliseconds
-     * @param maxDelay max delay in milliseconds
-     */
-    constructor(action: () => void, minDelay = 100, maxDelay = 500) {
-        this.action = action;
-        this.minDelay = minDelay;
-        this.maxDelay = maxDelay;
-    }
-
-    public trigger() {
-        if (this.timeout === undefined) {
-            this.timeout = new DzTimer();
-            this.timeout.timeout.connect(() => {
-                this.action();
-                this.reset();
-            });
-            this.timeout.start(this.maxDelay);
-        } else {
-            this.timeout.stop();
-            this.timeout.start(this.minDelay);
-        }
-    }
-
-    private reset() {
-        if (this.timeout !== undefined) {
-            this.timeout.stop();
-            this.timeout = undefined;
-        }
-    }
+export class Delayed {
+    private minDelay: number;
+    private maxDelay: number;
+    private timeout: any;
+    private action: () => void;
+
+    /**
+     * Perform an action delayed
+     * @param action action to delay
+     * @param minDelay min delay in milliseconds
+     * @param maxDelay max delay in milliseconds
+     */
+    constructor(action: () => void, minDelay = 100, maxDelay = 500) {
+        this.action = action;
+        this.minDelay = minDelay;
+        this.maxDelay = maxDelay;
+    }
+
+    public trigger() {
+        if (this.timeout === undefined) {
+            this.timeout = new DzTimer();
+            this.timeout.timeout.connect(() => {
+                this.action();
+                this.reset();
+            });
+            this.timeout.start(this.maxDelay);
+        } else {
+            this.timeout.stop();
+            this.timeout.start(this.minDelay);
+        }
+    }
+
+    private reset() {
+        if (this.timeout !== undefined) {
+            this.timeout.stop();
+            this.timeout = undefined;
+        }
+    }
 }

package/src/lib/dictionary.ts

@@ -0,0 +1,3 @@
+export type Dictionary<K extends string | number | symbol, V> = {
+    [P in K]: V;
+};