Draft Layer: Difference between revisions

From FreeCAD Documentation
No edit summary
(Button text.)
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Page in progress}}
<languages/>
<languages/>
<translate>
<translate>
Line 6: Line 5:
{{Docnav
{{Docnav
|[[Draft_ToggleGrid|ToggleGrid]]
|[[Draft_ToggleGrid|ToggleGrid]]
|[[Draft_LayerManager|LayerManager]]
|[[Draft_WorkingPlaneProxy|WorkingPlaneProxy]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_ToggleGrid.svg
|IconL=Draft_ToggleGrid.svg
|IconR=Draft_WorkingPlaneProxy.svg
|IconR=Draft_LayerManager.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 16: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Draft Layer
|Name=Draft Layer
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|MenuLocation=Utilities → Layer
|MenuLocation=Utilities → Layer
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Version=0.19
|Version=0.19
|SeeAlso=[[Draft_AutoGroup|Draft AutoGroup]]
|SeeAlso=[[Draft_AutoGroup|Draft AutoGroup]], [[Draft_LayerManager|Draft LayerManager]]
}}
}}


Line 25: Line 24:


<!--T:4-->
<!--T:4-->
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 [[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.

<!--T:5-->
This command has replaced the Draft VisGroup command in FreeCAD version 0.19.


==Usage== <!--T:6-->
==Usage== <!--T:6-->
Line 34: Line 30:
<!--T:7-->
<!--T:7-->
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Layer.svg|16px]] [[Draft_Layer|Draft Layer]]}} button.
#* 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.
#* 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 Draft LayerContainer, which will hold all layers, is created first.
# A layer is created and added to the layer container.
# 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 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 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.
# Optionally [[#Layer_options|activate]] the layer.


== Tree view context menu ==
== Context menu == <!--T:16-->


=== Layer container options ===
=== Layer container options === <!--T:17-->


<!--T:18-->
For a Draft LayerContainer these additional options are available in the [[Tree_view|Tree view]] context menu:
For a Draft LayerContainer these additional options are available in the [[Tree_view|Tree view]] context menu:


<!--T:19-->
* {{MenuCommand|[[Image:Draft_Layer.svg|16px]] Merge layer duplicates}}: this option currently does not work.
* {{MenuCommand|[[Image:Draft_NewLayer.svg|16px]] Add new layer}}: adds a new layer to the current document. This option is an alternative for this command.
* {{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 ===
=== Layer options === <!--T:20-->


<!--T:21-->
For a Draft Layer these additional options are available in the [[Tree_view|Tree view]] context menu:
For a Draft Layer these additional options are available in the [[Tree_view|Tree view]] context menu:


<!--T:22-->
* {{MenuCommand|[[Image:button_right.svg|16px]] [[Draft_AutoGroup|Activate this layer]]}}: makes the selected layer the active layer.
* {{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.
* {{MenuCommand|[[Image:Draft_SelectGroup.svg|16px]] [[Draft_SelectGroup|Select layer contents]]}}: selects the objects inside the selected layer.


== Drag and drop behavior == <!--T:34-->
== Notes ==

<!--T:35-->
{{Version|0.21}}

<!--T:36-->
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 == <!--T:23-->


<!--T:15-->
<!--T:15-->
* A new layer can also be created with the [[Draft_AutoGroup|Draft AutoGroup]] command.
* 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_Module|Draft Workbench]].
* 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 == <!--T:8-->
== Properties == <!--T:8-->


<!--T:24-->
See also: [[property_editor|Property editor]].
See also: [[Property_editor|Property editor]].


<!--T:25-->
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:
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 ===
=== Data === <!--T:26-->


<!--T:27-->
{{TitleProperty|Layer}}
{{TitleProperty|Layer}}


Line 77: Line 90:
* {{PropertyData|Group|LinkList}}: specifies the objects that are inside the layer.
* {{PropertyData|Group|LinkList}}: specifies the objects that are inside the layer.


=== View ===
=== View === <!--T:28-->


<!--T:29-->
{{TitleProperty|Layer}}
{{TitleProperty|Layer}}


<!--T:30-->
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.
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.


<!--T:31-->
* {{PropertyView|Draw Style|Enumeration}}: specifies the draw style of the layer: {{value|Solid}}, {{value|Dashed}}, {{value|Dotted}} or {{value|Dashdot}}
* {{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 Color|Color}}: specifies the line color of the layer.
Line 91: Line 107:
* {{PropertyView|Transparency|Percent}}: specifies the transparency of the layer.
* {{PropertyView|Transparency|Percent}}: specifies the transparency of the layer.


<!--T:32-->
{{TitleProperty|Print}}
{{TitleProperty|Print}}


<!--T:33-->
* {{PropertyView|Line Print Color|Color}}: specifies the line print color of the layer.
* {{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 the objects inside the layer are placed on a [[TechDraw_Module|TechDraw]] page.
* {{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 == <!--T:12-->
== Scripting == <!--T:12-->


<!--T:13-->
<!--T:13-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] 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:14-->
<!--T:14-->
Line 111: Line 129:
doc = App.newDocument()
doc = App.newDocument()


layer = Draft.make_layer()
layer = Draft.make_layer(line_color=(1.0, 0.0, 0.0, 0.0),
shape_color=(1.0, 1.0, 0.0, 0.0))
lay_vobj = layer.ViewObject
lay_vobj.LineColor = (1.0, 0.0, 0.0, 0.0) # red
lay_vobj.ShapeColor = (1.0, 1.0, 0.0, 0.0) # yellow


polygon1 = Draft.make_polygon(5, radius=1000)
polygon1 = Draft.make_polygon(5, radius=1000)
Line 129: Line 145:
{{Docnav
{{Docnav
|[[Draft_ToggleGrid|ToggleGrid]]
|[[Draft_ToggleGrid|ToggleGrid]]
|[[Draft_LayerManager|LayerManager]]
|[[Draft_WorkingPlaneProxy|WorkingPlaneProxy]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_ToggleGrid.svg
|IconL=Draft_ToggleGrid.svg
|IconR=Draft_WorkingPlaneProxy.svg
|IconR=Draft_LayerManager.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}

Latest revision as of 17:27, 3 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

  1. There are several ways to invoke the command:
    • Press the Layer button.
    • Select the Utilities → Layer option from the menu.
    • If the layer container already exists: right-click it in the Tree view and select the Add new layer option from context menu.
  2. If it does not exist the layer container is created first.
  3. A layer is created and put in the layer container.
  4. Optionally change the properties of the layer.
  5. 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.
  6. Optionally activate the layer.

Context menu

Layer container options

For a Draft LayerContainer these additional options are available in the Tree view context menu:

  • Merge layer duplicates: merges all layers with the same base label.
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.
  • 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 context menu:

Drag and drop behavior

introduced in version 0.21

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

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 or Dashdot
  • 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.

Print

  • 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()