Draft Layer: Difference between revisions

From FreeCAD Documentation
(Properties...)
(Properties...)
Line 50: Line 50:


<!--T:9-->
<!--T:9-->
* {{PropertyData|Group|LinkList}}: specifies the elements that are part of the group.
* {{PropertyData|Group|LinkList}}: specifies the objects that are inside the layer.


=== View ===
=== View ===
Line 56: Line 56:
{{TitleProperty|Layer}}
{{TitleProperty|Layer}}


Changes to the properties in this group are propagated to the objects inside the layer. For two properties, {{PropertyView|Line Color}} and {{PropertyView|Shape Color}}, this behavior is optional.
* {{PropertyView|Draw Style|Enumeration}}: {{value|Solid}}, {{value|Dashed}}, {{value|Dotted}}, {{value|Dashdot}}

* {{PropertyView|Line Color|Color}}
* {{PropertyView|Draw Style|Enumeration}}: specifies the draw style of the layer: {{value|Solid}}, {{value|Dashed}}, {{value|Dotted}} or {{value|Dashdot}}
* {{PropertyView|Line Width|Float}}
* {{PropertyView|Override Line Color Children|Bool}}
* {{PropertyView|Line Color|Color}}: specifies the line color of the layer.
* {{PropertyView|Override Shape Color Children|Bool}}
* {{PropertyView|Line Width|Float}}: specifies the line width of the layer.
* {{PropertyView|Shape Color|Color}}
* {{PropertyView|Override Line Color Children|Bool}}: specifies if the objects inside the layer adopt the {{PropertyView|Line Color}} of the layer.
* {{PropertyView|Override Shape Color Children|Bool}}: specifies if the objects inside the layer adopt the{{PropertyView|Shape Color}} of the layer.
* {{PropertyView|Transparency|Integer}}
* {{PropertyView|Shape Color|Color}}: specifies the shape color of the layer.
* {{PropertyView|Transparency|Integer}}: specifies the transparency of the layer.


{{TitleProperty|Print}}
{{TitleProperty|Print}}


* {{PropertyView|Line Print Color|Color}}
* {{PropertyView|Line Print Color|Color}}
* {{PropertyView|Use Print Color|Bool}}
* {{PropertyView|Use Print Color|Bool}}: specifies if the {{PropertyView|Line Print Color|}} is used when the objects inside the layer are placed on a [[TechDraw_Module|TechDraw]] page.


== Scripting == <!--T:12-->
== Scripting == <!--T:12-->

Revision as of 17:23, 4 August 2021

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Draft Layer

Menu location
Utilities → Layer
Workbenches
Draft, Arch
Default shortcut
None
Introduced in version
0.19
See also
None

Description

The 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.

This tool replaces Draft VisGroup starting from FreeCAD 0.19.

Note: The BIM Workbench offers a complete layer manager tool, which will eventually be included in Draft.

Usage

  1. Go to the menu Draft → Utilities → Layer. This adds a new layer. If it is a the first layer, a Layers object will be created too, which contains all the layers.
  2. To add objects you can drag them into the layer. This will remove the objects from there original layer. If you want to have an object in several layers, e.g. to control the visibility of different sets of objects, you have to edit the Group property of the layer. Click the button occurring to the right and select/deselect the objects you want to have in or out of the layer.
  3. Change the desired view properties of the Layer.

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

Changes to the properties in this group are propagated to the objects inside the layer. 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 the objects inside the layer adopt the ViewLine Color of the layer.
  • ViewOverride Shape Color Children (Bool): specifies if the objects inside the layer adopt theViewShape Color of the layer.
  • ViewShape Color (Color): specifies the shape color of the layer.
  • ViewTransparency (Integer): specifies the transparency of the layer.

Print

  • ViewLine Print Color (Color)
  • ViewUse Print Color (Bool): specifies if the ViewLine Print Color is used when the objects inside the layer are placed on a TechDraw page.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a 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()
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)
polygon2 = Draft.make_polygon(3, radius=500)
polygon3 = Draft.make_polygon(6, radius=220)
layer.Group = [polygon1, polygon2, polygon3]

doc.recompute()