Dot primitive that echo's Rhino dot command

Author: jf---

notebooks/20_geometry.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -18,70 +18,23 @@
     "from compas.geometry import Vector\n",
     "from compas.geometry import SphericalSurface\n",
     "from compas.geometry import CylindricalSurface\n",
+    "from compas_notebook.geometry import Dot\n",
     "from compas_notebook.viewer import Viewer"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "point = Point(-1, 2, 3)\n",
-    "vector = Vector(1, 1, 2)\n",
-    "plane = Plane([0, 0, -1], [0, 0, 1])\n",
-    "frame = Frame(point, [1, 0, 0], [0, 1, 0])\n",
-    "\n",
-    "line = Line([0, 0, 0], point)\n",
-    "cloud = Pointcloud.from_bounds(x=8, y=5, z=3, n=13)\n",
-    "polyline = Polyline(cloud.points)\n",
-    "\n",
-    "# quadric curves\n",
-    "circle = Circle(radius=1.5, frame=Frame([2, 0, 0], [0, 1, 0], [0, 0, 1]))\n",
-    "ellipse = Ellipse(major=2.0, minor=1.0, frame=Frame([5, 0, 0], [0, 1, 0], [0, 0, 1]))\n",
-    "\n",
-    "# Create analytical surfaces\n",
-    "sphere_surface = SphericalSurface(radius=1.5, frame=Frame([0, 0, 0], [1, 0, 0], [0, 1, 0]))\n",
-    "cylinder_surface = CylindricalSurface(radius=0.8, frame=Frame([3, 0, 0], [1, 0, 0], [0, 1, 0]))"
-   ]
+   "source": "point = Point(-1, 2, 3)\nvector = Vector(1, 1, 2)\nplane = Plane([0, 0, -1], [0, 0, 1])\nframe = Frame(point, [1, 0, 0], [0, 1, 0])\n\nline = Line([0, 0, 0], point)\ncloud = Pointcloud.from_bounds(x=8, y=5, z=3, n=13)\npolyline = Polyline(cloud.points)\n\n# quadric curves\ncircle = Circle(radius=1.5, frame=Frame([2, 0, 0], [0, 1, 0], [0, 0, 1]))\nellipse = Ellipse(major=2.0, minor=1.0, frame=Frame([5, 0, 0], [0, 1, 0], [0, 0, 1]))\n\n# Create analytical surfaces\nsphere_surface = SphericalSurface(radius=1.5, frame=Frame([0, 0, 0], [1, 0, 0], [0, 1, 0]))\ncylinder_surface = CylindricalSurface(radius=0.8, frame=Frame([3, 0, 0], [1, 0, 0], [0, 1, 0]))\n\n# Dot: text label at a point (constant screen size)\ndot = Dot([8, 5, 3], \"Corner\")"
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "d32833ac778148c0920dfa0e9b672076",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "VBox(children=(HBox(children=(Button(icon='search-plus', layout=Layout(height='32px', width='48px'), style=But…"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "viewer = Viewer()\n",
-    "\n",
-    "viewer.scene.add(point, color=Color.red(), pointsize=0.3)\n",
-    "viewer.scene.add(line)\n",
-    "viewer.scene.add(frame)\n",
-    "viewer.scene.add(polyline, color=Color.blue())\n",
-    "viewer.scene.add(cloud, color=Color.green(), pointsize=0.3)\n",
-    "viewer.scene.add(circle, color=Color.red())\n",
-    "viewer.scene.add(ellipse, color=Color.green())\n",
-    "viewer.scene.add(vector)\n",
-    "viewer.scene.add(plane)\n",
-    "viewer.scene.add(sphere_surface, color=Color.cyan())\n",
-    "viewer.scene.add(cylinder_surface, color=Color.magenta())\n",
-    "\n",
-    "viewer.show()"
-   ]
+   "outputs": [],
+   "source": "viewer = Viewer()\n\nviewer.scene.add(point, color=Color.red(), pointsize=0.3)\nviewer.scene.add(line)\nviewer.scene.add(frame)\nviewer.scene.add(polyline, color=Color.blue())\nviewer.scene.add(cloud, color=Color.green(), pointsize=0.3)\nviewer.scene.add(circle, color=Color.red())\nviewer.scene.add(ellipse, color=Color.green())\nviewer.scene.add(vector)\nviewer.scene.add(plane)\nviewer.scene.add(sphere_surface, color=Color.cyan())\nviewer.scene.add(cylinder_surface, color=Color.magenta())\nviewer.scene.add(dot, color=Color.black())\n\nviewer.show()"
   }
  ],
  "metadata": {
@@ -105,4 +58,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

src/compas_notebook/conversions/__init__.py

@@ -3,6 +3,7 @@
 from .geometry import box_to_threejs
 from .geometry import cone_to_threejs
 from .geometry import cylinder_to_threejs
+from .geometry import dot_to_threejs
 from .geometry import line_to_threejs
 from .geometry import point_to_threejs
 from .geometry import pointcloud_to_threejs
@@ -26,6 +27,7 @@
     "color_to_threejs",
     "cone_to_threejs",
     "cylinder_to_threejs",
+    "dot_to_threejs",
     "line_to_threejs",
     "nodes_and_edges_to_threejs",
     "nodes_to_threejs",

src/compas_notebook/conversions/geometry.py

@@ -18,6 +18,7 @@
 from compas.geometry import Surface
 from compas.geometry import Torus
 from compas.geometry import Vector
+from compas_notebook.geometry import Dot
 from compas_notebook.conversions.meshes import vertices_and_edges_to_threejs
 from compas_notebook.conversions.meshes import vertices_and_faces_to_threejs
 
@@ -35,7 +36,7 @@ def line_to_threejs(line: Line) -> three.BufferGeometry:
     :class:`three.BufferGeometry`
 
     """
-    vertices = numpy.array([line.start, line.end], dtype=numpy.float64)
+    vertices = numpy.array([line.start, line.end], dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -93,7 +94,7 @@ def point_to_threejs(point: Point) -> three.SphereGeometry:
     BufferGeometry(...)
 
     """
-    vertices = numpy.array([point], dtype=numpy.float64)
+    vertices = numpy.array([point], dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -115,7 +116,7 @@ def pointcloud_to_threejs(pointcloud: Pointcloud) -> three.SphereGeometry:
     >>>
 
     """
-    vertices = numpy.array(pointcloud.points, dtype=numpy.float64)
+    vertices = numpy.array(pointcloud.points, dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -133,7 +134,7 @@ def polyline_to_threejs(polyline: Polyline) -> three.BufferGeometry:
     :class:`three.BufferGeometry`
 
     """
-    vertices = numpy.array(polyline.points, dtype=numpy.float64)
+    vertices = numpy.array(polyline.points, dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -156,7 +157,7 @@ def circle_to_threejs(circle: Circle, max_angle: float = 5.0) -> three.BufferGeo
 
     n = max(8, int(math.ceil(360.0 / max_angle)))
     polyline = circle.to_polyline(n=n)
-    vertices = numpy.array(polyline.points, dtype=numpy.float64)
+    vertices = numpy.array(polyline.points, dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -178,7 +179,7 @@ def ellipse_to_threejs(ellipse: Ellipse, max_angle: float = 5.0) -> three.Buffer
     """
     n = max(8, int(math.ceil(360.0 / max_angle)))
     polyline = ellipse.to_polyline(n=n)
-    vertices = numpy.array(polyline.points, dtype=numpy.float64)
+    vertices = numpy.array(polyline.points, dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -326,7 +327,7 @@ def curve_to_threejs(curve: Curve, resolution: int = 100) -> three.BufferGeometr
 
     """
     polyline = curve.to_polyline(n=resolution)
-    vertices = numpy.array(polyline.points, dtype=numpy.float64)
+    vertices = numpy.array(polyline.points, dtype=numpy.float32)
     geometry = three.BufferGeometry(attributes={"position": three.BufferAttribute(vertices, normalized=False)})
     return geometry
 
@@ -505,3 +506,34 @@ def torus_to_threejs(torus: Torus) -> three.TorusGeometry:
         radialSegments=64,
         tubularSegments=32,
     )
+
+
+def dot_to_threejs(dot: Dot, fontsize: int = 48, color: str = "white") -> three.Sprite:
+    """Convert a COMPAS Dot to PyThreeJS Sprite.
+
+    The sprite maintains constant screen size regardless of zoom level.
+
+    Parameters
+    ----------
+    dot : :class:`compas_notebook.geometry.Dot`
+        The dot to convert.
+    fontsize : int, optional
+        Font size for the text texture.
+    color : str, optional
+        Text color.
+
+    Returns
+    -------
+    :class:`three.Sprite`
+        A sprite with text texture positioned at the dot location.
+
+    """
+    texture = three.TextTexture(string=dot.text, size=fontsize, color=color, squareTexture=False)
+    material = three.SpriteMaterial(map=texture, sizeAttenuation=False, transparent=True)
+    sprite = three.Sprite(material=material)
+    sprite.position = [dot.point.x, dot.point.y, dot.point.z]
+    # scale based on text length - roughly 0.6 width per character
+    aspect = len(dot.text) * 0.6
+    scale = 0.025
+    sprite.scale = [scale * aspect, scale, 1]
+    return sprite

src/compas_notebook/geometry/__init__.py

@@ -0,0 +1 @@
+from .dot import Dot

src/compas_notebook/geometry/dot.py

@@ -0,0 +1,108 @@
+from compas.geometry import Geometry
+from compas.geometry import Point
+
+
+class Dot(Geometry):
+    """A dot is text displayed at a point location.
+
+    The dot maintains constant screen size regardless of zoom level,
+    similar to Rhino's Dot command.
+
+    Parameters
+    ----------
+    point : :class:`compas.geometry.Point` | list[float]
+        The location of the dot.
+    text : str
+        The text to display.
+    name : str, optional
+        The name of the dot.
+
+    Attributes
+    ----------
+    point : :class:`compas.geometry.Point`
+        The location of the dot.
+    text : str
+        The text to display.
+
+    Examples
+    --------
+    >>> from compas.geometry import Point
+    >>> from compas_notebook.geometry import Dot
+    >>> dot = Dot([0, 0, 0], "Hello")
+    >>> dot.point
+    Point(x=0.000, y=0.000, z=0.000)
+    >>> dot.text
+    'Hello'
+
+    """
+
+    DATASCHEMA = {
+        "type": "object",
+        "properties": {
+            "point": Point.DATASCHEMA,
+            "text": {"type": "string"},
+        },
+        "required": ["point", "text"],
+    }
+
+    @property
+    def __data__(self):
+        return {
+            "point": self._point.__data__,
+            "text": self._text,
+        }
+
+    @classmethod
+    def __from_data__(cls, data):
+        return cls(
+            point=Point.__from_data__(data["point"]),
+            text=data["text"],
+        )
+
+    def __init__(self, point, text, name=None):
+        super().__init__(name=name)
+        self._point = None
+        self._text = None
+        self.point = point
+        self.text = text
+
+    def __repr__(self):
+        return f"Dot({self.point!r}, {self.text!r})"
+
+    def __eq__(self, other):
+        if not isinstance(other, Dot):
+            return False
+        return self.point == other.point and self.text == other.text
+
+    @property
+    def point(self):
+        return self._point
+
+    @point.setter
+    def point(self, value):
+        if not isinstance(value, Point):
+            value = Point(*value)
+        self._point = value
+
+    @property
+    def text(self):
+        return self._text
+
+    @text.setter
+    def text(self, value):
+        self._text = str(value)
+
+    def transform(self, transformation):
+        """Transform the dot.
+
+        Parameters
+        ----------
+        transformation : :class:`compas.geometry.Transformation`
+            The transformation to apply.
+
+        Returns
+        -------
+        None
+
+        """
+        self.point.transform(transformation)

src/compas_notebook/scene/__init__.py

@@ -28,6 +28,8 @@
 from compas.geometry import Torus
 from compas.geometry import Vector
 
+from compas_notebook.geometry import Dot
+
 from compas.datastructures import Graph
 from compas.datastructures import Mesh
 
@@ -42,6 +44,7 @@
 from .coneobject import ThreeConeObject
 from .curveobject import ThreeCurveObject
 from .cylinderobject import ThreeCylinderObject
+from .dotobject import ThreeDotObject
 from .ellipseobject import ThreeEllipseObject
 from .frameobject import ThreeFrameObject
 from .groupobject import ThreeGroupObject
@@ -89,6 +92,7 @@ def register_scene_objects():
     register(Cone, ThreeConeObject, context="Notebook")
     register(Curve, ThreeCurveObject, context="Notebook")
     register(Cylinder, ThreeCylinderObject, context="Notebook")
+    register(Dot, ThreeDotObject, context="Notebook")
     register(Ellipse, ThreeEllipseObject, context="Notebook")
     register(Frame, ThreeFrameObject, context="Notebook")
     register(Graph, ThreeGraphObject, context="Notebook")

src/compas_notebook/scene/dotobject.py

@@ -0,0 +1,30 @@
+from compas.colors import Color
+from compas.scene import GeometryObject
+from compas.scene.descriptors.color import ColorAttribute
+
+from compas_notebook.conversions import dot_to_threejs
+
+from .sceneobject import ThreeSceneObject
+
+
+class ThreeDotObject(ThreeSceneObject, GeometryObject):
+    """Scene object for drawing a dot (text at a point)."""
+
+    color = ColorAttribute(default=Color.black())
+
+    def __init__(self, fontsize=256, **kwargs):
+        super().__init__(**kwargs)
+        self.fontsize = fontsize
+
+    def draw(self):
+        """Draw the dot associated with the scene object.
+
+        Returns
+        -------
+        list[three.Sprite]
+            List of pythreejs objects created.
+
+        """
+        sprite = dot_to_threejs(self.geometry, fontsize=self.fontsize, color=self.color.hex)
+        self._guids = [sprite]
+        return self.guids