Draft Layer/en: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
(17 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{Docnav |
|||
{{Docnav|[[Draft_FlipDimension|Flip Dimension]]|[[Draft Slope|Slope]]|[[Draft_Module|Draft]]|IconL=Draft_FlipDimension.svg|IconC=Workbench_Draft.svg|IconR=Draft_Slope.svg}} |
|||
|[[Draft_ToggleGrid|ToggleGrid]] |
|||
|[[Draft_LayerManager|LayerManager]] |
|||
|[[Draft_Workbench|Draft]] |
|||
|IconL=Draft_ToggleGrid.svg |
|||
|IconR=Draft_LayerManager.svg |
|||
|IconC=Workbench_Draft.svg |
|||
}} |
|||
{{GuiCommand |
{{GuiCommand |
||
|Name=Draft Layer |
|Name=Draft Layer |
||
|MenuLocation=Utilities → Layer |
|||
|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]] |
|||
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]] |
|||
|MenuLocation=Draft → Utilities → Layer |
|||
|Version=0.19 |
|Version=0.19 |
||
|SeeAlso=[[Draft_AutoGroup|Draft AutoGroup]], [[Draft_LayerManager|Draft LayerManager]] |
|||
|See also=[[Draft VisGroup|Draft VisGroup]] (deprecated) |
|||
}} |
}} |
||
==Description== |
==Description== |
||
The [[Image:Draft_Layer.svg|24px]] '''Draft Layer''' command creates a Draft Layer. A layer is a special kind of group with a number of [[#View|visual properties]]. These properties, and any changes to them, are propagated to the objects placed inside the layer. The layers themselves are put in another special group: the Draft LayerContainer. |
|||
The [[Draft Layer|Draft Layer]] creates a special kind of group that controls the visual properties of objects placed inside of it. By changing the properties of the Layer, such as line width, line color, shape color and transparency, the changes are propagated to the objects that make use of the Layer property. |
|||
==Usage== |
|||
This tool replaces [[Draft VisGroup|Draft VisGroup]] starting from FreeCAD 0.19. |
|||
# There are several ways to invoke the command: |
|||
==How to use== |
|||
#* Press the {{Button|[[Image:Draft_Layer.svg|16px]] [[Draft_Layer|Layer]]}} button. |
|||
#* Select the {{MenuCommand|Utilities → [[Image:Draft_Layer.svg|16px]] Layer}} option from the menu. |
|||
#* If the layer container already exists: right-click it in the [[Tree_view|Tree view]] and select the {{MenuCommand|[[Image:Draft_NewLayer.svg|16px]] Add new layer}} option from context menu. |
|||
# If it does not exist the layer container is created first. |
|||
# A layer is created and put in the layer container. |
|||
# Optionally change the [[#Properties|properties]] of the layer. |
|||
# Optionally put objects in the layer by drag and dropping them on the layer in the [[Tree_view|Tree view]]. Objects can also be put in a layer by editing the {{PropertyData|Group}} property of the layer. |
|||
# Optionally [[#Layer_options|activate]] the layer. |
|||
== Context menu == |
|||
# Go to the menu {{MenuCommand|Draft → Utilities → [[Image:Draft_Layer.svg|16px]] Layer}}. |
|||
# Change the desired view properties of the Layer. |
|||
=== Layer container options === |
|||
For a Draft LayerContainer these additional options are available in the [[Tree_view|Tree view]] context menu: |
|||
* {{MenuCommand|[[Image:Draft_Layer.svg|16px]] Merge layer duplicates}}: merges all layers with the same base label. |
|||
: The base label of a layer is its {{PropertyData|Label}} stripped of trailing digits and spaces. All layers with the same base label are merged into a single layer with the {{PropertyData|Label}} set to that base label. |
|||
* {{MenuCommand|[[Image:Draft_NewLayer.svg|16px]] Add new layer}}: adds a new layer to the current document. |
|||
=== Layer options === |
|||
For a Draft Layer these additional options are available in the [[Tree_view|Tree view]] context menu: |
|||
* {{MenuCommand|[[Image:button_right.svg|16px]] [[Draft_AutoGroup|Activate this layer]]}}: activates the selected layer. |
|||
* {{MenuCommand|[[Image:Draft_SelectGroup.svg|16px]] [[Draft_SelectGroup|Select layer contents]]}}: selects the objects inside the selected layer. |
|||
== Drag and drop behavior == |
|||
{{Version|0.21}} |
|||
If you drop an object from a [[Std_Group|Std Group]], or a group-like object such as an [[Arch_BuildingPart|Arch BuildingPart]], on a layer in the [[Tree_view|Tree view]], it is not removed from the group, and vice versa. To remove an object from a layer it must be dropped on another layer or on the document node. There is no need to hold down the {{KEY|Ctrl}} key when dragging from or dropping on a layer. |
|||
== Notes == |
|||
* A new layer can also be created with the [[Draft_AutoGroup|Draft AutoGroup]] command. |
|||
* The [[BIM_Workbench|BIM Workbench]] offers a complete [[BIM_Layers|layer manager tool]] which will eventually be included in the [[Draft_Workbench|Draft Workbench]]. |
|||
== Properties == |
== Properties == |
||
See also: [[Property_editor|Property editor]]. |
|||
* {{PropertyData|Group}}: specifies the elements that are part of the group. |
|||
* Visual properties that can be changed that are propagated to the objects: drawing style, line color, line width, shape color, transparency, and visibility. |
|||
A Draft Layer object is derived from an [[App_FeaturePython|App FeaturePython]] object and inherits all its properties. It also has the following additional properties: |
|||
=== Data === |
|||
{{Docnav|[[Draft_FlipDimension|Flip Dimension]]|[[Draft Slope|Slope]]|[[Draft_Module|Draft]]|IconL=Draft_FlipDimension.svg|IconC=Workbench_Draft.svg|IconR=Draft_Slope.svg}} |
|||
{{TitleProperty|Layer}} |
|||
* {{PropertyData|Group|LinkList}}: specifies the objects that are inside the layer. |
|||
{{Draft Tools navi}} |
|||
{{Userdocnavi}} |
|||
=== View === |
|||
{{TitleProperty|Layer}} |
|||
The properties in this section are applied to objects that are put inside the layer. And any changes to these properties are propagated to them. For two properties, {{PropertyView|Line Color}} and {{PropertyView|Shape Color}}, this behavior is optional. |
|||
* {{PropertyView|Draw Style|Enumeration}}: specifies the draw style of the layer: {{value|Solid}}, {{value|Dashed}}, {{value|Dotted}} or {{value|Dashdot}} |
|||
* {{PropertyView|Line Color|Color}}: specifies the line color of the layer. |
|||
* {{PropertyView|Line Width|Float}}: specifies the line width of the layer. |
|||
* {{PropertyView|Override Line Color Children|Bool}}: specifies if changes to the {{PropertyView|Line Color}} of the layer are propagated to the objects inside the layer. |
|||
* {{PropertyView|Override Shape Color Children|Bool}}: specifies if changes to the {{PropertyView|Shape Color}} of the layer are propagated to the objects inside the layer. |
|||
* {{PropertyView|Shape Color|Color}}: specifies the shape color of the layer. |
|||
* {{PropertyView|Transparency|Percent}}: specifies the transparency of the layer. |
|||
{{TitleProperty|Print}} |
|||
* {{PropertyView|Line Print Color|Color}}: specifies the line print color of the layer. |
|||
* {{PropertyView|Use Print Color|Bool}}: specifies if the {{PropertyView|Line Print Color|}} of the layer is used when a [[TechDraw_DraftView|TechDraw DraftView]] is created from the objects inside the layer. |
|||
== Scripting == |
|||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
To create a Draft Layer use the {{incode|make_layer}} method of the Draft module. To add objects to, or remove objects from, a layer change its {{incode|Group}} property. |
|||
{{Code|code= |
|||
import FreeCAD as App |
|||
import Draft |
|||
doc = App.newDocument() |
|||
layer = Draft.make_layer(line_color=(1.0, 0.0, 0.0, 0.0), |
|||
shape_color=(1.0, 1.0, 0.0, 0.0)) |
|||
polygon1 = Draft.make_polygon(5, radius=1000) |
|||
polygon2 = Draft.make_polygon(3, radius=500) |
|||
polygon3 = Draft.make_polygon(6, radius=220) |
|||
layer.Group = [polygon1, polygon2, polygon3] |
|||
doc.recompute() |
|||
}} |
|||
{{Docnav |
|||
|[[Draft_ToggleGrid|ToggleGrid]] |
|||
|[[Draft_LayerManager|LayerManager]] |
|||
|[[Draft_Workbench|Draft]] |
|||
|IconL=Draft_ToggleGrid.svg |
|||
|IconR=Draft_LayerManager.svg |
|||
|IconC=Workbench_Draft.svg |
|||
}} |
|||
{{Draft Tools navi{{#translation:}}}} |
|||
{{clear}} |
|||
{{Userdocnavi{{#translation:}}}} |
Latest revision as of 20:00, 7 December 2023
Draft Layer |
Menu location |
---|
Utilities → Layer |
Workbenches |
Draft, Arch |
Default shortcut |
None |
Introduced in version |
0.19 |
See also |
Draft AutoGroup, Draft LayerManager |
Description
The Draft Layer command creates a Draft Layer. A layer is a special kind of group with a number of visual properties. These properties, and any changes to them, are propagated to the objects placed inside the layer. The layers themselves are put in another special group: the Draft LayerContainer.
Usage
- There are several ways to invoke the command:
- If it does not exist the layer container is created first.
- A layer is created and put in the layer container.
- Optionally change the properties of the layer.
- Optionally put objects in the layer by drag and dropping them on the layer in the Tree view. Objects can also be put in a layer by editing the DataGroup property of the layer.
- Optionally activate the layer.
Layer container options
For a Draft LayerContainer these additional options are available in the Tree view context menu:
- The base label of a layer is its DataLabel stripped of trailing digits and spaces. All layers with the same base label are merged into a single layer with the DataLabel set to that base label.
Layer options
For a Draft Layer these additional options are available in the Tree view context menu:
- Activate this layer: activates the selected layer.
- Select layer contents: selects the objects inside the selected layer.
Drag and drop behavior
If you drop an object from a Std Group, or a group-like object such as an Arch BuildingPart, on a layer in the Tree view, it is not removed from the group, and vice versa. To remove an object from a layer it must be dropped on another layer or on the document node. There is no need to hold down the Ctrl key when dragging from or dropping on a layer.
Notes
- A new layer can also be created with the Draft AutoGroup command.
- The BIM Workbench offers a complete layer manager tool which will eventually be included in the Draft Workbench.
Properties
See also: Property editor.
A Draft Layer object is derived from an App FeaturePython object and inherits all its properties. It also has the following additional properties:
Data
Layer
- DataGroup (
LinkList
): specifies the objects that are inside the layer.
View
Layer
The properties in this section are applied to objects that are put inside the layer. And any changes to these properties are propagated to them. For two properties, ViewLine Color and ViewShape Color, this behavior is optional.
- ViewDraw Style (
Enumeration
): specifies the draw style of the layer:Solid
,Dashed
,Dotted
orDashdot
- ViewLine Color (
Color
): specifies the line color of the layer. - ViewLine Width (
Float
): specifies the line width of the layer. - ViewOverride Line Color Children (
Bool
): specifies if changes to the ViewLine Color of the layer are propagated to the objects inside the layer. - ViewOverride Shape Color Children (
Bool
): specifies if changes to the ViewShape Color of the layer are propagated to the objects inside the layer. - ViewShape Color (
Color
): specifies the shape color of the layer. - ViewTransparency (
Percent
): specifies the transparency of the layer.
- ViewLine Print Color (
Color
): specifies the line print color of the layer. - ViewUse Print Color (
Bool
): specifies if the ViewLine Print Color of the layer is used when a TechDraw DraftView is created from the objects inside the layer.
Scripting
See also: Autogenerated API documentation and FreeCAD Scripting Basics.
To create a Draft Layer use the make_layer
method of the Draft module. To add objects to, or remove objects from, a layer change its Group
property.
import FreeCAD as App
import Draft
doc = App.newDocument()
layer = Draft.make_layer(line_color=(1.0, 0.0, 0.0, 0.0),
shape_color=(1.0, 1.0, 0.0, 0.0))
polygon1 = Draft.make_polygon(5, radius=1000)
polygon2 = Draft.make_polygon(3, radius=500)
polygon3 = Draft.make_polygon(6, radius=220)
layer.Group = [polygon1, polygon2, polygon3]
doc.recompute()
- Drafting: Line, Polyline, Fillet, Arc, Arc by 3 points, Circle, Ellipse, Rectangle, Polygon, B-spline, Cubic Bézier curve, Bézier curve, Point, Facebinder, ShapeString, Hatch
- Annotation: Text, Dimension, Label, Annotation styles, Annotation scale
- Modification: Move, Rotate, Scale, Mirror, Offset, Trimex, Stretch, Clone, Array, Polar array, Circular array, Path array, Path link array, Point array, Point link array, Edit, Subelement highlight, Join, Split, Upgrade, Downgrade, Wire to B-spline, Draft to sketch, Set slope, Flip dimension, Shape 2D view
- Draft Tray: Select plane, Set style, Toggle construction mode, AutoGroup
- Snapping: Snap lock, Snap endpoint, Snap midpoint, Snap center, Snap angle, Snap intersection, Snap perpendicular, Snap extension, Snap parallel, Snap special, Snap near, Snap ortho, Snap grid, Snap working plane, Snap dimensions, Toggle grid
- Miscellaneous: Apply current style, Layer, Manage layers, Add a new named group, Move to group, Select group, Add to construction group, Toggle normal/wireframe display, Create working plane proxy, Heal, Show snap toolbar
- Additional: Constraining, Pattern, Preferences, Import Export Preferences, DXF/DWG, SVG, OCA, DAT
- Context menu:
- Layer container: Merge layer duplicates, Add new layer
- Layer: Activate this layer, Select layer contents
- Text: Open hyperlinks
- Wire: Flatten
- Working plane proxy: Write camera position, Write objects state
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub