dazscript-framework 0.1.14 → 0.1.16

package/src/helpers/action-helper.ts

@@ -1,81 +1,214 @@
-import { debug, warn } from '@dsf/common/log'
-import { mainWindow } from '@dsf/core/global'
-import { isGUID } from './string-helper'
-
-const actionMgr = mainWindow.getActionMgr()
-
-export const isCustomAction = (action: string | DzAction): boolean => {
-    return typeof action === 'string'
-        ? isGUID(action)
-        : action.inherits('DzCustomAction')
-}
-
-export const findAction = (name: string): DzAction | null => {
-    return isCustomAction(name)
-        ? findCustomAction(name)
-        : actionMgr.findAction(name)
-}
-
-const findCustomAction = (name: string): DzCustomAction | null => {
-    let index = actionMgr.findCustomAction(name)
-    return index >= 0
-        ? actionMgr.getCustomActionByIndex(index)
-        : null
-}
-
-export const triggerAction = (name: string) => {
-    findAction(name)?.trigger()
-}
-
-export const setActionShortcut = (name: string, shortcut: string) => {
-    let action = findAction(name)
-    if (!action) return
-    if (isCustomAction(action)) {
-        actionMgr.setCustomActionShortcut(actionMgr.findCustomAction(name), shortcut)
-        debug(`Shortcut set for Custom Action ${action.text}: ${shortcut}`)
-    }
-    else {
-        actionMgr.setAccel(name, shortcut)
-        debug(`Shortcut set for Action ${action.text}: ${shortcut}`)
-    }
-
-}
-
-export const clearActionShorcut = (name: string) => {
-    let action = findAction(name)
-    if (!action) return
-    if (isCustomAction(action)) {
-        actionMgr.setCustomActionShortcut(actionMgr.findCustomAction(name), '')
-    }
-    else {
-        actionMgr.setAccel(name, '')
-    }
-}
-
-export const getActionPixmap = (action: string, icon: string, maxSize?: number): QPixmap | null => {
-    try {
-        if (!action) return null;
-        let isCustom = isCustomAction(action)
-
-        if (isCustom && icon && typeof icon === 'string' && icon) {
-            let image: DzImageTexture = (App.getImageMgr() as any)['getImage(QString)'](icon)
-            if (image) {
-                let size = image.getOriginalImageSize();
-                let pixmap = size.width > maxSize || size.height > maxSize
-                    ? image.getPreviewPixmap(Math.min(size.width, maxSize), Math.min(size.height, maxSize))
-                    : new Pixmap(image.getFilename())
-
-                return pixmap
-            }
-        }
-        else if (!isCustom) {
-            let pixmap = App.getStyle().actionPixmap(action, 0, 0)
-            return pixmap?.height === 0 ? null : pixmap
-        }
-    } catch (error) {
-        warn(`Error while trying to get icon pixmap: ${error}`)
-    }
-    return null
-}
-
-
+import { debug, warn } from '@dsf/common/log'
+import { mainWindow } from '@dsf/core/global'
+import { isGUID } from './string-helper'
+
+const actionMgr = mainWindow.getActionMgr()
+
+const shortcutTokenMap: { [key: string]: string } = {
+    'CTRL': 'Ctrl',
+    'CONTROL': 'Ctrl',
+    'SHIFT': 'Shift',
+    'ALT': 'Alt',
+    'OPTION': 'Alt',
+    'WIN': 'Win',
+    'WINDOWS': 'Win',
+    'CMD': 'Win',
+    'COMMAND': 'Win',
+    'SPACE': 'Space',
+    'HOME': 'Home',
+    'END': 'End',
+    'INS': 'Ins',
+    'INSERT': 'Ins',
+    'DEL': 'Del',
+    'DELETE': 'Del',
+    'TAB': 'Tab',
+    'BACKSPACE': 'Backspace',
+    'COMMA': 'Comma',
+    'PERIOD': 'Period',
+    'PLUS': 'Plus',
+    'MINUS': 'Minus',
+    'PGUP': 'PgUp',
+    'PAGEUP': 'PgUp',
+    'PGDOWN': 'PgDn',
+    'PGDN': 'PgDn',
+    'LEFT': 'Left',
+    'RIGHT': 'Right',
+    'UP': 'Up',
+    'DOWN': 'Down',
+}
+
+const normalizeShortcut = (shortcut: string): string => {
+    if (!shortcut) return ''
+
+    return shortcut
+        .split('+')
+        .map(part => part.trim())
+        .filter(Boolean)
+        .map(part => {
+            if (part.length === 1) return part.toUpperCase()
+
+            const key = part.toUpperCase()
+            return shortcutTokenMap[key] || part
+        })
+        .join('+')
+}
+
+type ActionShortcutEntry = {
+    action: DzAction
+    shortcut: string
+}
+
+const getAllActions = (): ActionShortcutEntry[] => {
+    const actions: ActionShortcutEntry[] = []
+
+    const numActions = actionMgr.getNumActions()
+    for (let i = 0; i < numActions; i++) {
+        const action = actionMgr.getAction(i)
+        if (!action) continue
+
+        actions.push({
+            action,
+            shortcut: String(action.shortcut?.toString() ?? '').trim()
+        })
+    }
+
+    const numCustomActions = actionMgr.getNumCustomActions()
+    for (let i = 0; i < numCustomActions; i++) {
+        const action = actionMgr.getCustomActionByIndex(i)
+        if (!action) continue
+
+        actions.push({
+            action,
+            shortcut: String(actionMgr.getCustomActionShortcut(i) ?? '').trim()
+        })
+    }
+
+    return actions
+}
+
+export const isCustomAction = (action: string | DzAction): boolean => {
+    return typeof action === 'string'
+        ? isGUID(action)
+        : action.inherits('DzCustomAction')
+}
+
+export const findAction = (name: string): DzAction | null => {
+    return isCustomAction(name)
+        ? findCustomAction(name)
+        : actionMgr.findAction(name)
+}
+
+export const actionExists = (name: string): boolean => {
+    return findAction(name) !== null
+}
+
+export const getCustomActionFilePath = (name: string): string | null => {
+    let index = actionMgr.findCustomAction(name)
+    if (index < 0) return null
+
+    let filePath = actionMgr.getCustomActionFile(index)
+    return filePath ? filePath.toString() : null
+}
+
+export const findCustomActionByFilePath = (filePath: string): DzCustomAction | null => {
+    let count = actionMgr.getNumCustomActions()
+
+    for (let i = 0; i < count; i++) {
+        let customActionFile = actionMgr.getCustomActionFile(i)
+        if (!customActionFile) continue
+        if (customActionFile.toString() !== filePath) continue
+
+        return actionMgr.getCustomActionByIndex(i)
+    }
+
+    return null
+}
+
+const findCustomAction = (name: string): DzCustomAction | null => {
+    let index = actionMgr.findCustomAction(name)
+    return index >= 0
+        ? actionMgr.getCustomActionByIndex(index)
+        : null
+}
+
+export const triggerAction = (name: string) => {
+    const action = findAction(name)
+    if (!action) {
+        warn(`Power Menu - Action not found: "${name}"`)
+    }
+    debug(`Power Menu - Trigger Action: "${action?.text}" (${name})`)
+    action?.trigger()
+}
+
+export const setActionShortcut = (name: string, shortcut: string) => {
+    let action = findAction(name)
+    if (!action) return
+    const normalizedShortcut = normalizeShortcut(shortcut)
+    if (isCustomAction(action)) {
+        actionMgr.setCustomActionShortcut(actionMgr.findCustomAction(name), normalizedShortcut)
+        debug(`Shortcut set for Custom Action ${action.text}: ${normalizedShortcut}`)
+    }
+    else {
+        actionMgr.setAccel(name, normalizedShortcut)
+        debug(`Shortcut set for Action ${action.text}: ${normalizedShortcut}`)
+    }
+
+}
+
+export const findActionsForShortcut = (shortcut: string): DzAction[] => {
+    if (!shortcut) return []
+
+    const normalizedShortcut = normalizeShortcut(shortcut)
+    const resultEntries = getAllActions().filter(({ shortcut: actionShortcut }) =>
+        actionShortcut && normalizeShortcut(actionShortcut) === normalizedShortcut
+    )
+    const result = resultEntries.map(({ action }) => action)
+
+    debug(
+        `[ShortcutLookup] input="${shortcut}" normalized="${normalizedShortcut}" result=${resultEntries.map(({ action, shortcut }) => `${action?.text || action?.name}=${shortcut}`).join(', ')}`
+    )
+
+    return result
+}
+
+export const clearActionShorcut = (name: string) => {
+    let action = findAction(name)
+    if (!action) return
+    if (isCustomAction(action)) {
+        actionMgr.setCustomActionShortcut(actionMgr.findCustomAction(name), '')
+    }
+    else {
+        actionMgr.setAccel(name, '')
+    }
+}
+
+export const getActionPixmap = (action: string, icon: string, maxSize?: number): QPixmap | null => {
+    try {
+        if (!action) return null;
+        let isCustom = isCustomAction(action)
+
+        if (isCustom && icon && typeof icon === 'string' && icon) {
+            let image: DzImageTexture = (App.getImageMgr() as any)['getImage(QString)'](icon)
+            if (image) {
+                let size = image.getOriginalImageSize();
+                let pixmap: QPixmap
+                // Only clamp if maxSize is provided and image is larger
+                if (maxSize && (size.width > maxSize || size.height > maxSize)) {
+                    pixmap = image.getPreviewPixmap(Math.min(size.width, maxSize), Math.min(size.height, maxSize))
+                } else {
+                    pixmap = new Pixmap(image.getFilename())
+                }
+                return pixmap
+            }
+        }
+        else if (!isCustom) {
+            let pixmap = App.getStyle().actionPixmap(action, 0, 0)
+            return pixmap?.height === 0 ? null : pixmap
+        }
+    } catch (error) {
+        warn(`Error while trying to get icon pixmap: ${error}`)
+    }
+    return null
+}
+
+

package/src/helpers/array-helper.ts

@@ -1,145 +1,170 @@
-import Set from '@dsf/lib/set';
-
-export const contains = <T>(array: T[], searchElement: T, fromIndex?: number): boolean => {
-  if (array == null) {
-    throw new TypeError('Array.prototype includes called on null or undefined');
-  }
-
-  const O = Object(array);
-  const len = O.length >>> 0;
-
-  if (len === 0) {
-    return false;
-  }
-
-  let k = 0;
-
-  if (fromIndex !== undefined) {
-    k = fromIndex | 0;
-    k = Math.max(k >= 0 ? k : len - Math.abs(k), 0);
-  }
-
-  while (k < len) {
-    if (O[k] === searchElement) {
-      return true;
-    }
-    k++;
-  }
-
-  return false;
-}
-
-export const find = <T>(array: T[], f: (item: T) => boolean): T | null => {
-  for (const item of array) {
-    if (f(item)) {
-      return item
-    }
-  }
-  return null
-}
-
-export const distinct = <T>(items: T[], f?: (item: T) => any): T[] => {
-  const distinctItems: T[] = [];
-  const customSet = new Set<T>();
-
-  for (const item of items) {
-    const key = f ? f(item) : item;
-    if (!customSet.has(key)) {
-      customSet.add(key);
-      distinctItems.push(item);
-    }
-  }
-
-  return distinctItems;
-}
-
-/**
- * Adds the item to the array only if it is not already contained
- * @param array
- * @param item
- * @returns
- */
-export const append = <T>(array: T[], item: T): T[] => {
-  if (!contains(array, item)) {
-    array.push(item);
-  }
-  return array
-}
-
-export const flatten = <T>(array: (T | T[])[]): T[] => {
-  const flattened: T[] = [];
-  const stack: (T | T[])[] = [...array];
-
-  while (stack.length) {
-    const item = stack.pop();
-    if (Array.isArray(item)) {
-      // If the item is an array, push its contents onto the stack.
-      stack.push(...item);
-    } else {
-      // If the item is not an array, add it to the flattened array.
-      flattened.push(item);
-    }
-  }
-
-  return flattened.reverse(); // Reverse the array to maintain original order.
-}
-
-export const any = <T>(array: T[], f?: (item: T) => boolean): boolean => {
-  if (!f)
-    return array.length > 0
-
-  for (const item of array) {
-    if (f(item)) {
-      return true
-    }
-  }
-  return false;
-}
-
-export const moveToTop = <T>(arr: T[], element: T, findBy: (item: T) => string) => {
-  const findByValue = findBy(element);
-  let index = -1;
-
-  for (let i = 0; i < arr.length; i++) {
-    if (findBy(arr[i]) === findByValue) {
-      index = i;
-      break;
-    }
-  }
-
-  if (index > -1) {
-    const [removed] = arr.splice(index, 1);
-    arr.unshift(removed);
-    return;
-  }
-}
-
-export const moveToBottom = <T>(arr: T[], element: T, findBy: (item: T) => string) => {
-  const findByValue = findBy(element);
-  let index = -1;
-
-  for (let i = arr.length - 1; i >= 0; i--) {
-    if (findBy(arr[i]) === findByValue) {
-      index = i;
-      break;
-    }
-  }
-
-  if (index > -1) {
-    const [removed] = arr.splice(index, 1);
-    arr.push(removed);
-    return;
-  }
-}
-
-export const group = <T, K extends string>(array: T[], getKey: (item: T) => K): Record<K, T[]> => {
-  let reduced: Record<K, T[]> = array.reduce((previous, currentItem) => {
-    let group = getKey(currentItem);
-    if (!group) group = "" as K;
-    if (!previous[group]) previous[group] = [];
-    previous[group].push(currentItem);
-    return previous;
-  }, {} as Record<K, T[]>);
-  return reduced;
-}
-
+import Set from '@dsf/lib/set';
+
+export const contains = <T>(array: T[], searchElement: T, fromIndex?: number): boolean => {
+  if (array == null) {
+    throw new TypeError('Array.prototype includes called on null or undefined');
+  }
+
+  const O = Object(array);
+  const len = O.length >>> 0;
+
+  if (len === 0) {
+    return false;
+  }
+
+  let k = 0;
+
+  if (fromIndex !== undefined) {
+    k = fromIndex | 0;
+    k = Math.max(k >= 0 ? k : len - Math.abs(k), 0);
+  }
+
+  while (k < len) {
+    if (O[k] === searchElement) {
+      return true;
+    }
+    k++;
+  }
+
+  return false;
+}
+
+export const find = <T>(array: T[], f: (item: T) => boolean): T | null => {
+  for (const item of array) {
+    if (f(item)) {
+      return item
+    }
+  }
+  return null
+}
+
+export const distinct = <T>(items: T[], f?: (item: T) => any): T[] => {
+  const distinctItems: T[] = [];
+  const customSet = new Set<T>();
+
+  for (const item of items) {
+    const key = f ? f(item) : item;
+    if (!customSet.has(key)) {
+      customSet.add(key);
+      distinctItems.push(item);
+    }
+  }
+
+  return distinctItems;
+}
+
+/**
+ * Adds the item to the array only if it is not already contained
+ * @param array
+ * @param item
+ * @returns
+ */
+export const append = <T>(array: T[], item: T): T[] => {
+  if (!contains(array, item)) {
+    array.push(item);
+  }
+  return array
+}
+
+/**
+ * @deprecated Probably inefficient, avoid using in performance critical code
+ * @param array
+ * @returns
+ */
+export const flattenOld = <T>(array: (T | T[])[]): T[] => {
+  const flattened: T[] = [];
+  const stack: (T | T[])[] = [...array];
+
+  while (stack.length) {
+    const item = stack.pop();
+    if (Array.isArray(item)) {
+      // If the item is an array, push its contents onto the stack.
+      stack.push(...item);
+    } else {
+      // If the item is not an array, add it to the flattened array.
+      flattened.push(item);
+    }
+  }
+
+  return flattened.reverse(); // Reverse the array to maintain original order.
+}
+
+/**
+ * Flattens only one level of nested arrays
+ * @param array
+ * @returns
+ */
+export const flatten = <T>(array: (T | T[])[]): T[] => {
+  const out: T[] = [];
+  for (let i = 0; i < array.length; i++) {
+    const item = array[i];
+    if (Array.isArray(item)) {
+      for (let j = 0; j < item.length; j++) {
+        out.push(item[j]);
+      }
+    } else {
+      out.push(item);
+    }
+  }
+  return out;
+}
+
+export const any = <T>(array: T[], f?: (item: T) => boolean): boolean => {
+  if (!f)
+    return array.length > 0
+
+  for (const item of array) {
+    if (f(item)) {
+      return true
+    }
+  }
+  return false;
+}
+
+export const moveToTop = <T>(arr: T[], element: T, findBy: (item: T) => string) => {
+  const findByValue = findBy(element);
+  let index = -1;
+
+  for (let i = 0; i < arr.length; i++) {
+    if (findBy(arr[i]) === findByValue) {
+      index = i;
+      break;
+    }
+  }
+
+  if (index > -1) {
+    const [removed] = arr.splice(index, 1);
+    arr.unshift(removed);
+    return;
+  }
+}
+
+export const moveToBottom = <T>(arr: T[], element: T, findBy: (item: T) => string) => {
+  const findByValue = findBy(element);
+  let index = -1;
+
+  for (let i = arr.length - 1; i >= 0; i--) {
+    if (findBy(arr[i]) === findByValue) {
+      index = i;
+      break;
+    }
+  }
+
+  if (index > -1) {
+    const [removed] = arr.splice(index, 1);
+    arr.push(removed);
+    return;
+  }
+}
+
+export const group = <T, K extends string>(array: T[], getKey: (item: T) => K): Record<K, T[]> => {
+  let reduced: Record<K, T[]> = array.reduce((previous, currentItem) => {
+    let group = getKey(currentItem);
+    if (!group) group = "" as K;
+    if (!previous[group]) previous[group] = [];
+    previous[group].push(currentItem);
+    return previous;
+  }, {} as Record<K, T[]>);
+  return reduced;
+}
+

package/src/helpers/camera-helper.ts

@@ -1,13 +1,13 @@
-import { mainWindow } from '@dsf/core/global';
-
-export const getActiveCamera = (): DzCamera => {
-    return mainWindow.getViewportMgr().getActiveViewport().get3DViewport().getCamera()
-}
-
-export const setActiveCamera = (camera: DzCamera) => {
-    mainWindow.getViewportMgr().getActiveViewport().get3DViewport().setCamera(camera);
-}
-
-export const getPerspectiveCamera = (): DzCamera => {
-    return mainWindow.getViewportMgr().getViewCamera(DzCamera.PERSPECTIVE_CAM)
+import { mainWindow } from '@dsf/core/global';
+
+export const getActiveCamera = (): DzBasicCamera => {
+    return mainWindow.getViewportMgr().getActiveViewport().get3DViewport().getCamera() as DzBasicCamera
+}
+
+export const setActiveCamera = (camera: string | DzCamera) => {
+    mainWindow.getViewportMgr().getActiveViewport().get3DViewport().setCamera(camera as any);
+}
+
+export const getPerspectiveCamera = (): DzCamera => {
+    return mainWindow.getViewportMgr().getViewCamera(DzCamera.PERSPECTIVE_CAM)
 }