TechDraw Hatch: Difference between revisions

From FreeCAD Documentation
(Information from the description)
mNo edit summary
(46 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:19-->
{{Docnav
|[[TechDraw_ClipGroupRemove|ClipGroupRemove]]
|[[TechDraw_GeometricHatch|GeometricHatch]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_ClipGroupRemove.svg
|IconR=TechDraw_GeometricHatch.svg
|IconC=Workbench_TechDraw.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=TechDraw Hatch
|Name=TechDraw Hatch
|MenuLocation=TechDraw → Hatch
|MenuLocation=TechDraw → Hatching → Hatch a Face using Image File
|Workbenches=[[TechDraw Module|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|SeeAlso=[[TechDraw GeomHatch]], [[TechDraw_Hatching|TechDraw Hatching]]
|SeeAlso=[[TechDraw_GeometricHatch|TechDraw Geometric Hatch]], [[TechDraw_Hatching|TechDraw Hatching]]
}}
}}


==Description== <!--T:2-->
==Description== <!--T:2-->
The Hatch tool fills a closed region in a [[TechDraw NewView]] with a hatch pattern, which can be [[SVG]] or [[bitmap]] files.


==How to use== <!--T:3-->
<!--T:8-->
The '''TechDraw Hatch''' tool fills a closed region in a View with a tiled [[SVG|SVG]] or bitmap ({{Version|0.21}}) based hatch pattern. Alternatively the [[Image:TechDraw_GeometricHatch.svg|16px]] [[TechDraw_GeometricHatch|TechDraw GeometricHatch]] tool uses PAT based hatch patterns. See [[TechDraw_Hatching|Hatching]] for details.
# Select an closed region in a View. The region will turn green.
# Press the {{Button|[[Image:TechDraw_Hatch.png|16px]] [[TechDraw Hatch|Hatch]]}} button
# You may need to press recompute [[Image:View-rotate-right.png|16px]].


</translate>
=== Notes === <!--T:7-->
[[Image:TechDraw_Hatch_example.png|300px]]
* Hatching objects are vulnerable to "topological naming" issues. See the information in the [[TechDraw Dimension Length]] tool for more information. It is recommended that hatching be one of the last steps in your drawing process.
<translate>
* Note that [[SVG]] hatch patterns are not included when a drawing page is saved as an [[SVG]] file.


<!--T:9-->
Sample [[SVG]] patterns are available in
{{Caption|SVG hatch pattern on a face}}
{{Code|code=
$INSTALL_DIR/Mod/Draft/Resources/patterns
}}


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

{{Code|code=
<!--T:10-->
/usr/share/freecad/Mod/Draft/Resources/patterns
# Select a closed region in a View.
# There are several ways to invoke the tool:
#* Press the {{Button|[[Image:TechDraw_Hatch.svg|16px]] [[TechDraw_Hatch|TechDraw Hatch]]}} button.
#* Select the {{MenuCommand|TechDraw → Hatching → [[Image:TechDraw_Hatch.svg|16px]] Hatch a Face using Image File}} option from the menu.
# The {{MenuCommand|Apply Hatch to Face}} task panel opens.
# Optionally change the {{MenuCommand|Pattern File}}.
# Optionally change the {{MenuCommand|Pattern Scale}} and the {{MenuCommand|Line Color}}. These settings are ignored for bitmap patterns.
# Press the {{Button|OK}} button.

== Notes == <!--T:7-->

<!--T:11-->
* For a solid color fill 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.
* Sample [[SVG|SVG]] patterns are available locally in:
</translate>
: {{Code|code=
$INSTALL_DIR/data/Mod/TechDraw/Patterns
}}
}}
<translate>
<!--T:21-->
: Where {{incode|$INSTALL_DIR}} is the directory where FreeCAD was installed, for example:
</translate>
: {{Code|code=
/usr/share/freecad/data/Mod/TechDraw/Patterns
}}
<translate>
<!--T:22-->
: They are also available on [https://github.com/FreeCAD/FreeCAD/tree/master/src/Mod/TechDraw/Patterns GitHub].


==Properties== <!--T:5-->
==Properties== <!--T:5-->

<!--T:14-->
* {{PropertyData|Source}}: The View and Face to receive the hatch pattern.
* {{PropertyData|Source}}: The View and Face to receive the hatch pattern.
* {{PropertyData|Hatch Pattern}}: Full path and filename to an SVG pattern file.
* {{PropertyData|Hatch Pattern}}: Full path and filename to an SVG pattern file.
Line 38: Line 74:


==Scripting== <!--T:6-->
==Scripting== <!--T:6-->
{{Emphasis|See also:}} [[TechDraw API]] and [[FreeCAD Scripting Basics]].


<!--T:15-->
The Hatch tool can be used in [[macros]] and from the [[Python]] console by using the following functions:
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

<!--T:16-->
A Hatch 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::DrawHatch','Hatch')
hatch = FreeCAD.ActiveDocument.addObject("TechDraw::DrawHatch", "Hatch")
hatch.Source = (view1,["Face0"])
hatch.Source = (view1, ["Face0"])
hatch.HatchPattern = hatchFileSpec
hatch.HatchPattern = hatchFileSpec
rc = page.addView(hatch)
page.addView(hatch)
}}
}}
<translate>
<translate>



{{TechDraw Tools navi}}
<!--T:20-->
{{Userdocnavi}}
{{Docnav
|[[TechDraw_ClipGroupRemove|ClipGroupRemove]]
|[[TechDraw_GeometricHatch|GeometricHatch]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_ClipGroupRemove.svg
|IconR=TechDraw_GeometricHatch.svg
|IconC=Workbench_TechDraw.svg
}}

</translate>
</translate>
{{TechDraw Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

Revision as of 07:52, 1 August 2023

TechDraw Hatch

Menu location
TechDraw → Hatching → Hatch a Face using Image File
Workbenches
TechDraw
Default shortcut
None
Introduced in version
-
See also
TechDraw Geometric Hatch, TechDraw Hatching

Description

The TechDraw Hatch tool fills a closed region in a View with a tiled SVG or bitmap (introduced in version 0.21) based hatch pattern. Alternatively the TechDraw GeometricHatch tool uses PAT based hatch patterns. See Hatching for details.

SVG 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 Hatch button.
    • Select the TechDraw → Hatching → Hatch a Face using Image File option from the menu.
  3. The Apply Hatch to Face task panel opens.
  4. Optionally change the Pattern File.
  5. Optionally change the Pattern Scale and the Line Color. These settings are ignored for bitmap patterns.
  6. Press the OK button.

Notes

  • For a solid color fill 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.
  • Sample SVG patterns are available locally in:
$INSTALL_DIR/data/Mod/TechDraw/Patterns
Where $INSTALL_DIR is the directory where FreeCAD was installed, for example:
/usr/share/freecad/data/Mod/TechDraw/Patterns
They are also available on GitHub.

Properties

  • DataSource: The View and Face to receive the hatch pattern.
  • DataHatch Pattern: Full path and filename to an SVG pattern file.
  • ViewHatch Color: Hatch pattern will be displayed in this color.
  • ViewHatch Scale: Hatch pattern size modifier.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

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

hatch = FreeCAD.ActiveDocument.addObject("TechDraw::DrawHatch", "Hatch")
hatch.Source = (view1, ["Face0"])
hatch.HatchPattern = hatchFileSpec
page.addView(hatch)