changelog, init, example

Author: yck011522

CHANGELOG.md

@@ -25,6 +25,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Changed directory where ghuser components are installed.
 * Added ghuser components directory to those removed by the `clean` task.
 * Clean up the ghuser directory before building ghuser components.
+* Exposed function `draw_breps` in `compas_rhino.utilities`; example added.
+* Added `join` flag to function `draw_breps` in `compas_rhino.utilities`
 
 ### Removed
 
@@ -217,9 +219,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Fixed bug regarding a repeated call to `RobotModel.add_joint`.
 * Fixed bug in `compas_blender.RobotModelArtist.update`.
 * Fixed bug in `compas.datastructures.mesh_slice_plane`.
-* Fixed bug where initialising a `compas_blender.artists.Robotmodelartist` would create a new collection for each mesh and then also not put the mesh iton the created collection. 
-* Changed the initialisation of `compas_blender.artists.Robotmodelartist` to include a `collection`-parameter instead of a `layer`-parameter to be more consistent with Blender's nomenclature. 
-* Used a utility function from `compas_blender.utilities` to create the collection if none exists instead of using a new call to a bpy-method. 
+* Fixed bug where initialising a `compas_blender.artists.Robotmodelartist` would create a new collection for each mesh and then also not put the mesh iton the created collection.
+* Changed the initialisation of `compas_blender.artists.Robotmodelartist` to include a `collection`-parameter instead of a `layer`-parameter to be more consistent with Blender's nomenclature.
+* Used a utility function from `compas_blender.utilities` to create the collection if none exists instead of using a new call to a bpy-method.
 
 ### Removed
 

src/compas_rhino/utilities/__init__.py

@@ -179,6 +179,7 @@
     draw_lines,
     draw_geodesics,
     draw_polylines,
+    draw_breps,
     draw_faces,
     draw_cylinders,
     draw_pipes,
@@ -275,6 +276,7 @@
     'draw_lines',
     'draw_geodesics',
     'draw_polylines',
+    'draw_breps',
     'draw_faces',
     'draw_cylinders',
     'draw_pipes',

src/compas_rhino/utilities/drawing.py

@@ -38,7 +38,6 @@
 
 try:
     from Rhino.Geometry import MeshNgon
-    from Rhino.Geometry import Brep
 except ImportError:
     MeshNgon = False
 
@@ -73,6 +72,7 @@
     'draw_lines',
     'draw_geodesics',
     'draw_polylines',
+    'draw_breps',
     'draw_faces',
     'draw_cylinders',
     'draw_pipes',
@@ -464,6 +464,29 @@ def draw_breps(faces, srf=None, u=10, v=10, trim=True, tangency=True, spacing=0.
             Optional('layer', default=None): str,
         })
 
+    Examples
+    --------
+    Using a compas Mesh as an example:
+
+    >>> from compas.datastructures import Mesh
+    >>> from compas.geometry import Box, Frame
+    >>> from compas_rhino.utilities import draw_breps
+    >>> box = Box(Frame.worldXY(), 1.0, 2.0, 3.0)
+    >>> mesh = Mesh.from_shape(box)
+
+    Draw convert each mesh face to brep dict schema:
+
+    >>> vertices = [mesh.vertex_attributes(vertex, 'xyz') for vertex in mesh.vertices()]
+    >>> breps = []
+    >>> for face in mesh.faces():
+    >>>     face = {'points' : [vertices[vertex] for vertex in mesh.face_vertices(face)]}
+    >>>     face['points'].append(face['points'][0])
+    >>>     breps.append(face)
+
+    Draw brep faces as one joined brep.
+
+    >>> guids = draw_breps(breps, join=True)
+
     """
     breps = []
     for f in iter(faces):