Merge pull request #151 from compas-dev/bug_fixes_joris

Added sort_paths_minimum_travel_time, some bug fixes and documentation updates. Should bump to 0.4.0

Author: joburger

CHANGELOG.rst

@@ -11,14 +11,25 @@ Unreleased
 
 **Added**
 * Documentation updates
-* rdp libigl function
+* rdp libigl function (faster than the regular rdp)
+* sort_paths_minimum_travel_time: Function to sort paths by least travel time between contours in a layer
 
 **Changed**
+* Changed the blend radius to add a blend radius of 0 for the first and last point of a path
+* Changed planar_slicing_cgal to add the possibility of slicing open paths with planar_slicing_cgal
+* Added the option to toggle generation of mesh normals on/off in create_printpoints
+* Added the possibility to slice only a certain section of the geometry by using slice_height_range in the PlanarSlicer
 
 **Fixed**
+* Fixed some bugs in seams_align
+* Small bug in extruder_toggle
+* Small bug in simplify_paths_rdp_igl with printing remaining no of points
+* Bug in seams_smooth
 
 **Deprecated**
 
+* close_paths in the BaseSlicer is unused for now, as it should not be necessary
+
 **Removed**
 
 0.3.5

docs/examples/06_attributes_transfer.rst

@@ -1,8 +1,8 @@
 .. _compas_slicer_example_6:
 
-************************************
+**************************************
 Transferring attributes to PrintPoints
-************************************
+**************************************
 
 Often in 3D printing we need to transfer information from the mesh that is being sliced to the PrintPoints that
 are used in the fabrication process. We might want, for example, to print paths that are generated from different parts of

docs/installation.rst

@@ -12,7 +12,7 @@ Basic installation steps
 ========================
 
 Step 1: Install compas slicer
-------------------------------
+-----------------------------
 
 
 The recommended way to install `compas_slicer` is with `conda <https://conda.io/docs/>`_.
@@ -25,7 +25,7 @@ For example, create an environment named ``my-project`` (or replace with your ow
 
 
 Step 2: Optional installation steps
-------------------------------------
+-----------------------------------
 
 * COMPAS Viewers
 
@@ -109,7 +109,7 @@ Make sure you are in the correct environment and type:
     pip install numpy==1.19.3
 
 Fractions error
------------
+---------------
 .. code-block:: bash
 
     ImportError: cannot import name 'gcd' from 'fractions' (C:\ProgramData\Anaconda3\envs\compas_slicer\lib\fractions.py)

docs/tutorials/01_introduction.rst

@@ -4,16 +4,68 @@
 Introduction
 ****************************
 
-* General overview of the pipeline
+Overview
+========
 
-* Geometry classes organization
+The COMPAS SLICER package broadly contains four blocks of code:
 
-* Brief explanation of the organization of the remaining functionality (ex. what is pre-processing, what is post-processing ..)
+* **Geometry:** contains all geometrical entities
+* **Slicers:** provides the functionality that generates the sliced model
+* **Print organizers:** provides the functionality for embedding fabrication related information to the sliced model
+* **Visualization:** visualizes the results
 
-* Folder structure of examples
+Geometry
+--------
 
-* overview of slicers
+The geometry part of COMPAS SLICER contains all of the geometrical entities that are specific to COMPAS SLICER: 
+The ``Layer``, ``VerticalLayer``, ``Path``, and ``PrintPoint``. A ``Layer`` is essentially a single slice of the model.
+In case of planar slicing, all points on one ``Layer`` are at the same height, however, this is not the case for non-planar slicing.
+A ``VerticalLayer`` is a special method for organizing layers, in this case several ``Layers`` are grouped together to form a 
+group of layers. The ``VerticalLayer`` is only relevant in case a model consists out of multiple ``Paths``. 
+A ``Layer`` contains a list of one or mulitple ``Paths``. Multiple ``Paths`` occur when a model has multiple branches (see image). 
+Each ``Path`` is a closed or open contour and contains a list of ``compas.geometry.Point`` objects. 
+Lastly, the ``PrintPoint`` is essentially the same as the Points in the ``Path``, however, it contains additional fabrication parameters.
 
-* Reference to the 2 examples for further info
+.. figure:: intro_figures/01_layer.png
+    :figclass: figure
+    :class: figure-img img-fluid
 
-* Reference to gh visualization tutorial for further info.
+.. figure:: intro_figures/02_vert_layer.png
+    :figclass: figure
+    :class: figure-img img-fluid
+
+Slicers
+--------
+
+Different slicers are integrated into COMPAS SLICER.
+
+* **Planar slicer:** Most basic slicer, slices the model through an intersection of a plane parallel to the XY plane.
+* **Interpolation slicer:** Creates non-planar slices by interpolating between boundary curves.
+* **Scalar field slicer:** Uses a scalar field to create non-planar slices.
+* **UV slicer:** TBA.
+
+Print organizers
+----------------
+
+After the model is sliced using one of the available slicers, the toolpath can be generated using the PrintOrganizers. 
+The ``PrintOrganizer`` creates ``PrintPoint`` objects out of the ``compas.geometry.Point`` objects that are used throughout the slicing process.
+Using different functions, fabrication parameters can be added or modified to the ``PrintPoints``. Examples of this include: 
+setting the velocity, setting the blend radius, or adding safety printpoints (z-hop). 
+
+Visualization
+-------------
+
+Both the Slicer output and the PrintOrganizer output can be visualized in different ways. These are described in Tutorial 2.
+
+Folder structure
+================
+
+The functions of COMPAS SLICER are grouped into different folders:
+
+* **geometry:**
+* **parameters:** Contains functions for interacting with the parameters of the slicing and print organization process.
+* **post_processing:** Various functions that are used *after* a model is sliced, such as different methods of sorting, or adding a brim/raft.
+* **pre_processing:** Various functions that are used *before slicing a model*, such as repositioning, or various operations for curved slicing.
+* **print_organization:**
+* **slicers:** 
+* **utilities:**

docs/tutorials/intro_figures/01_layer.png

@@ -9,6 +9,7 @@
 from compas_slicer.post_processing import generate_raft
 from compas_slicer.post_processing import simplify_paths_rdp_igl
 from compas_slicer.post_processing import seams_smooth
+from compas_slicer.post_processing import seams_align
 from compas_slicer.print_organization import PlanarPrintOrganizer
 from compas_slicer.print_organization import set_extruder_toggle
 from compas_slicer.print_organization import add_safety_printpoints
@@ -45,7 +46,7 @@ def main():
     # ==========================================================================
     # Move to origin
     # ==========================================================================
-    move_mesh_to_point(compas_mesh, Point(0, 0, 0))
+    # move_mesh_to_point(compas_mesh, Point(0, 0, 0))
 
     # ==========================================================================
     # Slicing
@@ -56,6 +57,8 @@ def main():
     slicer = PlanarSlicer(compas_mesh, slicer_type="cgal", layer_height=1.5)
     slicer.slice_model()
 
+    seams_align(slicer, "next_path")
+
     # ==========================================================================
     # Generate brim / raft
     # ==========================================================================