refast_vtk_js 0.1.0__tar.gz

refast_vtk_js-0.1.0/.gitignore

@@ -0,0 +1,92 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# Node.js
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Frontend build artifacts (keep the static directory but not its contents except .gitkeep)
+# Note: Built assets are not committed, they're built during install via hatch hook
+src/refast_vtk_js/static/*.js
+src/refast_vtk_js/static/*.css
+!src/refast_vtk_js/static/.gitkeep
+
+# OS files
+.DS_Store
+Thumbs.db

refast_vtk_js-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Najeem Muhammed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

refast_vtk_js-0.1.0/PKG-INFO

@@ -0,0 +1,309 @@
+Metadata-Version: 2.4
+Name: refast_vtk_js
+Version: 0.1.0
+Summary: Refast extension for vtk
+Project-URL: Homepage, https://github.com/idling-mind/refast_vtk_js
+Project-URL: Bug Tracker, https://github.com/idling-mind/refast_vtk_js/issues
+Project-URL: Documentation, https://github.com/idling-mind/refast_vtk_js#readme
+Author-email: Najeem Muhammed <najeem@gmail.com>
+License-File: LICENSE
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.11
+Requires-Dist: refast>=0.0.1
+Description-Content-Type: text/markdown
+
+# refast-vtk-js
+
+3D visualization extension for Refast powered by [react-vtk-js](https://github.com/Kitware/react-vtk-js).
+
+A [Refast](https://github.com/idling-mind/refast) extension that provides VTK.js components for interactive 3D visualization in web applications.
+
+## Features
+
+- **View Components**: `View`, `MultiViewRoot` for creating 3D scenes
+- **Representations**: `GeometryRepresentation`, `VolumeRepresentation`, `SliceRepresentation` for different visualization modes
+- **Data Components**: `PolyData`, `ImageData`, `DataArray` for defining geometry and data
+- **Algorithms**: `Algorithm`, `Reader` for data processing and file loading
+- **Interaction**: `Picking` for mouse-based selection
+- **Data Sharing**: `ShareDataSetRoot`, `RegisterDataSet`, `UseDataSet` for efficient data reuse
+
+## Installation
+
+```bash
+pip install refast-vtk-js
+```
+
+## Usage
+
+### Basic 3D Triangle
+
+```python
+from fastapi import FastAPI
+from refast import RefastApp, Context
+from refast.components import Container
+from refast_vtk_js import View, GeometryRepresentation, PolyData
+
+ui = RefastApp(title="VTK.js Demo")
+
+
+@ui.page("/")
+def home(ctx: Context):
+    return Container(
+        children=[
+            View(
+                background=[0.2, 0.3, 0.4],
+                style={"width": "100%", "height": "400px"},
+                children=[
+                    GeometryRepresentation(
+                        property={"color": [1, 0, 0]},
+                        children=[
+                            PolyData(
+                                points=[0, 0, 0, 1, 0, 0, 0.5, 1, 0],
+                                connectivity="triangles"
+                            )
+                        ]
+                    )
+                ]
+            )
+        ]
+    )
+
+
+app = FastAPI()
+app.include_router(ui.router)
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+### Using VTK Algorithms (Cone, Sphere, etc.)
+
+```python
+from refast_vtk_js import View, GeometryRepresentation, Algorithm
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        GeometryRepresentation(
+            children=[
+                Algorithm(
+                    vtk_class="vtkConeSource",
+                    state={
+                        "height": 2.0,
+                        "radius": 0.5,
+                        "resolution": 60
+                    }
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Volume Rendering
+
+```python
+from refast_vtk_js import View, VolumeRepresentation, ImageData, PointData, DataArray
+
+# Create a 10x10x10 volume with scalar data
+dimensions = [10, 10, 10]
+values = [i / 1000 for i in range(10 * 10 * 10)]  # Scalar values
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        VolumeRepresentation(
+            color_map_preset="Cool to Warm",
+            children=[
+                ImageData(
+                    dimensions=dimensions,
+                    spacing=[1, 1, 1],
+                    origin=[0, 0, 0],
+                    children=[
+                        PointData(
+                            children=[
+                                DataArray(
+                                    registration="setScalars",
+                                    values=values,
+                                    number_of_components=1
+                                )
+                            ]
+                        )
+                    ]
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Loading 3D Models from URL
+
+```python
+from refast_vtk_js import View, GeometryRepresentation, Reader
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        GeometryRepresentation(
+            children=[
+                Reader(
+                    vtk_class="vtkOBJReader",
+                    url="https://example.com/model.obj"
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Interactive Picking
+
+```python
+from refast_vtk_js import View, GeometryRepresentation, PolyData, Picking
+
+async def handle_click(ctx):
+    selection = ctx.event_data.get("selection", {})
+    world_pos = selection.get("worldPosition")
+    print(f"Clicked at world position: {world_pos}")
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        Picking(
+            on_click=ctx.callback(handle_click),
+            pointer_size=5
+        ),
+        GeometryRepresentation(
+            children=[
+                PolyData(
+                    points=[0, 0, 0, 1, 0, 0, 0.5, 1, 0],
+                    connectivity="triangles"
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Sharing Data Between Views
+
+```python
+from refast_vtk_js import (
+    ShareDataSetRoot, RegisterDataSet, UseDataSet,
+    View, GeometryRepresentation, PolyData
+)
+
+ShareDataSetRoot(
+    children=[
+        # Register the shared data
+        RegisterDataSet(
+            dataset_id="shared-mesh",
+            children=[
+                PolyData(
+                    points=[0, 0, 0, 1, 0, 0, 0.5, 1, 0],
+                    connectivity="triangles"
+                )
+            ]
+        ),
+        # First view
+        View(
+            style={"width": "50%", "height": "300px"},
+            children=[
+                GeometryRepresentation(
+                    property={"color": [1, 0, 0]},
+                    children=[UseDataSet(dataset_id="shared-mesh")]
+                )
+            ]
+        ),
+        # Second view using same data
+        View(
+            style={"width": "50%", "height": "300px"},
+            children=[
+                GeometryRepresentation(
+                    property={"color": [0, 0, 1]},
+                    children=[UseDataSet(dataset_id="shared-mesh")]
+                )
+            ]
+        )
+    ]
+)
+```
+
+## Available Components
+
+### View Components
+- `View` - Main 3D view container
+- `MultiViewRoot` - Container for multiple synchronized views
+
+### Representation Components
+- `GeometryRepresentation` - For surfaces, meshes, point clouds
+- `Geometry2DRepresentation` - For 2D overlays
+- `VolumeRepresentation` - For volume rendering
+- `SliceRepresentation` - For 2D slices of 3D data
+
+### Dataset Components
+- `PolyData` - Polygonal geometry (points, lines, triangles)
+- `ImageData` - Regular 3D grids (volumes)
+- `Dataset` - Generic VTK dataset wrapper
+
+### Data Array Components
+- `DataArray` - Attach scalar/vector data
+- `PointData` - Container for point-associated arrays
+- `CellData` - Container for cell-associated arrays
+- `FieldData` - Container for field data
+
+### Algorithm & Reader Components
+- `Algorithm` - VTK filters and sources
+- `Reader` - File readers for OBJ, STL, VTK, etc.
+
+### Interaction Components
+- `Picking` - Mouse-based selection
+- `VolumeController` - UI for volume transfer functions
+
+### Data Sharing Components
+- `ShareDataSetRoot` - Root for data sharing
+- `RegisterDataSet` - Register shared data
+- `UseDataSet` - Use registered data
+
+## Manual Registration
+
+If auto-discovery doesn't work, you can manually register the extension:
+
+```python
+from refast_vtk_js import VtkExtension
+
+ui = RefastApp(
+    title="VTK Demo",
+    extensions=[VtkExtension()]
+)
+```
+
+## Development
+
+### Building the Frontend
+
+```bash
+cd frontend
+npm install
+npm run build
+```
+
+### Watch Mode
+
+```bash
+npm run dev
+```
+
+## License
+
+MIT

refast_vtk_js-0.1.0/README.md

@@ -0,0 +1,287 @@
+# refast-vtk-js
+
+3D visualization extension for Refast powered by [react-vtk-js](https://github.com/Kitware/react-vtk-js).
+
+A [Refast](https://github.com/idling-mind/refast) extension that provides VTK.js components for interactive 3D visualization in web applications.
+
+## Features
+
+- **View Components**: `View`, `MultiViewRoot` for creating 3D scenes
+- **Representations**: `GeometryRepresentation`, `VolumeRepresentation`, `SliceRepresentation` for different visualization modes
+- **Data Components**: `PolyData`, `ImageData`, `DataArray` for defining geometry and data
+- **Algorithms**: `Algorithm`, `Reader` for data processing and file loading
+- **Interaction**: `Picking` for mouse-based selection
+- **Data Sharing**: `ShareDataSetRoot`, `RegisterDataSet`, `UseDataSet` for efficient data reuse
+
+## Installation
+
+```bash
+pip install refast-vtk-js
+```
+
+## Usage
+
+### Basic 3D Triangle
+
+```python
+from fastapi import FastAPI
+from refast import RefastApp, Context
+from refast.components import Container
+from refast_vtk_js import View, GeometryRepresentation, PolyData
+
+ui = RefastApp(title="VTK.js Demo")
+
+
+@ui.page("/")
+def home(ctx: Context):
+    return Container(
+        children=[
+            View(
+                background=[0.2, 0.3, 0.4],
+                style={"width": "100%", "height": "400px"},
+                children=[
+                    GeometryRepresentation(
+                        property={"color": [1, 0, 0]},
+                        children=[
+                            PolyData(
+                                points=[0, 0, 0, 1, 0, 0, 0.5, 1, 0],
+                                connectivity="triangles"
+                            )
+                        ]
+                    )
+                ]
+            )
+        ]
+    )
+
+
+app = FastAPI()
+app.include_router(ui.router)
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+### Using VTK Algorithms (Cone, Sphere, etc.)
+
+```python
+from refast_vtk_js import View, GeometryRepresentation, Algorithm
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        GeometryRepresentation(
+            children=[
+                Algorithm(
+                    vtk_class="vtkConeSource",
+                    state={
+                        "height": 2.0,
+                        "radius": 0.5,
+                        "resolution": 60
+                    }
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Volume Rendering
+
+```python
+from refast_vtk_js import View, VolumeRepresentation, ImageData, PointData, DataArray
+
+# Create a 10x10x10 volume with scalar data
+dimensions = [10, 10, 10]
+values = [i / 1000 for i in range(10 * 10 * 10)]  # Scalar values
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        VolumeRepresentation(
+            color_map_preset="Cool to Warm",
+            children=[
+                ImageData(
+                    dimensions=dimensions,
+                    spacing=[1, 1, 1],
+                    origin=[0, 0, 0],
+                    children=[
+                        PointData(
+                            children=[
+                                DataArray(
+                                    registration="setScalars",
+                                    values=values,
+                                    number_of_components=1
+                                )
+                            ]
+                        )
+                    ]
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Loading 3D Models from URL
+
+```python
+from refast_vtk_js import View, GeometryRepresentation, Reader
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        GeometryRepresentation(
+            children=[
+                Reader(
+                    vtk_class="vtkOBJReader",
+                    url="https://example.com/model.obj"
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Interactive Picking
+
+```python
+from refast_vtk_js import View, GeometryRepresentation, PolyData, Picking
+
+async def handle_click(ctx):
+    selection = ctx.event_data.get("selection", {})
+    world_pos = selection.get("worldPosition")
+    print(f"Clicked at world position: {world_pos}")
+
+View(
+    style={"width": "100%", "height": "400px"},
+    children=[
+        Picking(
+            on_click=ctx.callback(handle_click),
+            pointer_size=5
+        ),
+        GeometryRepresentation(
+            children=[
+                PolyData(
+                    points=[0, 0, 0, 1, 0, 0, 0.5, 1, 0],
+                    connectivity="triangles"
+                )
+            ]
+        )
+    ]
+)
+```
+
+### Sharing Data Between Views
+
+```python
+from refast_vtk_js import (
+    ShareDataSetRoot, RegisterDataSet, UseDataSet,
+    View, GeometryRepresentation, PolyData
+)
+
+ShareDataSetRoot(
+    children=[
+        # Register the shared data
+        RegisterDataSet(
+            dataset_id="shared-mesh",
+            children=[
+                PolyData(
+                    points=[0, 0, 0, 1, 0, 0, 0.5, 1, 0],
+                    connectivity="triangles"
+                )
+            ]
+        ),
+        # First view
+        View(
+            style={"width": "50%", "height": "300px"},
+            children=[
+                GeometryRepresentation(
+                    property={"color": [1, 0, 0]},
+                    children=[UseDataSet(dataset_id="shared-mesh")]
+                )
+            ]
+        ),
+        # Second view using same data
+        View(
+            style={"width": "50%", "height": "300px"},
+            children=[
+                GeometryRepresentation(
+                    property={"color": [0, 0, 1]},
+                    children=[UseDataSet(dataset_id="shared-mesh")]
+                )
+            ]
+        )
+    ]
+)
+```
+
+## Available Components
+
+### View Components
+- `View` - Main 3D view container
+- `MultiViewRoot` - Container for multiple synchronized views
+
+### Representation Components
+- `GeometryRepresentation` - For surfaces, meshes, point clouds
+- `Geometry2DRepresentation` - For 2D overlays
+- `VolumeRepresentation` - For volume rendering
+- `SliceRepresentation` - For 2D slices of 3D data
+
+### Dataset Components
+- `PolyData` - Polygonal geometry (points, lines, triangles)
+- `ImageData` - Regular 3D grids (volumes)
+- `Dataset` - Generic VTK dataset wrapper
+
+### Data Array Components
+- `DataArray` - Attach scalar/vector data
+- `PointData` - Container for point-associated arrays
+- `CellData` - Container for cell-associated arrays
+- `FieldData` - Container for field data
+
+### Algorithm & Reader Components
+- `Algorithm` - VTK filters and sources
+- `Reader` - File readers for OBJ, STL, VTK, etc.
+
+### Interaction Components
+- `Picking` - Mouse-based selection
+- `VolumeController` - UI for volume transfer functions
+
+### Data Sharing Components
+- `ShareDataSetRoot` - Root for data sharing
+- `RegisterDataSet` - Register shared data
+- `UseDataSet` - Use registered data
+
+## Manual Registration
+
+If auto-discovery doesn't work, you can manually register the extension:
+
+```python
+from refast_vtk_js import VtkExtension
+
+ui = RefastApp(
+    title="VTK Demo",
+    extensions=[VtkExtension()]
+)
+```
+
+## Development
+
+### Building the Frontend
+
+```bash
+cd frontend
+npm install
+npm run build
+```
+
+### Watch Mode
+
+```bash
+npm run dev
+```
+
+## License
+
+MIT