dazscript-framework 1.0.33 → 1.0.35

package/package.json

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

package/src/helpers/figure-helper.ts

@@ -0,0 +1,23 @@
+export const resolveFigureNode = (node: DzNode | null): DzSkeleton | null => {
+    if (!node) return null
+    if (node.inherits('DzSkeleton')) return node as DzSkeleton
+    return node.getSkeleton?.() ?? null
+}
+
+export const getFigureResolutionLevel = (figure: DzNode): number | null => {
+    const property = getFigureResolutionProperty(figure)
+    return property ? property.getValue() : null
+}
+
+export const setFigureResolutionLevel = (figure: DzNode, resolution: number): boolean => {
+    const property = getFigureResolutionProperty(figure)
+    if (!property) return false
+
+    property.setValue(resolution)
+    return true
+}
+
+const getFigureResolutionProperty = (figure: DzNode): DzEnumProperty | null => {
+    const shape = figure.getObject()?.getCurrentShape()
+    return shape?.findProperty('lodlevel') as DzEnumProperty | null
+}

package/src/helpers/material-helper.ts

@@ -0,0 +1,43 @@
+export type SimpleMaterialOptions = {
+    color: Color
+    opacity: number
+    name?: string
+}
+
+export const applySingleMaterial = (node: DzNode, options: SimpleMaterialOptions): boolean => {
+    const shape = node.getObject()?.getCurrentShape()
+    if (!shape) return false
+
+    if (shape.getNumMaterials() < 1) {
+        shape.createMaterial(options.name ?? 'Material')
+    }
+
+    let applied = false
+    for (let i = 0; i < shape.getNumMaterials(); i++) {
+        const material = shape.getMaterial(i)
+        if (!material) continue
+        applyMaterialValues(material, options)
+        applied = true
+    }
+
+    return applied
+}
+
+const applyMaterialValues = (material: DzMaterial, options: SimpleMaterialOptions): void => {
+    const anyMaterial = material as any
+    if (options.name && typeof anyMaterial.setName === 'function') {
+        anyMaterial.setName(options.name)
+    }
+
+    material.setDiffuseColor(options.color)
+    material.setBaseOpacity(clampOpacity(options.opacity))
+
+    if (typeof anyMaterial.setOpacity === 'function') {
+        anyMaterial.setOpacity(clampOpacity(options.opacity))
+    }
+}
+
+const clampOpacity = (opacity: number): number => {
+    if (!isFinite(opacity) || isNaN(opacity)) return 0.25
+    return Math.max(0, Math.min(1, opacity))
+}

package/src/helpers/obj-file-helper.ts

@@ -0,0 +1,112 @@
+export type SilentObjExportOptions = {
+    selectedOnly?: boolean
+    selectedRootsOnly?: boolean
+    includeParented?: boolean
+    writeUvs?: boolean
+    writeNormals?: boolean
+    writeObjects?: boolean
+    writeGroups?: boolean
+    writeMaterials?: boolean
+    writeMaterialLibrary?: boolean
+    groupByGeometry?: boolean
+    groupByNodes?: boolean
+    groupBySurfaces?: boolean
+}
+
+export type ObjFileResult = {
+    ok: boolean
+    path: string
+    result: string
+}
+
+export const createSilentObjExportSettings = (options: SilentObjExportOptions = {}): DzFileIOSettings => {
+    const settings = createObjAxisSettings()
+    settings.setBoolValue('IgnoreInvisible', false)
+    settings.setBoolValue('WeldSeams', false)
+    settings.setBoolValue('RemoveUnusedVerts', false)
+    settings.setBoolValue('WriteVT', options.writeUvs ?? true)
+    settings.setBoolValue('WriteVN', options.writeNormals ?? false)
+    settings.setBoolValue('WriteO', options.writeObjects ?? true)
+    settings.setBoolValue('WriteG', options.writeGroups ?? true)
+    settings.setBoolValue('GroupGeom', options.groupByGeometry ?? true)
+    settings.setBoolValue('GroupNodes', options.groupByNodes ?? false)
+    settings.setBoolValue('GroupSurfaces', options.groupBySurfaces ?? true)
+    settings.setBoolValue('GroupSingle', false)
+    settings.setBoolValue('WriteUsemtl', options.writeMaterials ?? true)
+    settings.setBoolValue('WriteMtllib', options.writeMaterialLibrary ?? false)
+    settings.setBoolValue('CollectMaps', false)
+    settings.setBoolValue('ConvertMaps', false)
+    settings.setBoolValue('SelectedOnly', options.selectedOnly ?? true)
+    settings.setBoolValue('SelectedRootsOnly', options.selectedRootsOnly ?? true)
+    settings.setBoolValue('PrimaryRootOnly', false)
+    settings.setBoolValue('IncludeParented', options.includeParented ?? false)
+    settings.setBoolValue('TriangulateNgons', false)
+    settings.setBoolValue('CollapseUVTiles', false)
+    settings.setBoolValue('ShowIndividualSettings', true)
+    settings.setIntValue('FloatPrecision', 6)
+    settings.setIntValue('RunSilent', 1)
+    return settings
+}
+
+export const createMinimalSilentObjExportSettings = (): DzFileIOSettings =>
+    createSilentObjExportSettings({
+        writeUvs: false,
+        writeNormals: false,
+        writeObjects: false,
+        writeGroups: false,
+        writeMaterials: false,
+        writeMaterialLibrary: false,
+        groupByGeometry: false,
+        groupByNodes: false,
+        groupBySurfaces: false,
+        selectedOnly: true,
+        selectedRootsOnly: true,
+        includeParented: false
+    })
+
+export const createSilentObjImportSettings = (): DzFileIOSettings => {
+    const settings = createObjAxisSettings()
+    settings.setBoolValue('IncludeVT', false)
+    settings.setBoolValue('IncludeG', false)
+    settings.setBoolValue('IncludeUsemtl', false)
+    settings.setBoolValue('IncludeMtllib', false)
+    settings.setBoolValue('ShowIndividualSettings', true)
+    settings.setIntValue('RunSilent', 1)
+    return settings
+}
+
+export const exportObjSilent = (path: string, settings: DzFileIOSettings = createMinimalSilentObjExportSettings()): ObjFileResult => {
+    const exporter = (App.getExportMgr() as any).findExporterByClassName('DzObjExporter')
+    if (!exporter) return { ok: false, path, result: 'DzObjExporter not found' }
+
+    try {
+        const result = exporter.writeFile(path, settings)
+        return { ok: true, path, result: String(result) }
+    } finally {
+        exporter.deleteLater?.()
+    }
+}
+
+export const importObjSilent = (path: string, settings: DzFileIOSettings = createSilentObjImportSettings()): ObjFileResult => {
+    const importer = (App.getImportMgr() as any).findImporterByClassName('DzObjImporter')
+    if (!importer) return { ok: false, path, result: 'DzObjImporter not found' }
+
+    try {
+        const result = importer.readFile(path, settings)
+        return { ok: true, path, result: String(result) }
+    } finally {
+        importer.deleteLater?.()
+    }
+}
+
+const createObjAxisSettings = (): DzFileIOSettings => {
+    const settings = new DzFileIOSettings()
+    settings.setFloatValue('Scale', 243.84)
+    settings.setStringValue('LatAxis', 'X')
+    settings.setStringValue('VertAxis', 'Y')
+    settings.setStringValue('DepthAxis', 'Z')
+    settings.setBoolValue('InvertLat', false)
+    settings.setBoolValue('InvertVert', false)
+    settings.setBoolValue('InvertDepth', false)
+    return settings
+}

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

@@ -0,0 +1,37 @@
+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

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

@@ -0,0 +1,81 @@
+import { describe, expect, it } from 'vitest'
+import { getMirrorNameCandidate, getMirrorNodeMatch, getMirrorNodes } from './skeleton-helper'
+
+type TestNode = {
+    name: string
+    getName: () => string
+}
+
+const node = (name: string): TestNode => ({
+    name,
+    getName: () => name
+})
+
+const figure = (names: string[]) => ({
+    findNodeChild: (name: string) => names.indexOf(name) >= 0 ? node(name) : null
+})
+
+describe('skeleton mirror helper', () => {
+    it('resolves Genesis-style compact prefixes', () => {
+        expect(getMirrorNameCandidate('rThighBend')).toMatchObject({
+            side: 'right',
+            convention: 'compact-prefix',
+            sourceToken: 'r',
+            mirrorToken: 'l',
+            mirrorName: 'lThighBend'
+        })
+
+        expect(getMirrorNameCandidate('lHand')).toMatchObject({
+            side: 'left',
+            mirrorName: 'rHand'
+        })
+    })
+
+    it('resolves underscore prefix and suffix names', () => {
+        expect(getMirrorNameCandidate('right_hand')).toMatchObject({
+            side: 'right',
+            convention: 'underscore-prefix',
+            mirrorName: 'left_hand'
+        })
+
+        expect(getMirrorNameCandidate('hand_R')).toMatchObject({
+            side: 'right',
+            convention: 'underscore-suffix',
+            mirrorName: 'hand_L'
+        })
+    })
+
+    it('resolves word prefix and suffix names', () => {
+        expect(getMirrorNameCandidate('RightHand')).toMatchObject({
+            side: 'right',
+            convention: 'word-prefix',
+            mirrorName: 'LeftHand'
+        })
+
+        expect(getMirrorNameCandidate('HandLeft')).toMatchObject({
+            side: 'left',
+            convention: 'word-suffix',
+            mirrorName: 'HandRight'
+        })
+    })
+
+    it('does not classify center bones as mirrored', () => {
+        expect(getMirrorNameCandidate('hip')).toBeNull()
+        expect(getMirrorNameCandidate('abdomenLower')).toBeNull()
+    })
+
+    it('returns rich match metadata while keeping getMirrorNodes compatible', () => {
+        const testFigure = figure(['lThighBend', 'hip'])
+        const source = node('rThighBend')
+        const center = node('hip')
+
+        const match = getMirrorNodeMatch(testFigure as unknown as DzSkeleton, source as unknown as DzNode)
+
+        expect(match.side).toBe('right')
+        expect(match.mirror?.getName()).toBe('lThighBend')
+        expect(getMirrorNodes(testFigure as unknown as DzSkeleton, [
+            source as unknown as DzNode,
+            center as unknown as DzNode
+        ]).map(item => item.getName())).toEqual(['lThighBend'])
+    })
+})

package/src/helpers/skeleton-helper.ts

@@ -10,18 +10,143 @@ export const getModifiers = (figure: DzSkeleton): DzModifier[] => {
     return modifiers
 }
 
+export type MirrorSide = 'left' | 'right'
+
+export type MirrorNameConvention =
+    | 'compact-prefix'
+    | 'underscore-prefix'
+    | 'underscore-suffix'
+    | 'word-prefix'
+    | 'word-suffix'
+
+export type MirrorNodeMatch = {
+    source: DzNode
+    mirror: DzNode | null
+    side: MirrorSide | null
+    convention: MirrorNameConvention | null
+    sourceToken: string | null
+    mirrorToken: string | null
+    mirrorName: string | null
+}
+
+type MirrorNameCandidate = Omit<MirrorNodeMatch, 'source' | 'mirror'>
+
+const preserveCase = (source: string, replacement: string): string => {
+    if (source.toUpperCase() === source) return replacement.toUpperCase()
+    if (source.toLowerCase() === source) return replacement.toLowerCase()
+    if (source.length > 0 && source[0].toUpperCase() === source[0]) {
+        return replacement[0].toUpperCase() + replacement.substring(1).toLowerCase()
+    }
+
+    return replacement
+}
+
+export const getMirrorNameCandidate = (name: string): MirrorNameCandidate | null => {
+    const compactPrefix = /^([lr])([A-Z].*)$/.exec(name)
+    if (compactPrefix) {
+        const sourceToken = compactPrefix[1]
+        const mirrorToken = sourceToken === 'r' ? 'l' : 'r'
+        return {
+            side: sourceToken === 'r' ? 'right' : 'left',
+            convention: 'compact-prefix',
+            sourceToken,
+            mirrorToken,
+            mirrorName: `${mirrorToken}${compactPrefix[2]}`
+        }
+    }
+
+    const underscorePrefix = /^(r|l|right|left)([_-].+)$/i.exec(name)
+    if (underscorePrefix) {
+        const sourceToken = underscorePrefix[1]
+        const side = sourceToken.toLowerCase()[0] === 'r' ? 'right' : 'left'
+        const mirrorToken = preserveCase(sourceToken, sourceToken.length === 1
+            ? (side === 'right' ? 'l' : 'r')
+            : (side === 'right' ? 'left' : 'right'))
+        return {
+            side,
+            convention: 'underscore-prefix',
+            sourceToken,
+            mirrorToken,
+            mirrorName: `${mirrorToken}${underscorePrefix[2]}`
+        }
+    }
+
+    const underscoreSuffix = /^(.+[_-])(r|l|right|left)$/i.exec(name)
+    if (underscoreSuffix) {
+        const sourceToken = underscoreSuffix[2]
+        const side = sourceToken.toLowerCase()[0] === 'r' ? 'right' : 'left'
+        const mirrorToken = preserveCase(sourceToken, sourceToken.length === 1
+            ? (side === 'right' ? 'l' : 'r')
+            : (side === 'right' ? 'left' : 'right'))
+        return {
+            side,
+            convention: 'underscore-suffix',
+            sourceToken,
+            mirrorToken,
+            mirrorName: `${underscoreSuffix[1]}${mirrorToken}`
+        }
+    }
+
+    const wordPrefix = /^(right|left)([A-Z].*)$/i.exec(name)
+    if (wordPrefix) {
+        const sourceToken = wordPrefix[1]
+        const side = sourceToken.toLowerCase() === 'right' ? 'right' : 'left'
+        const mirrorToken = preserveCase(sourceToken, side === 'right' ? 'left' : 'right')
+        return {
+            side,
+            convention: 'word-prefix',
+            sourceToken,
+            mirrorToken,
+            mirrorName: `${mirrorToken}${wordPrefix[2]}`
+        }
+    }
+
+    const wordSuffix = /^(.+[a-z])(Right|Left)$/i.exec(name)
+    if (wordSuffix) {
+        const sourceToken = wordSuffix[2]
+        const side = sourceToken.toLowerCase() === 'right' ? 'right' : 'left'
+        const mirrorToken = preserveCase(sourceToken, side === 'right' ? 'left' : 'right')
+        return {
+            side,
+            convention: 'word-suffix',
+            sourceToken,
+            mirrorToken,
+            mirrorName: `${wordSuffix[1]}${mirrorToken}`
+        }
+    }
+
+    return null
+}
+
+export const getMirrorNodeMatch = (figure: DzSkeleton, node: DzNode): MirrorNodeMatch => {
+    const name = node.getName().valueOf()
+    const candidate = getMirrorNameCandidate(name)
+
+    if (!candidate) {
+        return {
+            source: node,
+            mirror: null,
+            side: null,
+            convention: null,
+            sourceToken: null,
+            mirrorToken: null,
+            mirrorName: null
+        }
+    }
+
+    return {
+        source: node,
+        mirror: figure.findNodeChild(candidate.mirrorName, true),
+        ...candidate
+    }
+}
+
+export const getMirrorNodeMatches = (figure: DzSkeleton, nodes: DzNode[]): MirrorNodeMatch[] => {
+    return nodes.map(node => getMirrorNodeMatch(figure, node))
+}
+
 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
-}
+    return getMirrorNodeMatches(figure, nodes)
+        .map(match => match.mirror)
+        .filter(node => node !== null) as DzNode[]
+}