comfy-3d-viewers 0.1.2__tar.gz

comfy_3d_viewers-0.1.2/.github/workflows/publish.yml

@@ -0,0 +1,67 @@
+name: Bump Version & Publish
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  bump-and-publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Get current version
+        id: get_version
+        run: |
+          current=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          echo "current=$current" >> $GITHUB_OUTPUT
+
+      - name: Bump patch version
+        id: bump_version
+        run: |
+          current="${{ steps.get_version.outputs.current }}"
+          IFS='.' read -r major minor patch <<< "$current"
+          new_patch=$((patch + 1))
+          new_version="${major}.${minor}.${new_patch}"
+          sed -i "s/^version = \".*\"/version = \"${new_version}\"/" pyproject.toml
+          echo "new_version=$new_version" >> $GITHUB_OUTPUT
+          echo "Bumped version: $current -> $new_version"
+
+      - name: Commit version bump
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml
+          git commit -m "Bump version to ${{ steps.bump_version.outputs.new_version }} [skip ci]"
+          git tag "v${{ steps.bump_version.outputs.new_version }}"
+          git push origin main --tags
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: v${{ steps.bump_version.outputs.new_version }}
+          name: v${{ steps.bump_version.outputs.new_version }}
+          generate_release_notes: true
+          files: dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

comfy_3d_viewers-0.1.2/.gitignore

@@ -0,0 +1,20 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+
+# Node modules (for build_vtk_bundle)
+node_modules/
+package-lock.json
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# OS
+.DS_Store

comfy_3d_viewers-0.1.2/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: comfy-3d-viewers
+Version: 0.1.2
+Summary: Reusable 3D viewer infrastructure for ComfyUI nodes
+Project-URL: Homepage, https://github.com/PozzettiAndrea/comfy-3d-viewers
+Project-URL: Repository, https://github.com/PozzettiAndrea/comfy-3d-viewers
+Author: ComfyUI-GeometryPack Contributors
+License-Expression: GPL-3.0-or-later
+Keywords: 3d,comfyui,gaussian-splatting,mesh-visualization,viewer,vtk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# comfy-3d-viewers
+
+Reusable 3D viewer infrastructure for ComfyUI nodes.
+
+Provides VTK.js and Gaussian splatting viewers, shared utilities, and HTML templates for 3D mesh visualization in ComfyUI.
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+This package is used by ComfyUI-GeometryPack. The `prestartup_script.py` copies the viewer files to the extension's web directory at runtime.
+
+```python
+from comfy_3d_viewers import get_js_dir, get_html_dir, get_utils_dir
+
+# Get paths to viewer files
+js_dir = get_js_dir()      # JS bundles and viewer source
+html_dir = get_html_dir()  # HTML viewer templates
+utils_dir = get_utils_dir() # Shared JS utilities
+```
+
+## Contents
+
+- **JS Bundles**: VTK.js, Gaussian splatting, modular viewer bundle
+- **Viewer Modules**: Modular viewer architecture (core, loaders, viewers, ui, features, utils)
+- **Shared Utilities**: Extension folder detection, screenshot handling, UI components, formatting, analysis panels, postMessage helpers
+- **HTML Templates**: Viewer pages for VTK, textured, dual, gaussian, UV, etc.
+
+## Building
+
+To rebuild the VTK.js bundle:
+
+```bash
+cd build_vtk_bundle
+npm install
+npm run build
+```
+
+## License
+
+GPL-3.0-or-later

comfy_3d_viewers-0.1.2/README.md

@@ -0,0 +1,45 @@
+# comfy-3d-viewers
+
+Reusable 3D viewer infrastructure for ComfyUI nodes.
+
+Provides VTK.js and Gaussian splatting viewers, shared utilities, and HTML templates for 3D mesh visualization in ComfyUI.
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+This package is used by ComfyUI-GeometryPack. The `prestartup_script.py` copies the viewer files to the extension's web directory at runtime.
+
+```python
+from comfy_3d_viewers import get_js_dir, get_html_dir, get_utils_dir
+
+# Get paths to viewer files
+js_dir = get_js_dir()      # JS bundles and viewer source
+html_dir = get_html_dir()  # HTML viewer templates
+utils_dir = get_utils_dir() # Shared JS utilities
+```
+
+## Contents
+
+- **JS Bundles**: VTK.js, Gaussian splatting, modular viewer bundle
+- **Viewer Modules**: Modular viewer architecture (core, loaders, viewers, ui, features, utils)
+- **Shared Utilities**: Extension folder detection, screenshot handling, UI components, formatting, analysis panels, postMessage helpers
+- **HTML Templates**: Viewer pages for VTK, textured, dual, gaussian, UV, etc.
+
+## Building
+
+To rebuild the VTK.js bundle:
+
+```bash
+cd build_vtk_bundle
+npm install
+npm run build
+```
+
+## License
+
+GPL-3.0-or-later

comfy_3d_viewers-0.1.2/build_vtk_bundle/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "vtk-bundle-builder",
+  "version": "1.0.0",
+  "description": "Build custom VTK.js UMD bundle with GLTFImporter",
+  "private": true,
+  "scripts": {
+    "build": "webpack --config webpack.config.js"
+  },
+  "dependencies": {
+    "@kitware/vtk.js": "^34.0.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "babel-loader": "^10.0.0",
+    "css-loader": "^7.1.2",
+    "style-loader": "^4.0.0",
+    "webpack": "^5.0.0",
+    "webpack-cli": "^5.0.0"
+  }
+}

comfy_3d_viewers-0.1.2/build_vtk_bundle/vtk_gltf_bundle.js

@@ -0,0 +1,144 @@
+/**
+ * VTK.js Bundle with GLTFImporter support
+ * This file bundles all required VTK.js modules into a single UMD file
+ */
+
+// Core rendering
+import '@kitware/vtk.js/Rendering/Profiles/Geometry';
+
+// Rendering
+import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
+import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
+import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
+import vtkActor from '@kitware/vtk.js/Rendering/Core/Actor';
+import vtkMapper from '@kitware/vtk.js/Rendering/Core/Mapper';
+import vtkTexture from '@kitware/vtk.js/Rendering/Core/Texture';
+import vtkProperty from '@kitware/vtk.js/Rendering/Core/Property';
+import vtkAnnotatedCubeActor from '@kitware/vtk.js/Rendering/Core/AnnotatedCubeActor';
+import vtkCamera from '@kitware/vtk.js/Rendering/Core/Camera';
+
+// OpenGL implementations
+import vtkOpenGLRenderWindow from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow';
+
+// Interaction
+import vtkInteractorStyleTrackballCamera from '@kitware/vtk.js/Interaction/Style/InteractorStyleTrackballCamera';
+import vtkOrientationMarkerWidget from '@kitware/vtk.js/Interaction/Widgets/OrientationMarkerWidget';
+
+// IO - Geometry readers
+import vtkSTLReader from '@kitware/vtk.js/IO/Geometry/STLReader';
+import vtkPLYReader from '@kitware/vtk.js/IO/Geometry/PLYReader';
+
+// IO - Misc readers
+import vtkOBJReader from '@kitware/vtk.js/IO/Misc/OBJReader';
+
+// IO - XML readers
+import vtkXMLPolyDataReader from '@kitware/vtk.js/IO/XML/XMLPolyDataReader';
+
+// IO - GLTF (the key addition!)
+import vtkGLTFImporter from '@kitware/vtk.js/IO/Geometry/GLTFImporter';
+const gltfAvailable = true;
+console.log('[VTK Bundle] GLTFImporter included in bundle');
+
+// Filters - Core
+import vtkPolyDataNormals from '@kitware/vtk.js/Filters/Core/PolyDataNormals';
+import vtkCutter from '@kitware/vtk.js/Filters/Core/Cutter';
+
+// Filters - General
+import vtkWindowedSincPolyDataFilter from '@kitware/vtk.js/Filters/General/WindowedSincPolyDataFilter';
+import vtkOutlineFilter from '@kitware/vtk.js/Filters/General/OutlineFilter';
+
+// Sources
+import vtkConeSource from '@kitware/vtk.js/Filters/Sources/ConeSource';
+import vtkSphereSource from '@kitware/vtk.js/Filters/Sources/SphereSource';
+import vtkCubeSource from '@kitware/vtk.js/Filters/Sources/CubeSource';
+
+// Common - DataModel
+import vtkPlane from '@kitware/vtk.js/Common/DataModel/Plane';
+
+// Color maps
+import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
+import vtkColorMaps from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction/ColorMaps';
+
+// Export everything as a global vtk object (UMD style)
+const vtk = {
+    Rendering: {
+        Core: {
+            vtkActor,
+            vtkMapper,
+            vtkTexture,
+            vtkProperty,
+            vtkAnnotatedCubeActor,
+            vtkCamera,
+            vtkRenderWindow,
+            vtkRenderWindowInteractor,
+            vtkRenderer,
+            vtkColorTransferFunction,
+        },
+        Misc: {
+            vtkFullScreenRenderWindow,
+        },
+        OpenGL: {
+            vtkRenderWindow: vtkOpenGLRenderWindow,
+        },
+    },
+    Interaction: {
+        Style: {
+            vtkInteractorStyleTrackballCamera,
+        },
+        Widgets: {
+            vtkOrientationMarkerWidget,
+        },
+    },
+    IO: {
+        Geometry: {
+            vtkSTLReader,
+            vtkPLYReader,
+            vtkGLTFImporter, // Will be null if not available
+        },
+        Misc: {
+            vtkOBJReader,
+        },
+        XML: {
+            vtkXMLPolyDataReader,
+        },
+    },
+    Filters: {
+        Core: {
+            vtkPolyDataNormals,
+            vtkCutter,
+        },
+        General: {
+            vtkWindowedSincPolyDataFilter,
+            vtkOutlineFilter,
+        },
+        Sources: {
+            vtkConeSource,
+            vtkSphereSource,
+            vtkCubeSource,
+        },
+    },
+    Common: {
+        DataModel: {
+            vtkPlane,
+        },
+    },
+    // Metadata
+    _gltfAvailable: gltfAvailable,
+};
+
+// Add vtkColorMaps as a property of vtkColorTransferFunction
+vtkColorTransferFunction.vtkColorMaps = vtkColorMaps;
+
+// Export for UMD
+if (typeof module !== 'undefined' && module.exports) {
+    module.exports = vtk;
+}
+if (typeof window !== 'undefined') {
+    window.vtk = vtk;
+}
+if (typeof global !== 'undefined') {
+    global.vtk = vtk;
+}
+
+export default vtk;

comfy_3d_viewers-0.1.2/build_vtk_bundle/webpack.config.js

@@ -0,0 +1,81 @@
+const path = require('path');
+
+// Output to comfy_3d_viewers/web/js directory (package structure)
+const OUTPUT_DIR = path.resolve(__dirname, '../comfy_3d_viewers/web/js');
+
+module.exports = [
+    // VTK.js bundle with GLTF support
+    {
+        entry: './vtk_gltf_bundle.js',
+        output: {
+            filename: 'vtk-gltf.js',
+            path: OUTPUT_DIR,
+            library: {
+                name: 'vtk',
+                type: 'umd',
+                export: 'default',
+            },
+            globalObject: 'globalThis',
+        },
+        mode: 'production',
+        resolve: {
+            extensions: ['.js'],
+        },
+        module: {
+            rules: [
+                {
+                    test: /\.js$/,
+                    exclude: /node_modules/,
+                    use: {
+                        loader: 'babel-loader',
+                        options: {
+                            presets: ['@babel/preset-env'],
+                        },
+                    },
+                },
+            ],
+        },
+        // Optimize for size
+        optimization: {
+            minimize: true,
+        },
+    },
+    // Modular viewer bundle
+    {
+        entry: path.resolve(__dirname, '../comfy_3d_viewers/web/js/viewer/index.js'),
+        output: {
+            filename: 'viewer-bundle.js',
+            path: OUTPUT_DIR,
+            library: {
+                name: 'GeomPackViewer',
+                type: 'umd',
+            },
+            globalObject: 'globalThis',
+        },
+        mode: 'production',
+        resolve: {
+            extensions: ['.js'],
+        },
+        module: {
+            rules: [
+                {
+                    test: /\.js$/,
+                    exclude: /node_modules/,
+                    use: {
+                        loader: 'babel-loader',
+                        options: {
+                            presets: ['@babel/preset-env'],
+                        },
+                    },
+                },
+                {
+                    test: /\.css$/,
+                    use: ['style-loader', 'css-loader'],
+                },
+            ],
+        },
+        optimization: {
+            minimize: true,
+        },
+    },
+];

comfy_3d_viewers-0.1.2/comfy_3d_viewers/__init__.py

@@ -0,0 +1,67 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# Copyright (C) 2025 comfy-3d-viewers Contributors
+
+"""
+comfy-3d-viewers: Reusable 3D viewer infrastructure for ComfyUI nodes.
+
+Provides VTK.js and Gaussian splatting viewers, shared utilities,
+and HTML templates for 3D mesh visualization in ComfyUI.
+"""
+
+import os
+
+__version__ = "0.1.0"
+
+
+def get_package_dir() -> str:
+    """Return the root directory of the comfy_3d_viewers package."""
+    return os.path.dirname(os.path.abspath(__file__))
+
+
+def get_web_dir() -> str:
+    """Return path to the web directory containing JS and HTML files."""
+    return os.path.join(get_package_dir(), "web")
+
+
+def get_js_dir() -> str:
+    """Return path to the JS directory containing viewer bundles."""
+    return os.path.join(get_web_dir(), "js")
+
+
+def get_html_dir() -> str:
+    """Return path to the HTML viewer templates directory."""
+    return os.path.join(get_web_dir(), "html")
+
+
+def get_utils_dir() -> str:
+    """Return path to the shared JS utilities directory."""
+    return os.path.join(get_js_dir(), "utils")
+
+
+def get_viewer_dir() -> str:
+    """Return path to the modular viewer source directory."""
+    return os.path.join(get_js_dir(), "viewer")
+
+
+def list_html_templates() -> list[str]:
+    """List all available HTML viewer templates."""
+    html_dir = get_html_dir()
+    if not os.path.exists(html_dir):
+        return []
+    return [f for f in os.listdir(html_dir) if f.endswith('.html')]
+
+
+def list_js_bundles() -> list[str]:
+    """List all available JS bundle files."""
+    js_dir = get_js_dir()
+    if not os.path.exists(js_dir):
+        return []
+    return [f for f in os.listdir(js_dir) if f.endswith('.js') and not os.path.isdir(os.path.join(js_dir, f))]
+
+
+def list_utils() -> list[str]:
+    """List all available utility modules."""
+    utils_dir = get_utils_dir()
+    if not os.path.exists(utils_dir):
+        return []
+    return [f for f in os.listdir(utils_dir) if f.endswith('.js')]