Draft Line: Difference between revisions

From FreeCAD Documentation
(Updated default shortcuts.)
 
(80 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Page_in_progress}}
<languages/>
<languages/>
<translate>
<translate>
Line 7: Line 6:
|
|
|[[Draft_Wire|Wire]]
|[[Draft_Wire|Wire]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=
|IconL=
|IconR=Draft_Wire.svg
|IconR=Draft_Wire.svg
Line 17: Line 16:
|Name=Draft Line
|Name=Draft Line
|MenuLocation=Drafting → Line
|MenuLocation=Drafting → Line
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|L}} {{KEY|I}}
|Shortcut={{KEY|L}} {{KEY|I}}
|Version=0.7
|Version=0.7
Line 26: Line 25:


<!--T:2-->
<!--T:2-->
The [[Image:Draft_Line.svg|24px]] '''Draft Line''' command creates a straight line defined by two points. It uses the [[Draft_Linestyle|Draft Linestyle]] set on the [[Draft_Tray|Draft Tray]].
The [[Image:Draft_Line.svg|24px]] '''Draft Line''' command creates a straight line.

<!--T:22-->
A Draft Line is in fact a [[Draft_Wire|Draft Wire]] with only two points.


</translate>
</translate>
Line 32: Line 34:
<translate>
<translate>
<!--T:3-->
<!--T:3-->
{{Caption|Draft Line defined by two points}}
{{Caption|Line defined by two points}}


==Usage== <!--T:21-->
==Usage== <!--T:21-->

<!--T:23-->
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]].


<!--T:4-->
<!--T:4-->
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} button.
#* Press the {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Line]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Line.svg|16px]] Line}} option from the menu.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Line.svg|16px]] Line}} option from the menu.
#* Use the keyboard shortcut: {{KEY|L}} then {{KEY|I}}.
#* Use the keyboard shortcut: {{KEY|L}} then {{KEY|I}}.
# The {{MenuCommand|Line}} task panel opens. See [[#Options|Options]] for more information.
# Click a first point in the [[3D_view|3D view]], or type [[Draft_Coordinates|coordinates]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
# Click a second point in the [[3D_view|3D view]], or type [[Draft_Coordinates|coordinates]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
# Pick the first point in the [[3D_view|3D view]], or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
# Pick the second point in the [[3D_view|3D view]], or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.


==Options==
==Options== <!--T:24-->

<!--T:25-->
The single character keyboard shortcuts available in the task panel can be changed. See [[Draft_Preferences|Draft Preferences]]. The shortcuts mentioned here are the default shortcuts (for version 0.22).


<!--T:5-->
<!--T:5-->
* To manually enter coordinates enter the X, Y and Z component, and press {{KEY|Enter}} after each. Or you can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button when you have the desired values. It is advisable to move the pointer out of the [[3D_view|3D view]] before entering coordinates.
* Press {{KEY|X}}, {{KEY|Y}} or {{KEY|Z}} after the first point to constrain the second point on the given axis.
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component.
* To use polar coordinates enter a value for the {{MenuCommand|Length}} and a value for the {{MenuCommand|Angle}}, and press {{KEY|Enter}} after each.
** You can also define the polar coordinates of the point by giving a value to "Length" and "Angle". Click on the checkbox next to "Angle" to constrain the pointer to the specified angle.
* Check the {{MenuCommand|Angle}} checkbox to constrain the pointer to the specified angle.
* Press {{KEY|L}} to change the focus from the {{MenuCommand|X}} input box to the {{MenuCommand|Length}} input box and back. Depending on the input box that receives the focus the {{MenuCommand|Angle}} checkbox is checked or unchecked.
** You can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button when you have the desired values to insert the point.
* Press {{KEY|R}} or click the checkbox to toggle ''relative'' mode. If relative mode is on, the coordinates of the second point are relative to the first one; if not, they are absolute, taken from the origin (0,0,0).
* Press {{KEY|R}} or click the {{MenuCommand|Relative}} checkbox to toggle relative mode. If relative mode is on, the coordinates of the second point are relative to the first point, else they are relative to the coordinate system origin.
* Press {{KEY|T}} or click the checkbox to toggle ''continue'' mode. If continue mode is on, the Line command will restart after you give the second point, allowing you to draw another line segment without pressing the command button again.
* Press {{KEY|G}} or click the {{MenuCommand|Global}} checkbox to toggle global mode. If global mode is on, coordinates are relative to the global coordinate system, else they are relative to the [[Draft_SelectPlane|working plane]] coordinate system. {{Version|0.20}}
* Press {{KEY|N}} or click the {{MenuCommand|Continue}} checkbox to toggle continue mode. If continue mode is on, the command will restart after finishing, allowing you to continue creating lines.
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Press {{KEY|S}} to switch [[Draft_Snap|Draft snapping]] on or off.
* Hold {{KEY|Shift}} while drawing to [[Draft_Constrain|constrain]] your second point horizontally or vertically in relation to the first one.
* Press {{KEY|Ctrl}}+{{KEY|Z}} or press the {{button|[[Image:Draft_UndoLine.svg|12px]] [[Draft_UndoLine|Undo]]}} button to undo the last point.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the command.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the command.


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


<!--T:10-->
* Draft Lines can be edited with the [[Image:Draft_Edit.svg|24px]] [[Draft_Edit|Draft Edit]] command.
* A Draft Line can be edited with the [[Draft_Edit|Draft Edit]] command.
* Draft Lines and [[Draft_Wire|Draft Wires]] can be fused with the [[Image:Draft_Wire.svg|24px]] [[Draft_Wire|Draft Wire]] command, the [[Image:Draft_Join.svg|24px]] [[Draft_Join|Draft Join]] command, or the [[Image:Draft_Upgrade.svg|24px]] [[Draft_Upgrade|Draft Upgrade]] command.
* Draft Lines and [[Draft_Wire|Draft Wires]] can be joined with the [[Draft_Wire|Draft Wire]] command, the [[Draft_Join|Draft Join]] command or the [[Draft_Upgrade|Draft Upgrade]] command.


==Preferences== <!--T:29-->
==Properties==

<!--T:30-->
See also: [[Preferences_Editor|Preferences Editor]] and [[Draft_Preferences|Draft Preferences]].

<!--T:31-->
* To change the initial focus of the task panel to the {{MenuCommand|Length}} input box: {{MenuCommand|Edit → Preferences... → Draft → General → Set focus on Length instead of X coordinate}}. Note that you must move the pointer in the [[3D_view|3D view]] for the change to take effect.
* If the {{MenuCommand|Edit → Preferences... → Draft → General → Create Part primitives if possible}} option is checked, the command will create a [[Part_Line|Part Line]] instead of a Draft Line.

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


<!--T:6-->
<!--T:6-->
See [[Draft_Wire#Properties|Draft Wire]].
Draft Line objects have the same properties as [[Draft Wire|Draft Wire objects]].


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


<!--T:7-->
<!--T:7-->
See also: [https://www.freecadweb.org/api 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:15-->
<!--T:15-->
To create a Draft Line use the {{incode|make_line}} method of the Draft module:
To create a Draft Line use the {{incode|make_line}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeLine}} method.


</translate>
</translate>
{{Code|code=
{{Code|code=
Line = make_line(p1, p2)
line = make_line(p1, p2)
Line = make_line(LineSegment)
line = make_line(LineSegment)
Line = make_line(Shape)
line = make_line(Shape)
}}
}}
<translate>
<translate>
Line 91: Line 109:
<!--T:9-->
<!--T:9-->
Example:
Example:

</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD as App
import FreeCAD as App
import Draft
import Draft

doc = App.newDocument()


p1 = App.Vector(0, 0, 0)
p1 = App.Vector(0, 0, 0)
Line 101: Line 122:
p4 = App.Vector(500, 1000, 0)
p4 = App.Vector(500, 1000, 0)


Line1 = Draft.make_line(p1, p2)
line1 = Draft.make_line(p1, p2)
Line2 = Draft.make_line(p3, p4)
line2 = Draft.make_line(p3, p4)

App.ActiveDocument.recompute()
doc.recompute()
}}
}}
<translate>
<translate>
Line 112: Line 134:
|
|
|[[Draft_Wire|Wire]]
|[[Draft_Wire|Wire]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=
|IconL=
|IconR=Draft_Wire.svg
|IconR=Draft_Wire.svg

Latest revision as of 18:16, 6 January 2024

Draft Line

Menu location
Drafting → Line
Workbenches
Draft, Arch
Default shortcut
L I
Introduced in version
0.7
See also
Draft Wire

Description

The Draft Line command creates a straight line.

A Draft Line is in fact a Draft Wire with only two points.

Line defined by two points

Usage

See also: Draft Tray, Draft Snap and Draft Constrain.

  1. There are several ways to invoke the command:
    • Press the Line button.
    • Select the Drafting → Line option from the menu.
    • Use the keyboard shortcut: L then I.
  2. The Line task panel opens. See Options for more information.
  3. Pick the first point in the 3D view, or type coordinates and press the Enter point button.
  4. Pick the second point in the 3D view, or type coordinates and press the Enter point button.

Options

The single character keyboard shortcuts available in the task panel can be changed. See Draft Preferences. The shortcuts mentioned here are the default shortcuts (for version 0.22).

  • To manually enter coordinates enter the X, Y and Z component, and press Enter after each. Or you can press the Enter point button when you have the desired values. It is advisable to move the pointer out of the 3D view before entering coordinates.
  • To use polar coordinates enter a value for the Length and a value for the Angle, and press Enter after each.
  • Check the Angle checkbox to constrain the pointer to the specified angle.
  • Press L to change the focus from the X input box to the Length input box and back. Depending on the input box that receives the focus the Angle checkbox is checked or unchecked.
  • Press R or click the Relative checkbox to toggle relative mode. If relative mode is on, the coordinates of the second point are relative to the first point, else they are relative to the coordinate system origin.
  • Press G or click the Global checkbox to toggle global mode. If global mode is on, coordinates are relative to the global coordinate system, else they are relative to the working plane coordinate system. introduced in version 0.20
  • Press N or click the Continue checkbox to toggle continue mode. If continue mode is on, the command will restart after finishing, allowing you to continue creating lines.
  • Press S to switch Draft snapping on or off.
  • Press Esc or the Close button to abort the command.

Notes

Preferences

See also: Preferences Editor and Draft Preferences.

  • To change the initial focus of the task panel to the Length input box: Edit → Preferences... → Draft → General → Set focus on Length instead of X coordinate. Note that you must move the pointer in the 3D view for the change to take effect.
  • If the Edit → Preferences... → Draft → General → Create Part primitives if possible option is checked, the command will create a Part Line instead of a Draft Line.

Properties

See Draft Wire.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft Line use the make_line method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeLine method.

line = make_line(p1, p2)
line = make_line(LineSegment)
line = make_line(Shape)
  • Creates a Line object between points p1 and p2, each defined by its FreeCAD.Vector, with units in millimeters.
  • Creates a Line object from a Part.LineSegment.
  • Creates a Line object from the first vertex to the last vertex of the given Shape.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

p1 = App.Vector(0, 0, 0)
p2 = App.Vector(1000, 500, 0)
p3 = App.Vector(-250, -500, 0)
p4 = App.Vector(500, 1000, 0)

line1 = Draft.make_line(p1, p2)
line2 = Draft.make_line(p3, p4)

doc.recompute()