Manipulator Workbench: Difference between revisions

From FreeCAD Documentation
(There was already a TOCright existing since 2011, no need to create a duplicate)
No edit summary
(25 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
[[Image:Manipulator_workbench_icon.svg|center|240px]]

<translate>
<translate>
<!--T:37-->
{{TOCright}}
{{Caption|align=center|The Manipulator External Workbench Icon}}

==Introduction== <!--T:1-->
==Introduction== <!--T:1-->

</translate>
{{TOCright}}
<translate>


<!--T:3-->
<!--T:3-->
[[File:Manipulator-ico.png]] '''Manipulator WB''' is aimed to help FreeCAD users in Aligning, Moving, Rotating and Measuring 3D objects through a friendly GUI.
[[Manipulator Workbench]] is an [[external workbenches|external workbench]] aimed to help FreeCAD users with Aligning, Moving, Rotating and Measuring 3D objects through a friendly GUI. These series of tools help to Transform the placement and Measure objects and STEP models in FreeCAD.


<!--T:4-->
==Features== <!--T:4-->
'''Features:'''


<!--T:5-->
<!--T:5-->
[[File:Aligner-ico.png]] '''Aligner:''' a set of tools to move and align 3D parts
[[File:Aligner-ico.png]] '''Aligner:''' a set of tools to move and align 3D parts; it can also align an object (face, edge, point) to the origin in FreeCAD.


<!--T:6-->
<!--T:6-->
[[File:Mover-ico.png]] '''Mover:''' a set of tools to move and rotate 3D parts on different Axis
[[File:Manipulator_Mover.svg]] '''Mover:''' a set of tools to move and rotate 3D parts on different Axis


<!--T:7-->
<!--T:7-->
[[File:Caliper-ico.png]] '''Caliper:''' a set of tools to measure 3D parts, with some Snap facility and Radius, Length, Angle measurements.
[[File:Manipulator_Caliper.svg]] '''Caliper:''' a set of tools to measure 3D parts, with some Snap facility and Radius, Length, Angle measurements.


<!--T:8-->
<!--T:8-->
Line 31: Line 36:
==References== <!--T:11-->
==References== <!--T:11-->


<!--T:12-->
* Author: Github: [https://github.com/easyw @easyw] | FreeCAD Forums: [https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=6387 easyw-fc]
* Author: Github: [https://github.com/easyw @easyw] | FreeCAD Forums: [https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=6387 easyw-fc]
* Source code on github: https://github.com/easyw/Manipulator
* Source code on github: https://github.com/easyw/Manipulator
== Tutorial == <!--T:12-->

==Tools== <!--T:13-->

<!--T:14-->
Detailed description [https://github.com/easyw/Manipulator/blob/master/README.md here]


<!--T:27-->
<!--T:27-->
Line 44: Line 44:


<!--T:28-->
<!--T:28-->
YouTube Tutorial [https://youtu.be/owGzsd1fyZc Manipulator-WB-@Work]
{{Caption|align=center|YouTube Tutorial [https://youtu.be/owGzsd1fyZc Manipulator WorkBench @Work]}}


==Tools== <!--T:13-->

<!--T:14-->
[[Image:Manipulator-WB-Tools.png]]
{{Caption|center=align|Above: Manipulator workbench dialog. For a more detailed description see [https://github.com/easyw/Manipulator/blob/master/README.md README.md] on Github.}}



=== Aligner === <!--T:15-->
=== Aligner === <!--T:15-->
</translate>
</translate>
[[Image:Manipulator-WB-Aligner.gif]]
[[Image:Manipulator-WB-Aligner.gif]]
-----
<translate>
<translate>
<!--T:38-->
{{Caption|Aligner: set of tools to move and align 3D parts; it can also align an object (face, edge, point) to the origin in FreeCAD}}

=== Mover === <!--T:16-->
=== Mover === <!--T:16-->
</translate>
</translate>
[[Image:Manipulator-WB-Mover.gif]]
[[Image:Manipulator-WB-Mover.gif]]
<translate>
<!--T:39-->
{{Caption|Mover: set of tools to move and rotate 3D parts on different Axis}}


</translate>

[[Image:Manipulator-WB-Mover-with-App_Part&Body.gif]]
[[Image:Manipulator-WB-Mover-with-App_Part&Body.gif]]
<translate>
<!--T:40-->
{{Caption|Mover: Using App:Part and Body}}


</translate>

[[Image:Manipulator-WB-Mover-with-External-Reference.gif]]
[[Image:Manipulator-WB-Mover-with-External-Reference.gif]]
-----
<translate>
<translate>
<!--T:41-->
{{Caption|Mover: with External Reference}}


=== Caliper === <!--T:17-->
=== Caliper === <!--T:17-->
</translate>
</translate>
[[Image:Manipulator-WB-Measure-Radius.gif]]
[[Image:Manipulator-WB-Measure-Radius.gif]]
<translate>
<!--T:42-->
{{Caption|Caliper: measuring Radius}}


</translate>

[[Image:Manipulator-WB-Measure-Angles.gif]]
[[Image:Manipulator-WB-Measure-Angles.gif]]
<translate>
<!--T:43-->
{{Caption|Caliper: measuring Angles}}


<!--T:44-->
[</translate>
[Image:Manipulator-WB-Dimension.gif]]
<translate>
<!--T:45-->
{{Caption|Caliper: measuring Dimensions}}


</translate>
[[Image:Manipulator-WB-Dimension.gif]]


[[Image:Manipulator-WB-Dimension-2.gif]]
[[Image:Manipulator-WB-Dimension-2.gif]]
<translate>
<!--T:46-->
{{Caption|Caliper: measuring Dimensions (cont.)}}


</translate>

[[Image:Manipulator-WB-Parallel-Planes-Distance.gif]]
[[Image:Manipulator-WB-Parallel-Planes-Distance.gif]]
-----
<translate>
<translate>
<!--T:47-->
{{Caption|Caliper: parallel planes distance}}


=== Manipulator === <!--T:18-->
=== Manipulator === <!--T:18-->

</translate>
</translate>
[[Image:Manipulator-WB-Assembly-Parts.gif]]
[[Image:Manipulator-WB-Assembly-Parts.gif]]
Line 86: Line 122:
==Installation== <!--T:19-->
==Installation== <!--T:19-->


===Automatic installation=== <!--T:20-->
===Automatic Installation=== <!--T:20-->


<!--T:21-->
<!--T:21-->
The recommended way to install the Manipulator Workbench is via the [[Image:AddonManager.svg|24px|link=Addon Manager]] [[Std_AddonMgr|Addon Manager]] under the {{MenuCommand|Tools → Addon Manager}} menu.
- automatically using the [https://github.com/FreeCAD/FreeCAD-addons FreeCAD Add-on Manager] (bundled in to 0.17 dev version under Tools Menu)


<div class="mw-collapsible mw-collapsed toccolours" style="width:600px">
===From GitHub=== <!--T:22-->
===Manual Installation=== <!--T:22-->

<!--T:48-->
If a manual install is necessary please follow the following instructions:

<!--T:49-->
<div class="mw-collapsible-content">


<!--T:23-->
<!--T:23-->
- manually by copying the Manipulator folder to the Mod sub-directory of the FreeCAD application.
* Copying the Manipulator source in to the {{FileName|Mod}} sub-directory of the FreeCAD application.


<!--T:24-->
<!--T:50-->
{{Code|code=
[https://github.com/easyw/Manipulator Manipulator github page]
cd ~/.FreeCAD/Mod
git clone https://github.com/easyw/Manipulator Manipulator
}}
* Restart FreeCAD
</translate>
</div> <!-- END of collapsible div. do not remove! -->
</div> <!-- END of collapsible div. do not remove! -->
<translate>


=== Supports === <!--T:25-->
=== Supports === <!--T:25-->
Line 105: Line 156:
* FreeCAD v0.16 >= 6712
* FreeCAD v0.16 >= 6712
* FreeCAD v0.17 >= 11707
* FreeCAD v0.17 >= 11707
* FreeCAD v0.18+
* FreeCAD v0.19+

== History == <!--T:51-->

<!--T:52-->
The workbench evolved out of the [[Macro_Center_Align_Objects_with_Faces_or_Edges|Center Align Objects with Faces or Edges]] macro

== External workbenches == <!--T:33-->

<!--T:34-->
FreeCAD workbenches are easy to program in [[Python|Python]], there are therefore many people developing additional workbenches outside of the FreeCAD main developers.

<!--T:35-->
The [[external workbenches|external workbenches]] page has some information and tutorials on some of them, and the [https://github.com/FreeCAD/FreeCAD-addons FreeCAD Addons] project aims at gathering them and making them easily installable from within FreeCAD.

<!--T:36-->
New workbenches are in development, stay tuned!


<!--T:29-->
[[Category:Addons]]
</translate>
</translate>
{{Userdocnavi{{#translation:}}}}
[[Category:Addons{{#translation:}}]]
[[Category:External Workbenches{{#translation:}}]]
{{clear}}
{{clear}}

Revision as of 15:18, 25 July 2020

The Manipulator External Workbench Icon

Introduction

Manipulator Workbench is an external workbench aimed to help FreeCAD users with Aligning, Moving, Rotating and Measuring 3D objects through a friendly GUI. These series of tools help to Transform the placement and Measure objects and STEP models in FreeCAD.

Features

Aligner: a set of tools to move and align 3D parts; it can also align an object (face, edge, point) to the origin in FreeCAD.

Mover: a set of tools to move and rotate 3D parts on different Axis

Caliper: a set of tools to measure 3D parts, with some Snap facility and Radius, Length, Angle measurements.

These helpers work with Part, App::Part and Body objects.

The Tools can be Floating or Docked Left or Right.

Each Tool has a Help Button to get some useful tips

References

Tutorial

Manipulator-WB-@Work

YouTube Tutorial Manipulator WorkBench @Work


Tools

Above: Manipulator workbench dialog. For a more detailed description see README.md on Github.


Aligner

Aligner: set of tools to move and align 3D parts; it can also align an object (face, edge, point) to the origin in FreeCAD

Mover

Mover: set of tools to move and rotate 3D parts on different Axis

Mover: Using App:Part and Body

Mover: with External Reference


Caliper

Caliper: measuring Radius

Caliper: measuring Angles

[ [Image:Manipulator-WB-Dimension.gif]]

Caliper: measuring Dimensions

Caliper: measuring Dimensions (cont.)

Caliper: parallel planes distance


Manipulator

Installation

Automatic Installation

The recommended way to install the Manipulator Workbench is via the Addon Manager under the Tools → Addon Manager menu.

Manual Installation

If a manual install is necessary please follow the following instructions:

  • Copying the Manipulator source in to the Mod sub-directory of the FreeCAD application.
cd ~/.FreeCAD/Mod 
git clone https://github.com/easyw/Manipulator Manipulator
  • Restart FreeCAD

Supports

  • FreeCAD v0.15 4671
  • FreeCAD v0.16 >= 6712
  • FreeCAD v0.17 >= 11707
  • FreeCAD v0.18+
  • FreeCAD v0.19+

History

The workbench evolved out of the Center Align Objects with Faces or Edges macro

External workbenches

FreeCAD workbenches are easy to program in Python, there are therefore many people developing additional workbenches outside of the FreeCAD main developers.

The external workbenches page has some information and tutorials on some of them, and the FreeCAD Addons project aims at gathering them and making them easily installable from within FreeCAD.

New workbenches are in development, stay tuned!