dazscript-framework 1.0.35 → 1.0.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dazscript-framework",
-  "version": "1.0.35",
+  "version": "1.0.37",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",

package/src/helpers/node-helper.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it, vi } from 'vitest'
+import { isHairType } from './node-helper'
+
+const getTypeForNode = vi.fn()
+const isHairTypeAsset = vi.fn()
+
+vi.mock('@dsf/core/global', () => ({
+    app: {
+        getAssetMgr: () => ({
+            getTypeForNode,
+            isHairType: isHairTypeAsset
+        })
+    },
+    sceneHelper: {}
+}))
+
+describe('node helper hair classification', () => {
+    it('treats eyelash content types as hair regardless of case', () => {
+        getTypeForNode.mockReturnValue('Follower/Attachment/Head/Face/Eyelashes')
+        isHairTypeAsset.mockReturnValue(false)
+
+        const node = {
+            iskindof: (type: string) => type === 'DzSkeleton',
+            getSkeleton: () => node
+        }
+
+        expect(isHairType(node as unknown as DzNode)).toBe(true)
+    })
+})

package/src/helpers/node-helper.ts

@@ -120,7 +120,7 @@ export const isHairType = (node: DzNode): boolean => {
     const figure = getFigure(node)!
     const assetMgr = app.getAssetMgr()
     const type = assetMgr.getTypeForNode(figure)
-    return assetMgr.isHairType(type) || contains(type.valueOf(), 'Hair')
+    return assetMgr.isHairType(type) || contains(type.valueOf(), ['Hair', 'Eyelashes'], true)
 }
 
 export const isGeoShell = (node: DzNode): boolean => {

package/src/helpers/primitive-helper.ts

@@ -0,0 +1,67 @@
+export type PrimitiveKind = 'Sphere' | 'Cube' | 'Cone' | 'Plane' | 'Torus' | 'Cylinder'
+
+export type CreatePrimitiveOptions = {
+    kind: PrimitiveKind
+    name?: string
+    label?: string
+    size?: number
+}
+
+export type CreatePrimitiveResult = {
+    ok: boolean
+    node: DzNode | null
+    message: string
+}
+
+declare const Geometry: DzGeometryUtil | undefined
+
+export const createPrimitive = (options: CreatePrimitiveOptions): CreatePrimitiveResult => {
+    const geometryUtil = getGeometryUtil()
+    if (!geometryUtil) {
+        return { ok: false, node: null, message: 'Global Geometry utility is not available' }
+    }
+
+    const primitiveType = getPrimitiveType(geometryUtil, options.kind)
+    if (primitiveType === null) {
+        return { ok: false, node: null, message: `Unsupported primitive kind: ${options.kind}` }
+    }
+
+    const settings = new DzSettings()
+    geometryUtil.getDefaultPrimitiveOptions(primitiveType, settings)
+
+    if (typeof options.size === 'number' && isFinite(options.size) && options.size > 0) {
+        settings.setFloatValue('size', options.size)
+    }
+
+    const node = geometryUtil.createPrimitive(settings)
+    if (!node) {
+        return { ok: false, node: null, message: `DzGeometryUtil did not create a ${options.kind}` }
+    }
+
+    if (options.name) node.setName(options.name)
+    if (options.label) node.setLabel(options.label)
+    if (!isNodeInScene(node)) Scene.addNode(node)
+
+    return { ok: true, node, message: '' }
+}
+
+const getGeometryUtil = (): DzGeometryUtil | null =>
+    typeof Geometry !== 'undefined' ? Geometry : null
+
+const getPrimitiveType = (geometryUtil: DzGeometryUtil, kind: PrimitiveKind): number | null => {
+    const primitiveTypes = geometryUtil as any
+    if (kind === 'Sphere') return primitiveTypes.Sphere
+    if (kind === 'Cube') return primitiveTypes.Cube
+    if (kind === 'Cone') return primitiveTypes.Cone
+    if (kind === 'Plane') return primitiveTypes.Plane
+    if (kind === 'Torus') return primitiveTypes.Torus
+    if (kind === 'Cylinder') return primitiveTypes.Cylinder
+    return null
+}
+
+const isNodeInScene = (node: DzNode): boolean => {
+    for (let i = 0; i < Scene.getNumNodes(); i++) {
+        if (Scene.getNode(i) === node) return true
+    }
+    return false
+}

package/src/helpers/scene-helper.ts

@@ -2,6 +2,7 @@ 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'
+import { startsWith } from './string-helper'
 
 export const getSelectedOf = <T>(typeName: string): DzNode[] => {
     let nodes: DzNode[] = []
@@ -143,3 +144,37 @@ export const timeToFrame = (time: DzTime): number => {
 export const frameToTime = (frame: number): DzTime => {
     return new DzTime(scene.getTimeStep().valueOf() * frame)
 }
+
+export const collectSceneNodeIds = (): number[] => {
+    const ids: number[] = []
+    for (let i = 0; i < Scene.getNumNodes(); i++) {
+        ids.push(Scene.getNode(i).elementID)
+    }
+    return ids
+}
+
+export const getNodesAddedAfter = (beforeIds: number[]): DzNode[] => {
+    const nodes: DzNode[] = []
+    for (let i = 0; i < Scene.getNumNodes(); i++) {
+        const node = Scene.getNode(i)
+        if (beforeIds.indexOf(node.elementID) < 0) nodes.push(node)
+    }
+    return nodes
+}
+
+export const removeNodesByNameOrLabelPrefix = (prefix: string): number => {
+    const nodes: DzNode[] = []
+
+    for (let i = 0; i < Scene.getNumNodes(); i++) {
+        const node = Scene.getNode(i)
+        if (startsWith(String(node.getName()), prefix) || startsWith(String(node.getLabel()), prefix)) {
+            nodes.push(node)
+        }
+    }
+
+    for (let i = 0; i < nodes.length; i++) {
+        Scene.removeNode(nodes[i])
+    }
+
+    return nodes.length
+}

package/src/helpers/scene-node-helper.ts

@@ -1,37 +1 @@
-export const collectSceneNodeIds = (): number[] => {
-    const ids: number[] = []
-    for (let i = 0; i < Scene.getNumNodes(); i++) {
-        ids.push(Scene.getNode(i).elementID)
-    }
-    return ids
-}
-
-export const getNodesAddedAfter = (beforeIds: number[]): DzNode[] => {
-    const nodes: DzNode[] = []
-    for (let i = 0; i < Scene.getNumNodes(); i++) {
-        const node = Scene.getNode(i)
-        if (beforeIds.indexOf(node.elementID) < 0) nodes.push(node)
-    }
-    return nodes
-}
-
-export const removeNodesByNameOrLabelPrefix = (prefix: string): number => {
-    const nodes: DzNode[] = []
-
-    for (let i = 0; i < Scene.getNumNodes(); i++) {
-        const node = Scene.getNode(i)
-        if (startsWith(String(node.getName()), prefix) || startsWith(String(node.getLabel()), prefix)) {
-            nodes.push(node)
-        }
-    }
-
-    for (let i = 0; i < nodes.length; i++) {
-        Scene.removeNode(nodes[i])
-        nodes[i].deleteLater?.()
-    }
-
-    return nodes.length
-}
-
-const startsWith = (value: string, prefix: string): boolean =>
-    value.substr(0, prefix.length) === prefix
+export { collectSceneNodeIds, getNodesAddedAfter, removeNodesByNameOrLabelPrefix } from './scene-helper'

package/src/helpers/string-helper.test.ts

@@ -0,0 +1,12 @@
+import { describe, expect, it } from 'vitest'
+import { contains } from './string-helper'
+
+describe('string contains helper', () => {
+    it('matches any requested token case-insensitively when requested', () => {
+        expect(contains('Follower/Attachment/Head/Face/Eyelashes', ['hair', 'eyelashes'], true)).toBe(true)
+    })
+
+    it('keeps matching case-sensitive by default', () => {
+        expect(contains('Follower/Attachment/Head/Face/Eyelashes', 'eyelashes')).toBe(false)
+    })
+})

package/src/helpers/string-helper.ts

@@ -4,7 +4,17 @@ export const isNumeric = (value: string | number): boolean => {
         !isNaN(Number(value.toString())))
 }
 
-export const contains = (source: string, search: string | string[]): boolean => {
+export const contains = (source: string, search: string | string[], caseInsensitive: boolean = false): boolean => {
+    if (caseInsensitive) {
+        source = source.toLowerCase()
+        if (Array.isArray(search)) {
+            search = search.map(s => s.toLowerCase())
+        }
+        else {
+            search = search.toLowerCase()
+        }
+    }
+
     if (Array.isArray(search)) {
         for (const s of search) {
             if (source.indexOf(s) >= 0) return true
@@ -14,6 +24,10 @@ export const contains = (source: string, search: string | string[]): boolean =>
     return source.indexOf(search) >= 0
 }
 
+export const startsWith = (source: string, search: string): boolean => {
+    return source.substr(0, search.length) === search
+}
+
 export const remove = (source: string, search: string): string => {
     return source.replace(search, "")
 }