Deploy to GitHub pages

compas_fab/pull_390/api/compas_fab.planning.html

@@ -140,6 +140,15 @@ <h2>Actions</h2>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/compas_fab.planning.CloseGripper.html#compas_fab.planning.CloseGripper" title="compas_fab.planning.CloseGripper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CloseGripper</span></code></a></p></td>
 <td><p>Action to close the gripper.</p></td>
 </tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/compas_fab.planning.ManualWorkpieceMotion.html#compas_fab.planning.ManualWorkpieceMotion" title="compas_fab.planning.ManualWorkpieceMotion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ManualWorkpieceMotion</span></code></a></p></td>
+<td><p>Operator action to move a workpiece from one place to another.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/compas_fab.planning.HideWorkpieces.html#compas_fab.planning.HideWorkpieces" title="compas_fab.planning.HideWorkpieces"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HideWorkpieces</span></code></a></p></td>
+<td><p>Action to hide workpieces.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/compas_fab.planning.ShowWorkpieces.html#compas_fab.planning.ShowWorkpieces" title="compas_fab.planning.ShowWorkpieces"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ShowWorkpieces</span></code></a></p></td>
+<td><p>Action to show workpieces.</p></td>
+</tr>
 </tbody>
 </table>
 </section>

compas_fab/pull_390/api/generated/compas_fab.planning.CloseGripper.validate_json.html

@@ -20,7 +20,7 @@
   <link rel="stylesheet" type="text/css" href="../../_static/css/compas-reference.css" />
 
 
-  <link rel="next" title="SceneState" href="compas_fab.planning.SceneState.html" />
+  <link rel="next" title="ManualWorkpieceMotion" href="compas_fab.planning.ManualWorkpieceMotion.html" />
 
 
 
@@ -254,10 +254,10 @@ <h1>CloseGripper.validate_json</h1>
 
 
 
-      <a href="compas_fab.planning.SceneState.html" title="SceneState" class="nav-link footer-link float-end text-right d-flex w-50" rel="next">
+      <a href="compas_fab.planning.ManualWorkpieceMotion.html" title="ManualWorkpieceMotion" class="nav-link footer-link float-end text-right d-flex w-50" rel="next">
         <div class="nav-title footer-link flex-grow-1 align-self-center">
           <div class="nav-direction small font-weight-light">Next</div>
-          SceneState
+          ManualWorkpieceMotion
         </div>
         <div class="nav-button p-2 m-2"><i class="fas fa-arrow-right"></i></div>
       </a>

compas_fab/pull_390/api/generated/compas_fab.planning.RobotState.html

@@ -99,12 +99,11 @@
 <h1>RobotState</h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="compas_fab.planning.RobotState">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_fab.planning.</span></span><span class="sig-name descname"><span class="pre">RobotState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">configuration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L249"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_fab.planning.</span></span><span class="sig-name descname"><span class="pre">RobotState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">configuration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L281"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a></p>
 <p>Class for describing the state of a robot.</p>
-<p>RobotState objects are typically created by the constructor of <a class="reference internal" href="compas_fab.planning.SceneState.html#compas_fab.planning.SceneState" title="compas_fab.planning.SceneState"><code class="xref py py-class docutils literal notranslate"><span class="pre">SceneState</span></code></a>.
-However it is possible to create a RobotState object manually. For example, when specifying
-the initial state of a robot in a planning process.</p>
+<p>RobotState objects are typically created automatically by the <code class="xref py py-class docutils literal notranslate"><span class="pre">FabricationProcess</span></code>.
+However it is possible to customize the initial state of the robot by creating or modifying the RobotState manually.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Attributes</dt>
 <dd class="field-odd"><ul class="simple">

compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.html

@@ -101,7 +101,7 @@
 <h1>SceneState.get_attached_tool_id</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fab.planning.SceneState.get_attached_tool_id">
-<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_attached_tool_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_attached_tool_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L120"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Returns the id of the tool that is currently attached to the robot.
 This function assumes there is only one possible tool attached to the robot.
 If no tool is attached, <cite>None</cite> is returned.</p>

compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.html

@@ -101,7 +101,7 @@
 <h1>SceneState.get_attached_workpiece_id</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fab.planning.SceneState.get_attached_workpiece_id">
-<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_attached_workpiece_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_attached_workpiece_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Returns the id of the workpiece that is currently attached to the robot.
 This function assumes there is only one possible workpiece attached to the robot.
 If no workpiece is attached, <cite>None</cite> is returned.</p>

compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_robot_state.html

@@ -101,7 +101,7 @@
 <h1>SceneState.get_robot_state</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fab.planning.SceneState.get_robot_state">
-<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_robot_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L86"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_robot_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L87"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Returns the state of the only robot in the scene.</p>
 </dd></dl>
 

compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_tool_state.html

@@ -101,7 +101,7 @@
 <h1>SceneState.get_tool_state</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fab.planning.SceneState.get_tool_state">
-<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_tool_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tool_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L91"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_tool_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tool_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L92"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Returns the state of a tool by tool id.
 If there is only one tool in the scene, the tool id can be omitted.</p>
 <dl class="field-list simple">

compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_workpiece_state.html

@@ -101,7 +101,7 @@
 <h1>SceneState.get_workpiece_state</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fab.planning.SceneState.get_workpiece_state">
-<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_workpiece_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">workpiece_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L108"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">SceneState.</span></span><span class="sig-name descname"><span class="pre">get_workpiece_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">workpiece_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L109"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Returns the state of a workpiece by workpiece id.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.html

@@ -24,7 +24,7 @@
 
 
 
-  <link rel="prev" title="CloseGripper.validate_json" href="compas_fab.planning.CloseGripper.validate_json.html" />
+  <link rel="prev" title="ShowWorkpieces.validate_json" href="compas_fab.planning.ShowWorkpieces.validate_json.html" />
 
 
   <script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
@@ -99,7 +99,7 @@
 <h1>SceneState</h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="compas_fab.planning.SceneState">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_fab.planning.</span></span><span class="sig-name descname"><span class="pre">SceneState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">workpiece_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tool_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L19"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_fab.planning.</span></span><span class="sig-name descname"><span class="pre">SceneState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">workpiece_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tool_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_fab/blob/main/src/compas_fab/planning/state.py#L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a></p>
 <p>Container for the states of all workpieces, tools and robot in a static scene.</p>
 <p>Current implementation supports multiple workpieces and tools, but only one robot.</p>
@@ -327,11 +327,11 @@ <h1>SceneState</h1>
   <footer class="compas-footer">
     <nav class="nav p-2">
 
-      <a href="compas_fab.planning.CloseGripper.validate_json.html" title="CloseGripper.validate_json" class="nav-link footer-link float-start text-left d-flex w-50" rel="prev">
+      <a href="compas_fab.planning.ShowWorkpieces.validate_json.html" title="ShowWorkpieces.validate_json" class="nav-link footer-link float-start text-left d-flex w-50" rel="prev">
         <div class="nav-button p-2 m-2"><i class="fas fa-arrow-left"></i></div>
         <div class="nav-title flex-grow-1 align-self-center">
           <div class="nav-direction small font-weight-light">Previous</div>
-          CloseGripper.validate_json
+          ShowWorkpieces.validate_json
         </div>
       </a>