Part Module: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(Part_Attachment -> Part_EditAttachment)
(14 intermediate revisions by 7 users not shown)
Line 4: Line 4:
<!--T:52-->
<!--T:52-->
{{Docnav
{{Docnav
|[[OpenSCAD_Module|OpenSCAD Module]]
|[[OpenSCAD_Workbench|OpenSCAD Workbench]]
|[[PartDesign_Workbench|PartDesign Workbench]]
|[[PartDesign_Workbench|PartDesign Workbench]]
|IconL=Workbench_OpenSCAD.svg
|IconL=Workbench_OpenSCAD.svg
Line 17: Line 17:
<translate>
<translate>


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


<!--T:1-->
<!--T:1-->
The solid modelling capabilities of FreeCAD are based on the [[OpenCASCADE|OpenCASCADE Technology]] (OCCT) kernel, a professional-grade CAD system that features advanced 3D geometry creation and manipulation. The [[Image:Workbench_Part.svg|24px]] [[Part_Workbench|Part Workbench]] is a layer sitting on top of the OCCT libraries, that gives the user access to OCCT geometric primitives and functions. Essentially all 2D and 3D drawing functions in every workbench ([[Image:Workbench_Draft.svg|24px]] [[Draft_Workbench|Draft]], [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|Sketcher]], [[Image:Workbench_PartDesign.svg|24px]] [[PartDesign_Workbench|PartDesign]], etc.), are based on these functions exposed by the Part Workbench. Therefore, the Part Workbench is considered the core component of the modelling capabilities of FreeCAD.
The solid modelling capabilities of FreeCAD are based on the [[OpenCASCADE|OpenCASCADE Technology]] (OCCT) kernel, a professional-grade CAD system that features advanced 3D geometry creation and manipulation. The [[Image:Workbench_Part.svg|24px]] [[Part_Workbench|Part Workbench]] is a layer sitting on top of the OCCT libraries, that gives the user access to OCCT geometric primitives and functions. Essentially all 2D and 3D drawing functions in every workbench ([[Image:Workbench_Draft.svg|24px]] [[Draft_Workbench|Draft]], [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|Sketcher]], [[Image:Workbench_PartDesign.svg|24px]] [[PartDesign_Workbench|PartDesign]], etc.), are based on these functions exposed by the Part Workbench. Therefore, the Part Workbench is considered the core component of the modelling capabilities of FreeCAD.

<!--T:118-->
A more detailed discussion of Part workbench versus Part Design workbench can be found here: [[Part_and_PartDesign|Part and Part Design]].


<!--T:35-->
<!--T:35-->
Line 48: Line 51:
* [[Image:Part_Box.svg|32px]] [[Part_Box|Box]]: Creates a box.
* [[Image:Part_Box.svg|32px]] [[Part_Box|Box]]: Creates a box.


<!--T:84-->
* [[Image:Part_Cylinder.svg|32px]] [[Part_Cylinder|Cylinder]]: Creates a cylinder.
* [[Image:Part_Cylinder.svg|32px]] [[Part_Cylinder|Cylinder]]: Creates a cylinder.


<!--T:85-->
* [[Image:Part_Sphere.svg|32px]] [[Part_Sphere|Sphere]]: Creates a sphere.
* [[Image:Part_Sphere.svg|32px]] [[Part_Sphere|Sphere]]: Creates a sphere.


<!--T:86-->
* [[Image:Part_Cone.svg|32px]] [[Part_Cone|Cone]]: Creates a cone.
* [[Image:Part_Cone.svg|32px]] [[Part_Cone|Cone]]: Creates a cone.


<!--T:87-->
* [[Image:Part_Torus.svg|32px]] [[Part_Torus|Torus]]: Creates a torus (ring).
* [[Image:Part_Torus.svg|32px]] [[Part_Torus|Torus]]: Creates a torus (ring).


<!--T:88-->
* [[File:Part_Tube.svg|32px]] [[Part_Tube|Tube]]: Creates a tube. {{Version|0.19}}
* [[File:Part_Tube.svg|32px]] [[Part_Tube|Tube]]: Creates a tube. {{Version|0.19}}


<!--T:89-->
* [[Image:Part_Primitives.svg|32px]] [[Part_Primitives|Primitives]]: A tool to create one of the following primitives:
* [[Image:Part_Primitives.svg|32px]] [[Part_Primitives|Primitives]]: A tool to create one of the following primitives:
**[[Image:Part_Plane.svg|32px]] [[Part_Plane|Plane]]: Creates a plane.
**[[Image:Part_Plane.svg|32px]] [[Part_Plane|Plane]]: Creates a plane.
Line 76: Line 85:
**[[Image:Part_RegularPolygon.svg|32px]] [[Part_RegularPolygon|Regular Polygon]]: Creates a regular polygon.
**[[Image:Part_RegularPolygon.svg|32px]] [[Part_RegularPolygon|Regular Polygon]]: Creates a regular polygon.


<!--T:90-->
* [[Image:Part_Builder.svg|32px]] [[Part_Builder|Builder]]: Creates shapes from various primitives.
* [[Image:Part_Builder.svg|32px]] [[Part_Builder|Builder]]: Creates shapes from various primitives.


=== Modifying objects === <!--T:38-->
=== Creation and modification === <!--T:38-->


<!--T:39-->
<!--T:39-->
These are tools for modifying existing objects.
These are tools for creating new and modifying existing objects.


<!--T:40-->
<!--T:40-->
* [[Image:Part_Extrude.svg|32px]] [[Part_Extrude|Extrude]]: Extrudes planar faces.
* [[Image:Part_Extrude.svg|32px]] [[Part_Extrude|Extrude]]: Extrudes planar faces.


<!--T:91-->
* [[Image:Part_Revolve.svg|32px]] [[Part_Revolve|Revolve]]: Creates a solid by revolving an object (not a solid) around an axis.
* [[Image:Part_Revolve.svg|32px]] [[Part_Revolve|Revolve]]: Creates a solid by revolving an object (not a solid) around an axis.


<!--T:92-->
* [[Image:Part_Mirror.svg|32px]] [[Part_Mirror|Mirror]]: Mirrors the selected object across a mirror plane.
* [[Image:Part_Mirror.svg|32px]] [[Part_Mirror|Mirror]]: Mirrors the selected object across a mirror plane.


<!--T:93-->
* [[Image:Part_Fillet.svg|32px]] [[Part_Fillet|Fillet]]: Fillets (rounds) edges of an object.
* [[Image:Part_Fillet.svg|32px]] [[Part_Fillet|Fillet]]: Fillets (rounds) edges of an object.


<!--T:94-->
* [[Image:Part_Chamfer.svg|32px]] [[Part_Chamfer|Chamfer]]: Chamfers edges of an object.
* [[Image:Part_Chamfer.svg|32px]] [[Part_Chamfer|Chamfer]]: Chamfers edges of an object.


<!--T:116-->
* [[File:Part_MakeFace.svg|32px]] [[Part_MakeFace|Make face from wires]]: Makes a face from a set of wires (contours). {{Version|0.19}}

<!--T:95-->
* [[Image:Part_RuledSurface.svg|32px]] [[Part_RuledSurface|Ruled Surface]]: Creates a ruled surface.
* [[Image:Part_RuledSurface.svg|32px]] [[Part_RuledSurface|Ruled Surface]]: Creates a ruled surface.


<!--T:96-->
* [[Image:Part_Loft.svg|32px]] [[Part_Loft|Loft]]: Lofts from one profile to another.
* [[Image:Part_Loft.svg|32px]] [[Part_Loft|Loft]]: Lofts from one profile to another.


<!--T:97-->
* [[Image:Part_Sweep.svg|32px]] [[Part_Sweep|Sweep]]: Sweeps one or more profiles along a path.
* [[Image:Part_Sweep.svg|32px]] [[Part_Sweep|Sweep]]: Sweeps one or more profiles along a path.

<!--T:101-->
* [[Image:Part_Section.svg|32px]] [[Part_Section|Section]]: Creates a section by intersecting an object with a section plane.

<!--T:102-->
* [[Image:Part_CrossSections.svg|32px]] [[Part_CrossSections|Cross sections...]]: Creates one or more cross-sections through an object.


<!--T:45-->
<!--T:45-->
Line 110: Line 136:
<!--T:57-->
<!--T:57-->
* [[File:Part_ProjectionOnSurface.svg|32px]] [[Part_ProjectionOnSurface|Projection on surface]]: Projects a logo, text or any face, wire or edge onto a surface. {{Version|0.19}}
* [[File:Part_ProjectionOnSurface.svg|32px]] [[Part_ProjectionOnSurface|Projection on surface]]: Projects a logo, text or any face, wire or edge onto a surface. {{Version|0.19}}

<!--T:103-->
* [[Image:Part_EditAttachment.svg|32px]] [[Part_EditAttachment|Attachment]]: Attaches an object to another object.

=== Boolean === <!--T:119-->

<!--T:120-->
These tools perform boolean operations.


<!--T:47-->
<!--T:47-->
Line 120: Line 154:
* [[Image:Part_Boolean.svg|32px]] [[Part_Boolean|Boolean]]: Performs boolean operations on objects.
* [[Image:Part_Boolean.svg|32px]] [[Part_Boolean|Boolean]]: Performs boolean operations on objects.


<!--T:98-->
* [[Image:Part_Cut.svg|32px]] [[Part_Cut|Cut]]: Cuts (subtracts) one object from another.
* [[Image:Part_Cut.svg|32px]] [[Part_Cut|Cut]]: Cuts (subtracts) one object from another.


<!--T:99-->
* [[Image:Part_Fuse.svg|32px]] [[Part_Fuse|Fuse]]: Fuses (unions) two objects.
* [[Image:Part_Fuse.svg|32px]] [[Part_Fuse|Fuse]]: Fuses (unions) two objects.


<!--T:100-->
* [[Image:Part_Common.svg|32px]] [[Part_Common|Common]]: Extracts the common (intersection) part of two objects.
* [[Image:Part_Common.svg|32px]] [[Part_Common|Common]]: Extracts the common (intersection) part of two objects.


Line 138: Line 175:
** [[Image:Part_Slice.svg|32px]] [[Part_Slice|Slice]]: Slices an object by intersecting it with other objects.
** [[Image:Part_Slice.svg|32px]] [[Part_Slice|Slice]]: Slices an object by intersecting it with other objects.
** [[Image:Part_XOR.svg|32px]] [[Part_XOR|XOR]]: Removes space shared by an even number of objects (symmetric version of [[Part_Cut|Cut]]).
** [[Image:Part_XOR.svg|32px]] [[Part_XOR|XOR]]: Removes space shared by an even number of objects (symmetric version of [[Part_Cut|Cut]]).

<!--T:51-->
* [[Image:Part Defeaturing.svg|32px]] [[Part_Defeaturing|Defeaturing]]: Removes features from an object.

* [[Image:Part_Section.svg|32px]] [[Part_Section|Section]]: Creates a section by intersecting an object with a section plane.

* [[Image:Part_CrossSections.svg|32px]] [[Part_CrossSections|Cross sections...]]: Creates one or more cross-sections through an object.

* [[Image:Part Attachment.svg|32px]] [[Part_Attachment|Attachment]]: Attaches an object to another object.


=== Measure === <!--T:58-->
=== Measure === <!--T:58-->
Line 154: Line 182:


<!--T:60-->
<!--T:60-->
* [[Image:Part_Measure_Linear.svg|32px]] [[Part_Measure_Linear|Measure Linear]]: Creates a linear measurements.
* [[Image:Part_Measure_Linear.svg|32px]] [[Part_Measure_Linear|Measure Linear]]: Creates a linear measurement.


<!--T:104-->
* [[Image:Part_Measure_Angular.svg|32px]] [[Part_Measure_Angular|Measure Angular]]: Creates an angular measurements.
* [[Image:Part_Measure_Angular.svg|32px]] [[Part_Measure_Angular|Measure Angular]]: Creates an angular measurement.


<!--T:105-->
* [[Image:Part_Measure_Refresh.svg|32px]] [[Part_Measure_Refresh|Measure Refresh]]: Updates all measurements.
* [[Image:Part_Measure_Refresh.svg|32px]] [[Part_Measure_Refresh|Measure Refresh]]: Updates all measurements.


<!--T:106-->
* [[Image:Part_Measure_Clear_All.svg|32px]] [[Part_Measure_Clear_All|Clear All]]: Clears all measurements.
* [[Image:Part_Measure_Clear_All.svg|32px]] [[Part_Measure_Clear_All|Clear All]]: Clears all measurements.


<!--T:107-->
* [[Image:Part_Measure_Toggle_All.svg|32px]] [[Part_Measure_Toggle_All|Toggle All]]: Shows or hides all measurements.
* [[Image:Part_Measure_Toggle_All.svg|32px]] [[Part_Measure_Toggle_All|Toggle All]]: Shows or hides all measurements.


<!--T:108-->
* [[Image:Part_Measure_Toggle_3d.svg|32px]] [[Part_Measure_Toggle_3d|Toggle 3D]]: Shows or hides 3D measurements.
* [[Image:Part_Measure_Toggle_3d.svg|32px]] [[Part_Measure_Toggle_3d|Toggle 3D]]: Shows or hides 3D measurements.


<!--T:109-->
* [[Image:Part_Measure_Toggle_Delta.svg|32px]] [[Part_Measure_Toggle_Delta|Toggle Delta]]: Shows or hides delta measurements.
* [[Image:Part_Measure_Toggle_Delta.svg|32px]] [[Part_Measure_Toggle_Delta|Toggle Delta]]: Shows or hides delta measurements.


===Other tools=== <!--T:41-->
=== Other tools === <!--T:41-->


<!--T:42-->
<!--T:42-->
* [[File:Part_Import.svg|32px]] [[Part_Import|Import]]: Imports from *.IGES, *.STEP, or *.BREP files.
* [[File:Part_Import.svg|32px]] [[Part_Import|Import]]: Imports from *.IGES, *.STEP, or *.BREP files.


<!--T:110-->
* [[File:Part_Export.svg|32px]] [[Part_Export|Export]]: Exports to *.IGES, *.STEP, or *.BREP files.
* [[File:Part_Export.svg|32px]] [[Part_Export|Export]]: Exports to *.IGES, *.STEP, or *.BREP files.


<!--T:111-->
* [[File:Part_BoxSelection.svg|32px]] [[Part_BoxSelection|BoxSelection]]: Selects faces from a rectangular area.
* [[File:Part_BoxSelection.svg|32px]] [[Part_BoxSelection|BoxSelection]]: Selects faces from a rectangular area.


<!--T:112-->
* [[File:Part_ShapeFromMesh.svg|32px]] [[Part_ShapeFromMesh|Shape from Mesh]]: Creates a shape object from a mesh object.
* [[File:Part_ShapeFromMesh.svg|32px]] [[Part_ShapeFromMesh|Shape from Mesh]]: Creates a shape object from a mesh object.


<!--T:113-->
* [[File:Part_PointsFromMesh.svg|32px]] [[Part_PointsFromMesh|Points from mesh]]: Creates a shape object made of points from a mesh object. {{Version|0.19}}
* [[File:Part_PointsFromMesh.svg|32px]] [[Part_PointsFromMesh|Points from mesh]]: Creates a shape object made of points from a mesh object. {{Version|0.19}}


<!--T:114-->
* [[File:Part_MakeSolid.svg|32px]] [[Part_MakeSolid|Convert to solid]]: Converts a shape object to a solid object.
* [[File:Part_MakeSolid.svg|32px]] [[Part_MakeSolid|Convert to solid]]: Converts a shape object to a solid object.


<!--T:115-->
* [[File:Part_ReverseShapes.svg|32px]] [[Part_ReverseShapes|Reverse shapes]]: Flips the normals of all faces of selected objects.
* [[File:Part_ReverseShapes.svg|32px]] [[Part_ReverseShapes|Reverse shapes]]: Flips the normals of all faces of selected objects.


Line 195: Line 235:
* [[File:Part_CheckGeometry.svg|32px]] [[Part_CheckGeometry|Check geometry]]: Checks the geometry of selected objects for errors.
* [[File:Part_CheckGeometry.svg|32px]] [[Part_CheckGeometry|Check geometry]]: Checks the geometry of selected objects for errors.


<!--T:51-->
* [[File:Part_MakeFace.svg|32px]] [[Part_MakeFace|Make face from wires]]: Makes a face from a set of wires. {{Version|0.19}}
* [[Image:Part Defeaturing.svg|32px]] [[Part_Defeaturing|Defeaturing]]: Removes features from an object.


=== Context menu items === <!--T:80-->
=== Context menu items === <!--T:80-->
Line 202: Line 243:
* [[File:Std_SetAppearance.svg|32px]] [[Std_SetAppearance|Appearance]]: Determines the appearance of a whole object (color, transparency etc.).
* [[File:Std_SetAppearance.svg|32px]] [[Std_SetAppearance|Appearance]]: Determines the appearance of a whole object (color, transparency etc.).


<!--T:117-->
* [[File:Part_FaceColors.svg|32px]] [[Part_FaceColors|Set colors]]: Assigns colors to individual faces of objects.
* [[File:Part_FaceColors.svg|32px]] [[Part_FaceColors|Set colors]]: Assigns colors to individual faces of objects.


Line 210: Line 252:
* [[Image:Preferences-part_design.svg|32px]] [[PartDesign_Preferences|Preferences]]: Preferences available for Part Tools (the Part workbench also uses the PartDesign Preferences).
* [[Image:Preferences-part_design.svg|32px]] [[PartDesign_Preferences|Preferences]]: Preferences available for Part Tools (the Part workbench also uses the PartDesign Preferences).
* [[Image:Preferences-import-export.svg|32px]] [[Import_Export_Preferences|Import Export Preferences]]: Preferences available for importing from and exporting to different file formats.
* [[Image:Preferences-import-export.svg|32px]] [[Import_Export_Preferences|Import Export Preferences]]: Preferences available for importing from and exporting to different file formats.
* [[Fine-tuning]]: some extra parameters to fine-tune Part behavior.
* [[Fine-tuning]]: Some extra parameters to fine-tune Part behavior.


== Scripting == <!--T:18-->
== Scripting == <!--T:18-->
Line 227: Line 269:
<!--T:32-->
<!--T:32-->
{{Docnav
{{Docnav
|[[OpenSCAD_Module|OpenSCAD Module]]
|[[OpenSCAD_Workbench|OpenSCAD Workbench]]
|[[PartDesign_Workbench|PartDesign Workbench]]
|[[PartDesign_Workbench|PartDesign Workbench]]
|IconL=Workbench_OpenSCAD.svg
|IconL=Workbench_OpenSCAD.svg

Revision as of 08:07, 3 September 2021

Part workbench icon

Introduction

The solid modelling capabilities of FreeCAD are based on the OpenCASCADE Technology (OCCT) kernel, a professional-grade CAD system that features advanced 3D geometry creation and manipulation. The Part Workbench is a layer sitting on top of the OCCT libraries, that gives the user access to OCCT geometric primitives and functions. Essentially all 2D and 3D drawing functions in every workbench ( Draft, Sketcher, PartDesign, etc.), are based on these functions exposed by the Part Workbench. Therefore, the Part Workbench is considered the core component of the modelling capabilities of FreeCAD.

A more detailed discussion of Part workbench versus Part Design workbench can be found here: Part and Part Design.

The objects created with the Part Workbench are relatively simple; they are intended to be used with boolean operations (unions and cuts) in order to build more complex shapes. This modeling paradigm is known as the constructive solid geometry (CSG) workflow, and it was the traditional methodology used in early CAD systems. On the other hand, the PartDesign Workbench provides a more modern workflow to constructing shapes: it uses a parametrically defined sketch, that is extruded to form a basic solid body, which is then modified by parametric transformations (feature editing), until the final object is obtained.

Part objects are more complex than mesh objects created with the Mesh Workbench, as they permit more advanced operations like coherent boolean operations, modifications history, and parametric behaviour.

The Part Workbench is the basic layer that exposes the OCCT drawing functions to all workbenches in FreeCAD.

Tools

The tools are located in the Part menu or the Measure menu.

Primitives

These are tools for creating primitive objects.

  • Box: Creates a box.
  • Cone: Creates a cone.
  • Torus: Creates a torus (ring).
  • Primitives: A tool to create one of the following primitives:
    • Plane: Creates a plane.
    • Box: Creates a box. This object can also be created with the Box tool.
    • Cylinder: Creates a cylinder. This object can also be created with the Cylinder tool.
    • Cone: Creates a cone. This object can also be created with the Cone tool.
    • Sphere: Creates a sphere. This object can also be created with the Sphere tool.
    • Ellipsoid: Creates a ellipsoid.
    • Torus: Creates a torus. This object can also be created with the Torus tool.
    • Prism: Creates a prism.
    • Wedge: Creates a wedge.
    • Helix: Creates a helix.
    • Spiral: Creates a spiral.
    • Circle: Creates a circular edge.
    • Ellipse: Creates an elliptical edge.
    • Point: Creates a point (vertex).
    • Line: Creates a line (edge).
    • Regular Polygon: Creates a regular polygon.
  • Builder: Creates shapes from various primitives.

Creation and modification

These are tools for creating new and modifying existing objects.

  • Revolve: Creates a solid by revolving an object (not a solid) around an axis.
  • Mirror: Mirrors the selected object across a mirror plane.
  • Fillet: Fillets (rounds) edges of an object.
  • Chamfer: Chamfers edges of an object.
  • Loft: Lofts from one profile to another.
  • Sweep: Sweeps one or more profiles along a path.
  • Section: Creates a section by intersecting an object with a section plane.
  • Offset tools:
    • 3D Offset: Constructs a parallel shape at a certain distance from an original.
    • 2D Offset: Constructs a parallel wire at certain distance from an original, or enlarges/shrinks a planar face.
  • Attachment: Attaches an object to another object.

Boolean

These tools perform boolean operations.

  • Boolean: Performs boolean operations on objects.
  • Cut: Cuts (subtracts) one object from another.
  • Fuse: Fuses (unions) two objects.
  • Common: Extracts the common (intersection) part of two objects.
  • Join features:
    • Connect: Connects interiors of walled objects.
    • Embed: Embeds a walled object into another walled object.
    • Cutout: Creates a cutout in a wall of an object for another walled object.
  • Splitting tools:
    • Boolean fragments: Creates all pieces obtained from Boolean operations.
    • Slice a part: Slices and splits an object by intersecting it with other objects.
    • Slice: Slices an object by intersecting it with other objects.
    • XOR: Removes space shared by an even number of objects (symmetric version of Cut).

Measure

File:Part Measure Menu.png Measure: Tools for linear and angular measurements.

Other tools

  • Import: Imports from *.IGES, *.STEP, or *.BREP files.
  • Export: Exports to *.IGES, *.STEP, or *.BREP files.

Context menu items

  • Appearance: Determines the appearance of a whole object (color, transparency etc.).
  • Set colors: Assigns colors to individual faces of objects.

Preferences

  • Preferences: Preferences available for Part Tools (the Part workbench also uses the PartDesign Preferences).
  • Import Export Preferences: Preferences available for importing from and exporting to different file formats.
  • Fine-tuning: Some extra parameters to fine-tune Part behavior.

Scripting

See Part scripting.

Tutorials