compas-threejs 1.0.1__tar.gz

compas_threejs-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 COMPAS Association
+
+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.

compas_threejs-1.0.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/compas_threejs/viewer/frontend/ *

compas_threejs-1.0.1/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: compas_threejs
+Version: 1.0.1
+Summary: A lightweight Three.js viewer for COMPAS using Protobuf
+Author-email: Eric Gozzi <eric.gozzi@arch.ethz.ch>, Nicolas Benjamin Boscoboinik <boscoboinik@arch.ethz.ch>
+License-Expression: MIT
+Project-URL: Homepage, https://compas.dev/compas_threejs
+Project-URL: Documentation, https://compas.dev/compas_threejs
+Project-URL: Repository, https://github.com/compas-dev/compas_threejs
+Project-URL: Changelog, https://github.com/compas-dev/compas_threejs/blob/main/CHANGELOG.md
+Project-URL: Forum, https://forum.compas-framework.org/
+Project-URL: Issues, https://github.com/compas-dev/compas_threejs/issues
+Keywords: compas,viewer,threejs,protobuf
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: compas
+Requires-Dist: compas-pb<2,>=1
+Requires-Dist: compas_brep[occ]
+Requires-Dist: websockets
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: bump-my-version; extra == "dev"
+Requires-Dist: invoke; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings; extra == "dev"
+Requires-Dist: mkdocstrings-python; extra == "dev"
+Requires-Dist: compas_invocations2[mkdocs]>=1.0.2; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest>=8.4.2; extra == "dev"
+Dynamic: license-file
+
+# COMPAS ThreeJS
+
+<p align="center">
+    <a href="https://pypi.org/project/compas-threejs/"><img src="https://img.shields.io/pypi/v/compas-threejs.svg" alt="PyPI version"></a>
+    <a href="https://pypi.org/project/compas-threejs/"><img src="https://img.shields.io/pypi/pyversions/compas-threejs.svg" alt="Python versions"></a>
+    <a href="https://github.com/compas-dev/compas_threejs/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License MIT"></a>
+    <a href="https://github.com/compas-dev/compas_threejs/actions"><img src="https://github.com/compas-dev/compas_threejs/actions/workflows/build.yml/badge.svg" alt="Build Status"></a>
+    <a href="https://compas.dev/compas_threejs"><img src="https://img.shields.io/badge/docs-latest-brightgreen.svg" alt="Documentation"></a>
+    <a href="https://compas.dev/mission-control/#compas_threejs"><img src="https://compas.dev/badge.svg" alt="Made with COMPAS"></a>
+</p>
+
+`compas_threejs` is a browser-based 3D viewer for COMPAS geometry. The Python
+package serves a bundled Three.js frontend and exchanges geometry, scene, and
+interaction messages through COMPAS Protobuf and WebSockets.
+
+## Installation
+
+```bash
+pip install compas_threejs
+```
+
+## Quick start
+
+```python
+from compas.geometry import Box
+from compas_threejs.viewer import App
+
+viewer = App()
+viewer.add_geometry(Box(2, 3, 1))
+viewer.start(show=True)
+```
+
+The viewer runs until interrupted with `Ctrl+C`.
+
+## Related projects
+
+- [TypeScript viewer](https://github.com/compas-dev/compas_threejs_ts)
+- [COMPAS](https://github.com/compas-dev/compas)
+- [COMPAS Protobuf](https://github.com/compas-dev/compas_pb)
+
+## License
+
+MIT, copyright COMPAS Association. See [LICENSE](LICENSE).

compas_threejs-1.0.1/README.md

@@ -0,0 +1,43 @@
+# COMPAS ThreeJS
+
+<p align="center">
+    <a href="https://pypi.org/project/compas-threejs/"><img src="https://img.shields.io/pypi/v/compas-threejs.svg" alt="PyPI version"></a>
+    <a href="https://pypi.org/project/compas-threejs/"><img src="https://img.shields.io/pypi/pyversions/compas-threejs.svg" alt="Python versions"></a>
+    <a href="https://github.com/compas-dev/compas_threejs/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License MIT"></a>
+    <a href="https://github.com/compas-dev/compas_threejs/actions"><img src="https://github.com/compas-dev/compas_threejs/actions/workflows/build.yml/badge.svg" alt="Build Status"></a>
+    <a href="https://compas.dev/compas_threejs"><img src="https://img.shields.io/badge/docs-latest-brightgreen.svg" alt="Documentation"></a>
+    <a href="https://compas.dev/mission-control/#compas_threejs"><img src="https://compas.dev/badge.svg" alt="Made with COMPAS"></a>
+</p>
+
+`compas_threejs` is a browser-based 3D viewer for COMPAS geometry. The Python
+package serves a bundled Three.js frontend and exchanges geometry, scene, and
+interaction messages through COMPAS Protobuf and WebSockets.
+
+## Installation
+
+```bash
+pip install compas_threejs
+```
+
+## Quick start
+
+```python
+from compas.geometry import Box
+from compas_threejs.viewer import App
+
+viewer = App()
+viewer.add_geometry(Box(2, 3, 1))
+viewer.start(show=True)
+```
+
+The viewer runs until interrupted with `Ctrl+C`.
+
+## Related projects
+
+- [TypeScript viewer](https://github.com/compas-dev/compas_threejs_ts)
+- [COMPAS](https://github.com/compas-dev/compas)
+- [COMPAS Protobuf](https://github.com/compas-dev/compas_pb)
+
+## License
+
+MIT, copyright COMPAS Association. See [LICENSE](LICENSE).

compas_threejs-1.0.1/pyproject.toml

@@ -0,0 +1,118 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "compas_threejs"
+dynamic = ["version"]
+description = "A lightweight Three.js viewer for COMPAS using Protobuf"
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [
+  { name = "Eric Gozzi", email = "eric.gozzi@arch.ethz.ch" },
+  { name = "Nicolas Benjamin Boscoboinik", email = "boscoboinik@arch.ethz.ch" },
+]
+keywords = ["compas", "viewer", "threejs", "protobuf"]
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Scientific/Engineering",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+    "compas",
+    "compas-pb>=1,<2",
+    "compas_brep[occ]",
+    "websockets",
+    "fastapi",
+    "uvicorn",
+    "rich",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "bump-my-version",
+    "invoke",
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings",
+    "mkdocstrings-python",
+    "compas_invocations2[mkdocs]>=1.0.2",
+    "ruff",
+    "wheel",
+    "pytest>=8.4.2",
+]
+
+[project.urls]
+Homepage = "https://compas.dev/compas_threejs"
+Documentation = "https://compas.dev/compas_threejs"
+Repository = "https://github.com/compas-dev/compas_threejs"
+Changelog = "https://github.com/compas-dev/compas_threejs/blob/main/CHANGELOG.md"
+Forum = "https://forum.compas-framework.org/"
+Issues = "https://github.com/compas-dev/compas_threejs/issues"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 179
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["I001"]
+"tasks.py" = ["I001"]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+known-first-party = ["compas_threejs"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 179
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
+[tool.bumpversion]
+current_version = "1.0.1"
+message = "Bump version to {new_version}"
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/compas_threejs/__init__.py"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.md"
+search = "Unreleased"
+replace = "[{new_version}] - {now:%Y-%m-%d}"
+
+# -- DISCOVERY --
+# Tells setuptools that the code is inside the 'src' folder
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# -- STATIC FILES --
+# Critical: Tells setuptools to look at MANIFEST.in for non-python files (html, js)
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = { attr = "compas_threejs.__version__" }

compas_threejs-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

compas_threejs-1.0.1/src/compas_threejs/__init__.py

@@ -0,0 +1,8 @@
+"""COMPAS ThreeJS - A lightweight Three.js viewer for COMPAS using Protobuf."""
+
+__version__ = "1.0.1"
+__author__ = "Eric Gozzi, Nicolas Benjamin Boscoboinik"
+__email__ = "eric.gozzi@arch.ethz.ch"
+__license__ = "MIT"
+
+__all__ = ["__version__", "__author__", "__email__", "__license__"]

compas_threejs-1.0.1/src/compas_threejs/lights/__init__.py

@@ -0,0 +1,15 @@
+from .ambientlight import AmbientLight
+from .pointlight import PointLight
+from .rectlight import RectLight
+from .sky import Sky
+from .spotlight import SpotLight
+from .sunlight import Sunlight
+
+__all__ = [
+    "PointLight",
+    "SpotLight",
+    "RectLight",
+    "Sunlight",
+    "Sky",
+    "AmbientLight",
+]

compas_threejs-1.0.1/src/compas_threejs/lights/ambientlight.py

@@ -0,0 +1,19 @@
+import uuid
+
+from compas.colors import Color
+
+
+class AmbientLight:
+    def __init__(self, color: Color = Color.white(), intensity: float = 500):
+        self.color = color
+        self.intensity = intensity
+        self.guid = str(uuid.uuid4())
+
+    def as_dict(self) -> dict:
+        return {
+            "dispatch": "light",
+            "type": "ambient_light",
+            "guid": self.guid,
+            "color": self.color.hex,
+            "intensity": self.intensity,
+        }

compas_threejs-1.0.1/src/compas_threejs/lights/light.py

@@ -0,0 +1,11 @@
+from abc import ABC
+from abc import abstractmethod
+
+
+class Light(ABC):
+    def __init__(self, **kwargs):
+        self.attributes = kwargs
+
+    @abstractmethod
+    def as_dict(self):
+        raise NotImplementedError

compas_threejs-1.0.1/src/compas_threejs/lights/pointlight.py

@@ -0,0 +1,76 @@
+from uuid import uuid4
+
+from compas.colors import Color
+from compas.geometry import Point
+
+from .light import Light
+
+
+class PointLight(Light):
+    """
+
+    Constructs a new PointLight instance.
+
+    Parameters
+    ----------
+    color : int | Color | str, optional
+        The color of the light. Can be specified as an integer, a Color object, or a string.
+        Default is 0xffffff (white).
+
+    intensity : float, optional
+        The intensity or strength of the light, measured in candela (cd).
+        Default is 1.
+
+    distance : float, optional
+        The maximum range of the light. A value of 0 indicates no limit.
+        Default is 0.
+
+    decay : float, optional
+        The rate at which the light diminishes over distance.
+        Default is 2.
+
+    """
+
+    def __init__(
+        self,
+        point: Point = Point(0, 0, 0),
+        color: Color = Color.white(),
+        intensity: float = 100,
+        distance: float = 0,
+        decay: float = 2,
+        helper: bool = False,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.point = point
+        self.color = color
+        self.intensity = intensity
+        self.distance = distance
+        self.decay = decay
+        self.helper = helper
+        self.guid = str(uuid4())
+
+    def as_dict(self) -> dict:
+        return {
+            "dispatch": "light",
+            "type": "point_light",
+            "x": self.point.x,
+            "y": self.point.y,
+            "z": self.point.z,
+            "color": self.color.hex,
+            "intensity": self.intensity,
+            "distance": self.distance,
+            "decay": self.decay,
+            "helper": self.helper,
+            "guid": self.guid,
+        }
+
+    @property
+    def color(self) -> Color:
+        return self._color
+
+    @color.setter
+    def color(self, value: Color):
+        if not isinstance(value, Color):
+            raise TypeError("color must be an instance of Color")
+        self._color = value

compas_threejs-1.0.1/src/compas_threejs/lights/rectlight.py

@@ -0,0 +1,73 @@
+import uuid
+
+from compas.colors import Color
+from compas.geometry import Point
+
+from .light import Light
+
+
+class RectLight(Light):
+    """
+    A rectangular light source.
+
+    The `RectLight` class represents a light source with a rectangular shape,
+    defined by its position, target direction, color, intensity, width, and height.
+
+    Attributes
+    ----------
+    point : :class:`compas.geometry.Point`
+        The position of the light source in 3D space. Defaults to the origin (0, 0, 0).
+    target : :class:`compas.geometry.Point`
+        The target point that the light is directed towards. Defaults to (0, -1, 0).
+    color : :class:`compas.colors.Color`
+        The color of the light. Defaults to white.
+    intensity : float
+        The intensity of the light. Defaults to 1.
+    width : float
+        The width of the rectangular light source. Defaults to 10.
+    height : float
+        The height of the rectangular light source. Defaults to 10.
+    helper : bool
+        Whether to display a helper visualization for the light. Defaults to False.
+    guid : str
+        A unique identifier for the light instance, automatically generated.
+    """
+
+    def __init__(
+        self,
+        point: Point = Point(0, 0, 0),
+        target: Point = Point(0, -1, 0),
+        color: Color = Color.white(),
+        intensity: float = 1,
+        width: float = 10,
+        height: float = 10,
+        helper: bool = False,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.point = point
+        self.target = target
+        self.color = color
+        self.intensity = intensity
+        self.width = width
+        self.height = height
+        self.helper = helper
+        self.guid = str(uuid.uuid4())
+
+    def as_dict(self) -> dict:
+        return {
+            "dispatch": "light",
+            "type": "rect_light",
+            "x": self.point.x,
+            "y": self.point.y,
+            "z": self.point.z,
+            "tx": self.target.x,
+            "ty": self.target.y,
+            "tz": self.target.z,
+            "color": self.color.hex,
+            "intensity": self.intensity,
+            "width": self.width,
+            "height": self.height,
+            "helper": self.helper,
+            "guid": self.guid,
+        }

compas_threejs-1.0.1/src/compas_threejs/lights/sky.py

@@ -0,0 +1,57 @@
+import uuid
+
+from .light import Light
+
+
+class Sky(Light):
+    """
+    The Sky class represents a type of light source that simulates the sky's appearance
+    based on various atmospheric parameters.
+
+    Attributes:
+        turbidity (float): The amount of particles in the atmosphere that scatter light.
+                           Higher values result in a hazier sky. Default is 5.
+        rayleigh (float): The scattering coefficient for Rayleigh scattering, which affects
+                          the sky's blue color intensity. Default is 0.15.
+        mie_coefficient (float): The scattering coefficient for Mie scattering, which affects
+                                 the appearance of haze and fog. Default is 0.002.
+        mie_directional_g (float): The anisotropy factor for Mie scattering, controlling the
+                                   directionality of scattered light. Default is 0.95.
+        azimuth (float): The horizontal angle of the sun in degrees, measured clockwise from
+                         the north. Default is 45.
+        elevation (float): The vertical angle of the sun in degrees, measured from the horizon.
+                           Default is 20.
+        guid (str): A unique identifier for the Sky instance, generated automatically.
+    """
+
+    def __init__(
+        self,
+        turbidity: float = 5,
+        rayleigh: float = 0.15,
+        mie_coefficient: float = 0.002,
+        mie_directional_g: float = 0.95,
+        azimuth: float = 45,
+        elevation: float = 20,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.turbidity = turbidity
+        self.rayleigh = rayleigh
+        self.mie_coefficient = mie_coefficient
+        self.mie_directional_g = mie_directional_g
+        self.azimuth = azimuth
+        self.elevation = elevation
+        self.guid = str(uuid.uuid4())
+
+    def as_dict(self) -> dict:
+        return {
+            "dispatch": "light",
+            "type": "sky",
+            "turbidity": self.turbidity,
+            "rayleigh": self.rayleigh,
+            "mie_coefficient": self.mie_coefficient,
+            "mie_directional_g": self.mie_directional_g,
+            "azimuth": self.azimuth,
+            "elevation": self.elevation,
+            "guid": self.guid,
+        }