diff --git a/compas_fab/pull_390/.doctrees/api/compas_fab.planning.doctree b/compas_fab/pull_390/.doctrees/api/compas_fab.planning.doctree index cda3b36eb..b61d904a7 100644 Binary files a/compas_fab/pull_390/.doctrees/api/compas_fab.planning.doctree and b/compas_fab/pull_390/.doctrees/api/compas_fab.planning.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.ToString.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.ToString.doctree new file mode 100644 index 000000000..b5e1889f4 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.ToString.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.apply_effects.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.apply_effects.doctree new file mode 100644 index 000000000..9feeb98f4 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.apply_effects.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.check_preconditions.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.check_preconditions.doctree new file mode 100644 index 000000000..971c82824 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.check_preconditions.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.copy.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.copy.doctree new file mode 100644 index 000000000..846ee1175 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.copy.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.doctree new file mode 100644 index 000000000..ff8680dc3 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_data.doctree new file mode 100644 index 000000000..661d7e375 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_json.doctree new file mode 100644 index 000000000..fca44a3ed Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_jsonstring.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_jsonstring.doctree new file mode 100644 index 000000000..04cf0b809 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.from_jsonstring.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.sha256.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.sha256.doctree new file mode 100644 index 000000000..8326704fa Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.sha256.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_data.doctree new file mode 100644 index 000000000..f7953e2fd Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_json.doctree new file mode 100644 index 000000000..2926a8115 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_jsonstring.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_jsonstring.doctree new file mode 100644 index 000000000..315cd5b62 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.to_jsonstring.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.validate_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.validate_data.doctree new file mode 100644 index 000000000..b2e5b9171 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.validate_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.validate_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.validate_json.doctree new file mode 100644 index 000000000..af19c0698 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.HideWorkpieces.validate_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.ToString.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.ToString.doctree new file mode 100644 index 000000000..669293070 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.ToString.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.apply_effects.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.apply_effects.doctree new file mode 100644 index 000000000..786ddbecb Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.apply_effects.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.check_preconditions.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.check_preconditions.doctree new file mode 100644 index 000000000..94e924b45 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.check_preconditions.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.copy.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.copy.doctree new file mode 100644 index 000000000..b96458ad1 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.copy.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.doctree new file mode 100644 index 000000000..4501af935 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_data.doctree new file mode 100644 index 000000000..2f6a1310c Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_json.doctree new file mode 100644 index 000000000..701dea303 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_jsonstring.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_jsonstring.doctree new file mode 100644 index 000000000..bdffe9cdd Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_jsonstring.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.sha256.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.sha256.doctree new file mode 100644 index 000000000..8dc25a352 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.sha256.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_data.doctree new file mode 100644 index 000000000..1470cc81d Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_json.doctree new file mode 100644 index 000000000..e67312358 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_jsonstring.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_jsonstring.doctree new file mode 100644 index 000000000..1157fe7ab Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_jsonstring.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_data.doctree new file mode 100644 index 000000000..54ee31c60 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_json.doctree new file mode 100644 index 000000000..43b8a66cb Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.RobotState.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.RobotState.doctree index c2bf10577..269342766 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.RobotState.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.RobotState.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.doctree index bf3c6e1a9..2a9fb9b0a 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.doctree index d10d49fcf..54f160e37 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.doctree index f8767d094..3487f57db 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_robot_state.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_robot_state.doctree index e2e700d6d..4b8864a37 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_robot_state.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_robot_state.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_tool_state.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_tool_state.doctree index cdb27587c..633488c6a 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_tool_state.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_tool_state.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_workpiece_state.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_workpiece_state.doctree index d021f9535..368dc843f 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_workpiece_state.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.SceneState.get_workpiece_state.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.ToString.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.ToString.doctree new file mode 100644 index 000000000..aeaff9c76 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.ToString.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.apply_effects.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.apply_effects.doctree new file mode 100644 index 000000000..91f1c9d7c Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.apply_effects.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.check_preconditions.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.check_preconditions.doctree new file mode 100644 index 000000000..08f3557c3 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.check_preconditions.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.copy.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.copy.doctree new file mode 100644 index 000000000..6ca2b8199 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.copy.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.doctree new file mode 100644 index 000000000..785dde24b Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_data.doctree new file mode 100644 index 000000000..034d2e2d2 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_json.doctree new file mode 100644 index 000000000..0652eb925 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_jsonstring.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_jsonstring.doctree new file mode 100644 index 000000000..c955cd3b1 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.from_jsonstring.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.sha256.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.sha256.doctree new file mode 100644 index 000000000..f825e6178 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.sha256.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_data.doctree new file mode 100644 index 000000000..1476465c8 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_json.doctree new file mode 100644 index 000000000..c61a82dd8 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_jsonstring.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_jsonstring.doctree new file mode 100644 index 000000000..9bbe14179 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.to_jsonstring.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.validate_data.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.validate_data.doctree new file mode 100644 index 000000000..9145f5621 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.validate_data.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.validate_json.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.validate_json.doctree new file mode 100644 index 000000000..c90bcab36 Binary files /dev/null and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ShowWorkpieces.validate_json.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ToolState.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ToolState.doctree index 1a636db27..9a6d7ea65 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ToolState.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.ToolState.doctree differ diff --git a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.WorkpieceState.doctree b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.WorkpieceState.doctree index 8cbafc2d2..7264cae11 100644 Binary files a/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.WorkpieceState.doctree and b/compas_fab/pull_390/.doctrees/api/generated/compas_fab.planning.WorkpieceState.doctree differ diff --git a/compas_fab/pull_390/.doctrees/changelog.doctree b/compas_fab/pull_390/.doctrees/changelog.doctree index bbc74b1b1..e7d707b40 100644 Binary files a/compas_fab/pull_390/.doctrees/changelog.doctree and b/compas_fab/pull_390/.doctrees/changelog.doctree differ diff --git a/compas_fab/pull_390/.doctrees/environment.pickle b/compas_fab/pull_390/.doctrees/environment.pickle index a97d11c11..dc3a148db 100644 Binary files a/compas_fab/pull_390/.doctrees/environment.pickle and b/compas_fab/pull_390/.doctrees/environment.pickle differ diff --git a/compas_fab/pull_390/api/compas_fab.planning.html b/compas_fab/pull_390/api/compas_fab.planning.html index 411aa6e7c..19740bde0 100644 --- a/compas_fab/pull_390/api/compas_fab.planning.html +++ b/compas_fab/pull_390/api/compas_fab.planning.html @@ -140,6 +140,15 @@

Actions

CloseGripper

Action to close the gripper.

+

ManualWorkpieceMotion

+

Operator action to move a workpiece from one place to another.

+ +

HideWorkpieces

+

Action to hide workpieces.

+ +

ShowWorkpieces

+

Action to show workpieces.

+ diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.CloseGripper.validate_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.CloseGripper.validate_json.html index 54f97273e..4055e6781 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.CloseGripper.validate_json.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.CloseGripper.validate_json.html @@ -20,7 +20,7 @@ - + @@ -254,10 +254,10 @@

CloseGripper.validate_json

- diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.ToString.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.ToString.html new file mode 100644 index 000000000..27e892516 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.ToString.html @@ -0,0 +1,383 @@ + + + + + + compas_fab - HideWorkpieces.ToString + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.ToString

+
+
+HideWorkpieces.ToString()[source]
+

Converts the instance to a string.

+

This method exists for .NET compatibility. When using IronPython, +the implicit string conversion that usually takes place in CPython +will not kick-in, and in its place, IronPython will default to +printing self.GetType().FullName or similar. Overriding the ToString +method of .NET object class fixes that and makes Rhino/Grasshopper +display proper string representations when the objects are printed or +connected to a panel or other type of string output.

+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.apply_effects.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.apply_effects.html new file mode 100644 index 000000000..16c0cd41d --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.apply_effects.html @@ -0,0 +1,382 @@ + + + + + + compas_fab - HideWorkpieces.apply_effects + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.apply_effects

+
+
+HideWorkpieces.apply_effects(scene_state, debug=False)[source]
+

Applies the action to a scene state.

+

The SceneState is modified in place with the effect of the Action.

+
+
Parameters
+

scene_state (compas_fab.planning.SceneState) – The scene state to apply the action to.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.check_preconditions.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.check_preconditions.html new file mode 100644 index 000000000..fe11ef42f --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.check_preconditions.html @@ -0,0 +1,391 @@ + + + + + + compas_fab - HideWorkpieces.check_preconditions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.check_preconditions

+
+
+HideWorkpieces.check_preconditions(scene_state)[source]
+

Checks if the action can be applied to a scene state.

+

All the workpiece_ids must be: +- in the scene +- not hidden +- not attached to the robot

+

This function does not change the scene state.

+
+
Parameters
+

scene_state (compas_fab.planning.SceneState) – The scene state to apply the action to.

+
+
Returns
+

Tuple(bool, str) – A tuple of a boolean and a string. +The boolean indicates if the action can be applied to the scene state. +The string is a human readable message that describes the reason for failure.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.copy.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.copy.html new file mode 100644 index 000000000..65bd048e3 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.copy.html @@ -0,0 +1,385 @@ + + + + + + compas_fab - HideWorkpieces.copy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.copy

+
+
+HideWorkpieces.copy(cls=None)[source]
+

Make an independent copy of the data object.

+
+
Parameters
+

cls (Type[Data], optional) – The type of data object to return. +Defaults to the type of the current data object.

+
+
Returns
+

Data – An independent copy of this object.

+
+
+
+ +
+ + +
+ + + + + +
+ + + +
+ +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_data.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_data.html new file mode 100644 index 000000000..4874fe209 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_data.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - HideWorkpieces.from_data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.from_data

+
+
+classmethod HideWorkpieces.from_data(data)
+

Construct an object of this type from the provided data.

+
+
Parameters
+

data (dict) – The data dictionary.

+
+
Returns
+

Data – An instance of this object type if the data contained in the dict has the correct schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_json.html new file mode 100644 index 000000000..014dbbfae --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_json.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - HideWorkpieces.from_json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.from_json

+
+
+classmethod HideWorkpieces.from_json(filepath)
+

Construct an object from serialized data contained in a JSON file.

+
+
Parameters
+

filepath (path string | file-like object | URL string) – The path, file or URL to the file for serialization.

+
+
Returns
+

Data – An instance of this object type if the data contained in the JSON file has the correct schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_jsonstring.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_jsonstring.html new file mode 100644 index 000000000..c29ba3bdd --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.from_jsonstring.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - HideWorkpieces.from_jsonstring + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.from_jsonstring

+
+
+classmethod HideWorkpieces.from_jsonstring(string)
+

Construct an object from serialized data contained in a JSON string.

+
+
Parameters
+

string (str) – The object as a JSON string.

+
+
Returns
+

Data – An instance of this object type if the data contained in the JSON file has the correct schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.html new file mode 100644 index 000000000..8dad09341 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.html @@ -0,0 +1,441 @@ + + + + + + compas_fab - HideWorkpieces + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces

+
+
+class compas_fab.planning.HideWorkpieces(workpiece_ids=[])[source]
+

Bases: Action

+

Action to hide workpieces. Can be used to model objects that are removed the scene.

+

This changes the WorkpieceState.is_hidden property. +Can also be used to model the manual detachment of scaffolding (modeled as a Workpiece)

+
+
Attributes
+

workpiece_ids (list(str)) – List of workpiece ids to be hidden.

+
+
+

Methods

+ ++++ + + + + + + + + +

apply_effects

Applies the action to a scene state.

check_preconditions

Checks if the action can be applied to a scene state.

+

Inherited Methods

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

from_data

Construct an object of this type from the provided data.

from_json

Construct an object from serialized data contained in a JSON file.

from_jsonstring

Construct an object from serialized data contained in a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_data

Convert an object to its native data representation.

to_json

Serialize the data representation of an object to a JSON file.

to_jsonstring

Serialize the data representation of an object to a JSON string.

validate_data

Validate the object's data against its data schema.

validate_json

Validate the object's data against its json schema.

+
+ +
+ + +
+ + + + + +
+ + + +
+ +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.sha256.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.sha256.html new file mode 100644 index 000000000..d2306ea2f --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.sha256.html @@ -0,0 +1,397 @@ + + + + + + compas_fab - HideWorkpieces.sha256 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.sha256

+
+
+HideWorkpieces.sha256(as_string=False)[source]
+

Compute a hash of the data for comparison during version control using the sha256 algorithm.

+
+
Parameters
+

as_string (bool, optional) – If True, return the digest in hexadecimal format rather than as bytes.

+
+
Returns
+

bytes | str

+
+
+

Examples

+
>>> from compas.datastructures import Mesh
+>>> mesh = Mesh.from_obj(compas.get('faces.obj'))
+>>> v1 = mesh.sha256()
+>>> v2 = mesh.sha256()
+>>> mesh.vertex_attribute(mesh.vertex_sample(1)[0], 'z', 1)
+>>> v3 = mesh.sha256()
+>>> v1 == v2
+True
+>>> v2 == v3
+False
+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_data.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_data.html new file mode 100644 index 000000000..97982cc2a --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_data.html @@ -0,0 +1,381 @@ + + + + + + compas_fab - HideWorkpieces.to_data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.to_data

+
+
+HideWorkpieces.to_data()[source]
+

Convert an object to its native data representation.

+
+
Returns
+

dict – The data representation of the object as described by the schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_json.html new file mode 100644 index 000000000..f7034319b --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_json.html @@ -0,0 +1,387 @@ + + + + + + compas_fab - HideWorkpieces.to_json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.to_json

+
+
+HideWorkpieces.to_json(filepath, pretty=False)[source]
+

Serialize the data representation of an object to a JSON file.

+
+
Parameters
+
    +
  • filepath (path string or file-like object) – The path or file-like object to the file containing the data.

  • +
  • pretty (bool, optional) – If True, serialize to a “pretty”, human-readable representation.

  • +
+
+
Returns
+

None

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_jsonstring.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_jsonstring.html new file mode 100644 index 000000000..326ac4fcc --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.to_jsonstring.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - HideWorkpieces.to_jsonstring + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.to_jsonstring

+
+
+HideWorkpieces.to_jsonstring(pretty=False)[source]
+

Serialize the data representation of an object to a JSON string.

+
+
Parameters
+

pretty (bool, optional) – If True serialize a pretty representation of the data.

+
+
Returns
+

str – The object’s data dict in JSON string format.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.validate_data.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.validate_data.html new file mode 100644 index 000000000..545cb2c47 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.validate_data.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - HideWorkpieces.validate_data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.validate_data

+
+
+HideWorkpieces.validate_data()[source]
+

Validate the object’s data against its data schema.

+
+
Returns
+

dict – The validated data.

+
+
Raises
+

schema.SchemaError

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.validate_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.validate_json.html new file mode 100644 index 000000000..69db557af --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.HideWorkpieces.validate_json.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - HideWorkpieces.validate_json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

HideWorkpieces.validate_json

+
+
+HideWorkpieces.validate_json()[source]
+

Validate the object’s data against its json schema.

+
+
Returns
+

str – The validated JSON representation of the data.

+
+
Raises
+

jsonschema.exceptions.ValidationError

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.ToString.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.ToString.html new file mode 100644 index 000000000..87c40794d --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.ToString.html @@ -0,0 +1,383 @@ + + + + + + compas_fab - ManualWorkpieceMotion.ToString + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.ToString

+
+
+ManualWorkpieceMotion.ToString()[source]
+

Converts the instance to a string.

+

This method exists for .NET compatibility. When using IronPython, +the implicit string conversion that usually takes place in CPython +will not kick-in, and in its place, IronPython will default to +printing self.GetType().FullName or similar. Overriding the ToString +method of .NET object class fixes that and makes Rhino/Grasshopper +display proper string representations when the objects are printed or +connected to a panel or other type of string output.

+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.apply_effects.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.apply_effects.html new file mode 100644 index 000000000..f588ae406 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.apply_effects.html @@ -0,0 +1,382 @@ + + + + + + compas_fab - ManualWorkpieceMotion.apply_effects + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.apply_effects

+
+
+ManualWorkpieceMotion.apply_effects(scene_state, debug=False)[source]
+

Applies the action to a scene state.

+

The SceneState is modified in place with the effect of the Action.

+
+
Parameters
+

scene_state (compas_fab.planning.SceneState) – The scene state to apply the action to.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.check_preconditions.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.check_preconditions.html new file mode 100644 index 000000000..ecb26fd67 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.check_preconditions.html @@ -0,0 +1,387 @@ + + + + + + compas_fab - ManualWorkpieceMotion.check_preconditions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.check_preconditions

+
+
+ManualWorkpieceMotion.check_preconditions(scene_state)[source]
+

Checks if the action can be applied to a scene state.

+

This function does not change the scene state.

+
+
Parameters
+

scene_state (compas_fab.planning.SceneState) – The scene state to apply the action to.

+
+
Returns
+

Tuple(bool, str) – A tuple of a boolean and a string. +The boolean indicates if the action can be applied to the scene state. +The string is a human readable message that describes the reason for failure.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.copy.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.copy.html new file mode 100644 index 000000000..f7ddd452d --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.copy.html @@ -0,0 +1,385 @@ + + + + + + compas_fab - ManualWorkpieceMotion.copy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.copy

+
+
+ManualWorkpieceMotion.copy(cls=None)[source]
+

Make an independent copy of the data object.

+
+
Parameters
+

cls (Type[Data], optional) – The type of data object to return. +Defaults to the type of the current data object.

+
+
Returns
+

Data – An independent copy of this object.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_data.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_data.html new file mode 100644 index 000000000..c9aa403e8 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_data.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - ManualWorkpieceMotion.from_data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.from_data

+
+
+classmethod ManualWorkpieceMotion.from_data(data)
+

Construct an object of this type from the provided data.

+
+
Parameters
+

data (dict) – The data dictionary.

+
+
Returns
+

Data – An instance of this object type if the data contained in the dict has the correct schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_json.html new file mode 100644 index 000000000..31cbf3a4b --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_json.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - ManualWorkpieceMotion.from_json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.from_json

+
+
+classmethod ManualWorkpieceMotion.from_json(filepath)
+

Construct an object from serialized data contained in a JSON file.

+
+
Parameters
+

filepath (path string | file-like object | URL string) – The path, file or URL to the file for serialization.

+
+
Returns
+

Data – An instance of this object type if the data contained in the JSON file has the correct schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_jsonstring.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_jsonstring.html new file mode 100644 index 000000000..39b6d1cf0 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.from_jsonstring.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - ManualWorkpieceMotion.from_jsonstring + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.from_jsonstring

+
+
+classmethod ManualWorkpieceMotion.from_jsonstring(string)
+

Construct an object from serialized data contained in a JSON string.

+
+
Parameters
+

string (str) – The object as a JSON string.

+
+
Returns
+

Data – An instance of this object type if the data contained in the JSON file has the correct schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.html new file mode 100644 index 000000000..5602596d1 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.html @@ -0,0 +1,446 @@ + + + + + + compas_fab - ManualWorkpieceMotion + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion

+
+
+class compas_fab.planning.ManualWorkpieceMotion(workpiece_id=None, frame=Frame(Point(0.000, 0.000, 0.000), Vector(1.000, 0.000, 0.000), Vector(0.000, 1.000, 0.000)))[source]
+

Bases: Action

+

Operator action to move a workpiece from one place to another. +This moves the workpiece to a specific frame. +Typically used for loading a workpiece into a gripper. +Can also be used to model the manual attachment of scaffolding (modeled as a Workpiece)

+
+
Attributes
+
    +
  • workpiece_id (str) – The id of the workpiece to be moved.

  • +
  • frame (compas.geometry.Frame) – The frame of the workpiece at the target location. +Specified in world coordinate frame.

  • +
+
+
+

Methods

+ ++++ + + + + + + + + +

apply_effects

Applies the action to a scene state.

check_preconditions

Checks if the action can be applied to a scene state.

+

Inherited Methods

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

from_data

Construct an object of this type from the provided data.

from_json

Construct an object from serialized data contained in a JSON file.

from_jsonstring

Construct an object from serialized data contained in a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_data

Convert an object to its native data representation.

to_json

Serialize the data representation of an object to a JSON file.

to_jsonstring

Serialize the data representation of an object to a JSON string.

validate_data

Validate the object's data against its data schema.

validate_json

Validate the object's data against its json schema.

+
+ +
+ + +
+ + + + + +
+ + + +
+ +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.sha256.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.sha256.html new file mode 100644 index 000000000..fb64c87d3 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.sha256.html @@ -0,0 +1,397 @@ + + + + + + compas_fab - ManualWorkpieceMotion.sha256 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.sha256

+
+
+ManualWorkpieceMotion.sha256(as_string=False)[source]
+

Compute a hash of the data for comparison during version control using the sha256 algorithm.

+
+
Parameters
+

as_string (bool, optional) – If True, return the digest in hexadecimal format rather than as bytes.

+
+
Returns
+

bytes | str

+
+
+

Examples

+
>>> from compas.datastructures import Mesh
+>>> mesh = Mesh.from_obj(compas.get('faces.obj'))
+>>> v1 = mesh.sha256()
+>>> v2 = mesh.sha256()
+>>> mesh.vertex_attribute(mesh.vertex_sample(1)[0], 'z', 1)
+>>> v3 = mesh.sha256()
+>>> v1 == v2
+True
+>>> v2 == v3
+False
+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_data.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_data.html new file mode 100644 index 000000000..d08f6f3a3 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_data.html @@ -0,0 +1,381 @@ + + + + + + compas_fab - ManualWorkpieceMotion.to_data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.to_data

+
+
+ManualWorkpieceMotion.to_data()[source]
+

Convert an object to its native data representation.

+
+
Returns
+

dict – The data representation of the object as described by the schema.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_json.html new file mode 100644 index 000000000..4a4ab80c6 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_json.html @@ -0,0 +1,387 @@ + + + + + + compas_fab - ManualWorkpieceMotion.to_json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.to_json

+
+
+ManualWorkpieceMotion.to_json(filepath, pretty=False)[source]
+

Serialize the data representation of an object to a JSON file.

+
+
Parameters
+
    +
  • filepath (path string or file-like object) – The path or file-like object to the file containing the data.

  • +
  • pretty (bool, optional) – If True, serialize to a “pretty”, human-readable representation.

  • +
+
+
Returns
+

None

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_jsonstring.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_jsonstring.html new file mode 100644 index 000000000..44c6a7b04 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.to_jsonstring.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - ManualWorkpieceMotion.to_jsonstring + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.to_jsonstring

+
+
+ManualWorkpieceMotion.to_jsonstring(pretty=False)[source]
+

Serialize the data representation of an object to a JSON string.

+
+
Parameters
+

pretty (bool, optional) – If True serialize a pretty representation of the data.

+
+
Returns
+

str – The object’s data dict in JSON string format.

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_data.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_data.html new file mode 100644 index 000000000..8e9d50eee --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_data.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - ManualWorkpieceMotion.validate_data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.validate_data

+
+
+ManualWorkpieceMotion.validate_data()[source]
+

Validate the object’s data against its data schema.

+
+
Returns
+

dict – The validated data.

+
+
Raises
+

schema.SchemaError

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_json.html b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_json.html new file mode 100644 index 000000000..10a8a2e62 --- /dev/null +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.ManualWorkpieceMotion.validate_json.html @@ -0,0 +1,384 @@ + + + + + + compas_fab - ManualWorkpieceMotion.validate_json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ + + + + + +
+

ManualWorkpieceMotion.validate_json

+
+
+ManualWorkpieceMotion.validate_json()[source]
+

Validate the object’s data against its json schema.

+
+
Returns
+

str – The validated JSON representation of the data.

+
+
Raises
+

jsonschema.exceptions.ValidationError

+
+
+
+ +
+ + +
+ + + + + + + +
+
+ + + + + +
+
+
+
+

COMPAS

+

+ A computational framework for collaboration and research + in Architecture, Engineering, Fabrication, and Construction. +

+ +
+
+
+
+

Copyright © 2017-2021 compas-dev

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.RobotState.html b/compas_fab/pull_390/api/generated/compas_fab.planning.RobotState.html index 5caf49687..f6f04c96c 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.RobotState.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.RobotState.html @@ -99,12 +99,11 @@

RobotState

-class compas_fab.planning.RobotState(frame=None, configuration=None)[source]
+class compas_fab.planning.RobotState(frame=None, configuration=None)[source]

Bases: Data

Class for describing the state of a robot.

-

RobotState objects are typically created by the constructor of SceneState. -However it is possible to create a RobotState object manually. For example, when specifying -the initial state of a robot in a planning process.

+

RobotState objects are typically created automatically by the FabricationProcess. +However it is possible to customize the initial state of the robot by creating or modifying the RobotState manually.

Attributes
    diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.html b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.html index 1d4aa38e3..1c6612938 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_tool_id.html @@ -101,7 +101,7 @@

    SceneState.get_attached_tool_id

    -SceneState.get_attached_tool_id()[source]
    +SceneState.get_attached_tool_id()[source]

    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, None is returned.

    diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.html b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.html index 5a4659b1b..98999573a 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_attached_workpiece_id.html @@ -101,7 +101,7 @@

    SceneState.get_attached_workpiece_id

    -SceneState.get_attached_workpiece_id()[source]
    +SceneState.get_attached_workpiece_id()[source]

    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, None is returned.

    diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_robot_state.html b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_robot_state.html index 2aab65869..7fae10263 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_robot_state.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_robot_state.html @@ -101,7 +101,7 @@

    SceneState.get_robot_state

    -SceneState.get_robot_state()[source]
    +SceneState.get_robot_state()[source]

    Returns the state of the only robot in the scene.

    diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_tool_state.html b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_tool_state.html index fe6288289..9aa633ae0 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_tool_state.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_tool_state.html @@ -101,7 +101,7 @@

    SceneState.get_tool_state

    -SceneState.get_tool_state(tool_id=None)[source]
    +SceneState.get_tool_state(tool_id=None)[source]

    Returns the state of a tool by tool id. If there is only one tool in the scene, the tool id can be omitted.

    diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_workpiece_state.html b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_workpiece_state.html index b65af9db4..2acefff3c 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_workpiece_state.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.get_workpiece_state.html @@ -101,7 +101,7 @@

    SceneState.get_workpiece_state

    -SceneState.get_workpiece_state(workpiece_id)[source]
    +SceneState.get_workpiece_state(workpiece_id)[source]

    Returns the state of a workpiece by workpiece id.

    Parameters
    diff --git a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.html b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.html index e54316a8d..24950203f 100644 --- a/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.html +++ b/compas_fab/pull_390/api/generated/compas_fab.planning.SceneState.html @@ -24,7 +24,7 @@ - + @@ -99,7 +99,7 @@

    SceneState

    -class compas_fab.planning.SceneState(workpiece_ids=[], tool_ids=[])[source]
    +class compas_fab.planning.SceneState(workpiece_ids=[], tool_ids=[])[source]

    Bases: Data

    Container for the states of all workpieces, tools and robot in a static scene.

    Current implementation supports multiple workpieces and tools, but only one robot.

    @@ -327,11 +327,11 @@

    SceneState