Merge pull request #898 from compas-dev/blndr_norm

beverlylytle · web-flow · commit a26750002d03 · 2021-09-09T11:43:32.000+02:00
Blender MeshArtist
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,8 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `draw_vertexlabels`, `draw_edgelabels`, `draw_facelabels`, `draw_vertexnormals`, and `draw_facenormals` to `compas_blender.artists.MeshArtist`.
+
 ### Changed
 
+* Fixed bug in `compas_blender.draw_texts`.
+
 ### Removed
 
 
diff --git a/src/compas_blender/artists/meshartist.py b/src/compas_blender/artists/meshartist.py
@@ -3,6 +3,9 @@
 from functools import partial
 
 import compas_blender
+from compas.geometry import add_vectors
+from compas.geometry import centroid_points
+from compas.geometry import scale_vector
 
 from compas_blender.artists._artist import BaseArtist
 from compas.utilities import color_to_colordict
@@ -50,9 +53,19 @@ def __init__(self, mesh):
         self._vertexcollection = None
         self._edgecollection = None
         self._facecollection = None
+        self._vertexnormalcollection = None
+        self._facenormalcollection = None
+        self._vertexlabelcollection = None
+        self._edgelabelcollection = None
+        self._facelabelcollection = None
         self._object_vertex = {}
         self._object_edge = {}
         self._object_face = {}
+        self._object_vertexnormal = {}
+        self._object_facenormal = {}
+        self._object_vertexlabel = {}
+        self._object_edgelabel = {}
+        self._object_facelabel = {}
         self.color_vertices = (1.0, 1.0, 1.0)
         self.color_edges = (0.0, 0.0, 0.0)
         self.color_faces = (0.7, 0.7, 0.7)
@@ -88,6 +101,41 @@ def facecollection(self):
             self._facecollection = compas_blender.create_collections_from_path(path)[1]
         return self._facecollection
 
+    @property
+    def vertexnormalcollection(self):
+        path = f"{self.mesh.name}::VertexNormals"
+        if not self._vertexnormalcollection:
+            self._vertexnormalcollection = compas_blender.create_collections_from_path(path)[1]
+        return self._vertexnormalcollection
+
+    @property
+    def facenormalcollection(self):
+        path = f"{self.mesh.name}::FaceNormals"
+        if not self._facenormalcollection:
+            self._facenormalcollection = compas_blender.create_collections_from_path(path)[1]
+        return self._facenormalcollection
+
+    @property
+    def vertexlabelcollection(self):
+        path = f"{self.mesh.name}::VertexLabels"
+        if not self._vertexlabelcollection:
+            self._vertexlabelcollection = compas_blender.create_collections_from_path(path)[1]
+        return self._vertexlabelcollection
+
+    @property
+    def edgelabelcollection(self):
+        path = f"{self.mesh.name}::EdgeLabels"
+        if not self._edgelabelcollection:
+            self._edgelabelcollection = compas_blender.create_collections_from_path(path)[1]
+        return self._edgelabelcollection
+
+    @property
+    def facelabelcollection(self):
+        path = f"{self.mesh.name}::FaceLabels"
+        if not self._facelabelcollection:
+            self._facelabelcollection = compas_blender.create_collections_from_path(path)[1]
+        return self._facelabelcollection
+
     @property
     def object_vertex(self):
         """Map between Blender object objects and mesh vertex identifiers."""
@@ -115,6 +163,51 @@ def object_face(self):
     def object_face(self, values):
         self._object_face = dict(values)
 
+    @property
+    def object_vertexnormal(self):
+        """Map between Blender object objects and mesh vertex normal identifiers."""
+        return self._object_vertexnormal
+
+    @object_vertexnormal.setter
+    def object_vertexnormal(self, values):
+        self._object_vertexnormal = dict(values)
+
+    @property
+    def object_facenormal(self):
+        """Map between Blender object objects and mesh face normal identifiers."""
+        return self._object_facenormal
+
+    @object_facenormal.setter
+    def object_facenormal(self, values):
+        self._object_facenormal = dict(values)
+
+    @property
+    def object_vertexlabel(self):
+        """Map between Blender object objects and mesh vertex label identifiers."""
+        return self._object_vertexlabel
+
+    @object_vertexlabel.setter
+    def object_vertexlabel(self, values):
+        self._object_vertexlabel = dict(values)
+
+    @property
+    def object_edgelabel(self):
+        """Map between Blender object objects and mesh edge label identifiers."""
+        return self._object_edgelabel
+
+    @object_edgelabel.setter
+    def object_edgelabel(self, values):
+        self._object_edgelabel = dict(values)
+
+    @property
+    def object_facelabel(self):
+        """Map between Blender object objects and mesh face label identifiers."""
+        return self._object_facelabel
+
+    @object_facelabel.setter
+    def object_facelabel(self, values):
+        self._object_facelabel = dict(values)
+
     # ==========================================================================
     # clear
     # ==========================================================================
@@ -126,10 +219,20 @@ def clear(self):
         objects += list(self.object_vertex)
         objects += list(self.object_edge)
         objects += list(self.object_face)
+        objects += list(self.object_vertexnormal)
+        objects += list(self.object_facenormal)
+        objects += list(self.object_vertexlabel)
+        objects += list(self.object_edgelabel)
+        objects += list(self.object_facelabel)
         compas_blender.delete_objects(objects, purge_data=True)
         self._object_vertex = {}
         self._object_edge = {}
         self._object_face = {}
+        self._object_vertexnormal = {}
+        self._object_facenormal = {}
+        self._object_vertexlabel = {}
+        self._object_edgelabel = {}
+        self._object_facelabel = {}
 
     # ==========================================================================
     # components
@@ -246,3 +349,190 @@ def draw_edges(self, edges=None, color=None):
         objects = compas_blender.draw_lines(lines, self.edgecollection)
         self.object_edge = zip(objects, edges)
         return objects
+
+    # ==========================================================================
+    # draw normals
+    # ==========================================================================
+
+    def draw_vertexnormals(self, vertices=None, color=(0., 1., 0.), scale=1.0):
+        """Draw the normals at the vertices of the mesh.
+
+        Parameters
+        ----------
+        vertices : list, optional
+            A selection of vertex normals to draw.
+            Default is to draw all vertex normals.
+        color : tuple, optional
+            The color specification of the normal vectors.
+            The default color is green, ``(0., 1., 0.)``.
+        scale : float, optional
+            Scale factor for the vertex normals.
+            Default is ``1.0``.
+
+        Returns
+        -------
+        list of :class:`bpy.types.Object`
+        """
+        vertices = vertices or list(self.mesh.vertices())
+        lines = []
+        for vertex in vertices:
+            a = self.mesh.vertex_coordinates(vertex)
+            n = self.mesh.vertex_normal(vertex)
+            b = add_vectors(a, scale_vector(n, scale))
+            lines.append({
+                'start': a,
+                'end': b,
+                'color': color,
+                'name': "{}.vertexnormal.{}".format(self.mesh.name, vertex)
+            })
+        objects = compas_blender.draw_lines(lines, collection=self.vertexnormalcollection)
+        self.object_vertexnormal = zip(objects, vertices)
+        return objects
+
+    def draw_facenormals(self, faces=None, color=(0., 1., 1.), scale=1.0):
+        """Draw the normals of the faces.
+
+        Parameters
+        ----------
+        faces : list, optional
+            A selection of face normals to draw.
+            Default is to draw all face normals.
+        color : tuple, optional
+            The color specification of the normal vectors.
+            The default color is cyan, ``(0., 1., 1.)``.
+        scale : float, optional
+            Scale factor for the face normals.
+            Default is ``1.0``.
+
+        Returns
+        -------
+        list of :class:`bpy.types.Object`
+        """
+        faces = faces or list(self.mesh.faces())
+        lines = []
+        for face in faces:
+            a = centroid_points(
+                [self.mesh.vertex_coordinates(vertex) for vertex in self.mesh.face_vertices(face)]
+            )
+            n = self.mesh.face_normal(face)
+            b = add_vectors(a, scale_vector(n, scale))
+            lines.append({
+                'start': a,
+                'end': b,
+                'name': "{}.facenormal.{}".format(self.mesh.name, face),
+                'color': color
+            })
+        objects = compas_blender.draw_lines(lines, collection=self.facenormalcollection)
+        self.object_facenormal = zip(objects, faces)
+        return objects
+
+    # ==========================================================================
+    # draw labels
+    # ==========================================================================
+
+    def draw_vertexlabels(self, text=None, color=None):
+        """Draw labels for a selection vertices.
+
+        Parameters
+        ----------
+        text : dict, optional
+            A dictionary of vertex labels as vertex-text pairs.
+            The default value is ``None``, in which case every vertex will be labelled with its key.
+        color : tuple or dict of tuple, optional
+            The color specification of the labels.
+            The default color is the same as the default vertex color.
+
+        Returns
+        -------
+        list of :class:`bpy.types.Object`
+        """
+        if not text or text == 'key':
+            vertex_text = {vertex: str(vertex) for vertex in self.mesh.vertices()}
+        elif text == 'index':
+            vertex_text = {vertex: str(index) for index, vertex in enumerate(self.mesh.vertices())}
+        elif isinstance(text, dict):
+            vertex_text = text
+        else:
+            raise NotImplementedError
+        vertex_color = color or self.color_vertices
+        labels = []
+        for vertex in vertex_text:
+            labels.append({
+                'pos': self.mesh.vertex_coordinates(vertex),
+                'name': "{}.vertexlabel.{}".format(self.mesh.name, vertex),
+                'text': vertex_text[vertex]})
+        objects = compas_blender.draw_texts(labels, collection=self.vertexlabelcollection, color=vertex_color)
+        self.object_vertexlabel = zip(objects, vertex_text)
+        return objects
+
+    def draw_edgelabels(self, text=None, color=None):
+        """Draw labels for a selection of edges.
+
+        Parameters
+        ----------
+        text : dict, optional
+            A dictionary of edge labels as edge-text pairs.
+            The default value is ``None``, in which case every edge will be labelled with its key.
+        color : tuple or dict of tuple, optional
+            The color specification of the labels.
+            The default color is the same as the default color for edges.
+
+        Returns
+        -------
+        list of :class:`bpy.types.Object`
+        """
+        if text is None:
+            edge_text = {(u, v): "{}-{}".format(u, v) for u, v in self.mesh.edges()}
+        elif isinstance(text, dict):
+            edge_text = text
+        else:
+            raise NotImplementedError
+        edge_color = color or self.color_edges
+        labels = []
+        for edge in edge_text:
+            labels.append({
+                'pos': centroid_points(
+                    [self.mesh.vertex_coordinates(edge[0]), self.mesh.vertex_coordinates(edge[1])]
+                ),
+                'name': "{}.edgelabel.{}-{}".format(self.mesh.name, *edge),
+                'text': edge_text[edge]})
+        objects = compas_blender.draw_texts(labels, collection=self.edgelabelcollection, color=edge_color)
+        self.object_edgelabel = zip(objects, edge_text)
+        return objects
+
+    def draw_facelabels(self, text=None, color=None):
+        """Draw labels for a selection of faces.
+
+        Parameters
+        ----------
+        text : dict, optional
+            A dictionary of face labels as face-text pairs.
+            The default value is ``None``, in which case every face will be labelled with its key.
+        color : tuple or dict of tuple, optional
+            The color specification of the labels.
+            The default color is the same as the default face color.
+
+        Returns
+        -------
+        list of :class:`bpy.types.Object`
+        """
+        if not text or text == 'key':
+            face_text = {face: str(face) for face in self.mesh.faces()}
+        elif text == 'index':
+            face_text = {face: str(index) for index, face in enumerate(self.mesh.faces())}
+        elif isinstance(text, dict):
+            face_text = text
+        else:
+            raise NotImplementedError
+        face_color = color or self.color_faces
+        labels = []
+        for face in face_text:
+            labels.append({
+                'pos': centroid_points(
+                    [self.mesh.vertex_coordinates(vertex) for vertex in self.mesh.face_vertices(face)]
+                ),
+                'name': "{}.facelabel.{}".format(self.mesh.name, face),
+                'text': face_text[face]})
+        objects = compas_blender.draw_texts(labels, collection=self.collection, color=face_color)
+        self.object_facelabel = zip(objects, face_text)
+        return objects
diff --git a/src/compas_blender/utilities/drawing.py b/src/compas_blender/utilities/drawing.py
@@ -79,15 +79,17 @@ def _set_object_color(obj, rgb, alpha=1.0):
 
 
 def draw_texts(texts: List[Dict],
-               collection: Union[Text, bpy.types.Collection] = None) -> List[bpy.types.Object]:
+               collection: Union[Text, bpy.types.Collection] = None,
+               color: Tuple = (1.0, 1.0, 1.0)) -> List[bpy.types.Object]:
     """Draw text objects."""
     bpy.ops.object.text_add()
     empty = bpy.context.object
     _link_object(empty, collection)
-    _set_object_color(empty, [1.0, 1.0, 1.0])
+    _set_object_color(empty, color)
     objects = [0] * len(texts)
     for index, data in enumerate(texts):
         obj = empty.copy()
+        obj.data = empty.data.copy()
         obj.location = data['pos']
         obj.data.body = data['text']
         obj.scale *= data.get('size', 1)
diff --git a/src/compas_rhino/artists/meshartist.py b/src/compas_rhino/artists/meshartist.py
@@ -361,7 +361,7 @@ def draw_vertexlabels(self, text=None, color=None):
             A dictionary of vertex labels as vertex-text pairs.
             The default value is ``None``, in which case every vertex will be labelled with its key.
         color : tuple or dict of tuple, optional
-            The color sepcification of the labels.
+            The color specification of the labels.
             The default color is the same as the default vertex color.
 
         Returns
@@ -398,7 +398,7 @@ def draw_facelabels(self, text=None, color=None):
             A dictionary of face labels as face-text pairs.
             The default value is ``None``, in which case every face will be labelled with its key.
         color : tuple or dict of tuple, optional
-            The color sepcification of the labels.
+            The color specification of the labels.
             The default color is the same as the default face color.
 
         Returns
@@ -435,7 +435,7 @@ def draw_edgelabels(self, text=None, color=None):
             A dictionary of edge labels as edge-text pairs.
             The default value is ``None``, in which case every edge will be labelled with its key.
         color : tuple or dict of tuple, optional
-            The color sepcification of the labels.
+            The color specification of the labels.
             The default color is the same as the default color for edges.
 
         Returns
