TechDraw GeometricHatch: Difference between revisions

From FreeCAD Documentation
(Updated Description and Usage.)
(Added "solid color fill" note.)
 
(8 intermediate revisions by 2 users not shown)
Line 15: Line 15:
{{GuiCommand
{{GuiCommand
|Name=TechDraw GeometricHatch
|Name=TechDraw GeometricHatch
|MenuLocation=TechDraw → Apply Geometric Hatch to Face
|MenuLocation=TechDraw → Hatching → Apply Geometric Hatch to Face
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|SeeAlso=[[TechDraw_Hatch|TechDraw Hatch]], [[TechDraw_Hatching|TechDraw Hatching]]
|SeeAlso=[[TechDraw_Hatch|TechDraw Hatch]], [[TechDraw_Hatching|TechDraw Hatching]]
Line 23: Line 23:


<!--T:8-->
<!--T:8-->
The GeometricHatch tool fills a closed region in a View with a pattern based on an AutoDesk PAT hatching specification. Alternatively the [[Image:TechDraw_Hatch.svg|16px]] [[TechDraw_Hatch|Hatch]] tool uses SVG based hatch patterns. See [[TechDraw_Hatching|Hatching]] for details.
The '''TechDraw GeometricHatch''' tool fills a closed region in a View with a pattern based on an AutoDesk PAT hatching specification. Alternatively the [[Image:TechDraw_Hatch.svg|16px]] [[TechDraw_Hatch|TechDraw Hatch]] tool uses SVG based hatch patterns. See [[TechDraw_Hatching|Hatching]] for details.


</translate>
</translate>
Line 37: Line 37:
# There are several ways to invoke the tool:
# There are several ways to invoke the tool:
#* Press the {{Button|[[Image:TechDraw_GeometricHatch.svg|16px]] [[TechDraw_GeometricHatch|TechDraw GeometricHatch]]}} button.
#* Press the {{Button|[[Image:TechDraw_GeometricHatch.svg|16px]] [[TechDraw_GeometricHatch|TechDraw GeometricHatch]]}} button.
#* Select the {{MenuCommand|TechDraw → [[Image:TechDraw_GeometricHatch.svg|16px]] Apply Geometric Hatch to Face}} option from the menu.
#* Select the {{MenuCommand|TechDraw → Hatching → [[Image:TechDraw_GeometricHatch.svg|16px]] Apply Geometric Hatch to Face}} option from the menu.
# The {{MenuCommand|Apply Geometric Hatch to Face}} task panel opens.
# The {{MenuCommand|Apply Geometric Hatch to Face}} task panel opens.
# Optionally change the {{MenuCommand|Pattern File}}, the {{MenuCommand|Pattern Name}}, the {{MenuCommand|Pattern Scale}}, the {{MenuCommand|Line Weight}} and the {{MenuCommand|Line Color}}.
# Optionally change the {{MenuCommand|Pattern File}}, the {{MenuCommand|Pattern Name}}, the {{MenuCommand|Pattern Scale}}, the {{MenuCommand|Line Weight}} and the {{MenuCommand|Line Color}}.
Line 45: Line 45:


<!--T:11-->
<!--T:11-->
* For a solid color fill use [[TechDraw_Hatch|TechDraw Hatch]] instead and select {{FileName|solid.svg}} as the '''Pattern File'''.
* Hatching objects are vulnerable to the "[[Topological_naming_problem|topological naming problem]]". See [[TechDraw_LengthDimension|TechDraw LengthDimension]] for more information. It is recommended that hatching be one of the last steps in your drawing process.
* Hatching objects are vulnerable to the "[[Topological_naming_problem|topological naming problem]]". See [[TechDraw_LengthDimension|TechDraw LengthDimension]] for more information. It is recommended that hatching be one of the last steps in your drawing process.
* A small set of sample patterns are available in:

<!--T:12-->
A small set of sample patterns are available in:

</translate>
</translate>
{{Code|code=
: {{Code|code=
$INSTALL_DIR/data/Mod/TechDraw/PAT/FCPAT.pat
$INSTALL_DIR/data/Mod/TechDraw/PAT/FCPAT.pat
}}
}}
<translate>
<translate>

<!--T:13-->
<!--T:13-->
{{incode|$INSTALL_DIR}} is the directory where FreeCAD was installed, for example
: Where {{incode|$INSTALL_DIR}} is the directory where FreeCAD was installed, for example:

</translate>
</translate>
{{Code|code=
: {{Code|code=
/usr/share/freecad/data/Mod/TechDraw/PAT/FCPAT.pat
/usr/share/freecad/data/Mod/TechDraw/PAT/FCPAT.pat
}}
}}
Line 78: Line 74:


<!--T:15-->
<!--T:15-->
{{Emphasis|See also:}} [[TechDraw_API|TechDraw API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:16-->
<!--T:16-->
The GeometricHatch tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following functions:
A GeometricHatch can be created with [[Macros|macros]] and from the [[Python|Python]] console by using the following functions:


</translate>
</translate>
{{Code|code=
{{Code|code=
hatch = FreeCAD.ActiveDocument.addObject('TechDraw::DrawGeomHatch','GeomHatch')
hatch = FreeCAD.ActiveDocument.addObject("TechDraw::DrawGeomHatch", "GeomHatch")
hatch.Source = (view1,["Face0"])
hatch.Source = (view1, ["Face0"])
hatch.FilePattern = "path/to/myPATfile.pat"
hatch.FilePattern = "path/to/myPATfile.pat"
hatch.NamePattern = "Diamond"
hatch.NamePattern = "Diamond"
rc = page.addView(hatch)
page.addView(hatch)
}}
}}
<translate>
<translate>
Line 99: Line 95:
{{Code|code=
{{Code|code=
import TechDraw
import TechDraw
face = Part.makePlane(10,10)
face = Part.makePlane(10, 10)
patfile = "path/to/myPATfile.pat"
patfile = "path/to/myPATfile.pat"
pattern = "Diamond"
pattern = "Diamond"

Latest revision as of 07:57, 1 August 2023

TechDraw GeometricHatch

Menu location
TechDraw → Hatching → Apply Geometric Hatch to Face
Workbenches
TechDraw
Default shortcut
None
Introduced in version
-
See also
TechDraw Hatch, TechDraw Hatching

Description

The TechDraw GeometricHatch tool fills a closed region in a View with a pattern based on an AutoDesk PAT hatching specification. Alternatively the TechDraw Hatch tool uses SVG based hatch patterns. See Hatching for details.

Geometric hatch pattern on a face

Usage

  1. Select a closed region in a View.
  2. There are several ways to invoke the tool:
    • Press the TechDraw GeometricHatch button.
    • Select the TechDraw → Hatching → Apply Geometric Hatch to Face option from the menu.
  3. The Apply Geometric Hatch to Face task panel opens.
  4. Optionally change the Pattern File, the Pattern Name, the Pattern Scale, the Line Weight and the Line Color.
  5. Press the OK button.

Notes

  • For a solid color fill use TechDraw Hatch instead and select solid.svg as the Pattern File.
  • Hatching objects are vulnerable to the "topological naming problem". See TechDraw LengthDimension for more information. It is recommended that hatching be one of the last steps in your drawing process.
  • A small set of sample patterns are available in:
$INSTALL_DIR/data/Mod/TechDraw/PAT/FCPAT.pat
Where $INSTALL_DIR is the directory where FreeCAD was installed, for example:
/usr/share/freecad/data/Mod/TechDraw/PAT/FCPAT.pat

Properties

  • DataSource: The View and Face to receive the hatch pattern.
  • DataFile Pattern: The location of the PAT file to use.
  • DataName Pattern: The name of the PAT specification within File Pattern.
  • DataScale Pattern: The scale to be applied to the pattern (must be > 0.0).
  • ViewWeight Pattern: The thickness of the pattern lines.
  • ViewColor Pattern: The color for the pattern lines.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

A GeometricHatch can be created with macros and from the Python console by using the following functions:

hatch = FreeCAD.ActiveDocument.addObject("TechDraw::DrawGeomHatch", "GeomHatch")
hatch.Source = (view1, ["Face0"])
hatch.FilePattern = "path/to/myPATfile.pat"
hatch.NamePattern = "Diamond"
page.addView(hatch)

It is also possible to use TechDraw's geometric hatch engine to produce a compound object in the 3D space. One must take care that the base face lies on the XY plane, as the algorithm is not tailored yet for other cases:

import TechDraw
face = Part.makePlane(10, 10)
patfile = "path/to/myPATfile.pat"
pattern = "Diamond"
scale = 10
hatch = TechDraw.makeGeomHatch(face, scale, pattern, patfile)
Part.show(hatch)