Draft Ellipse: Difference between revisions

From FreeCAD Documentation
No edit summary
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Page_in_progress}}
<languages/>
<languages/>
<translate>
<translate>

<!--T:19-->
<!--T:19-->
{{Docnav
{{Docnav
|[[Draft_Arc|Arc]]
|[[Draft_Circle|Circle]]
|[[Draft_Rectangle|Rectangle]]
|[[Draft_Polygon|Polygon]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft_Arc.svg
|IconL=Draft_Circle.svg
|IconR=Draft_Polygon.svg
|IconR=Draft_Rectangle.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 14: Line 16:
{{GuiCommand
{{GuiCommand
|Name=Draft Ellipse
|Name=Draft Ellipse
|MenuLocation=Draft → Ellipse
|MenuLocation=Drafting → Ellipse
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Shortcut={{KEY|E}} {{KEY|L}}
|Shortcut={{KEY|E}} {{KEY|L}}
|Version=0.7
|Version=0.7
|SeeAlso=[[Draft_Circle|Draft Circle]], [[Draft_Arc|Draft Arc]]
}}
}}


Line 24: Line 25:


<!--T:3-->
<!--T:3-->
The Ellipse tool creates an ellipse in the current [[Draft_SelectPlane|work plane]] by entering two points, defining the corners of a rectangular box in which the ellipse will fit. It uses the [[Draft_Linestyle|Draft Linestyle]] set on the [[Draft_Tray|Draft Tray]].
The [[Image:Draft_Ellipse.svg|24px]] [[Draft_Ellipse|Draft Ellipse]] command creates an ellipse in the current [[Draft_SelectPlane|working plane]] by entering two points, defining the corners of a rectangular box in which the ellipse will fit. It uses the [[Draft_Linestyle|Draft Linestyle]] set on the [[Draft_Tray|Draft Tray]].


<!--T:14-->
<!--T:14-->
A Draft Ellipse can be turned into an elliptical arc by setting its {{PropertyData|First Angle}} and {{PropertyData|Last Angle}} properties to different values.
This tool can also be used to create elliptical arcs by specifying the start and end angles. To create circles and circular arcs use the [[Draft Circle|Draft Circle]] and [[Draft Arc|Draft Arc]] tools. You can also approximate an elliptical or circular arc using the [[Draft BSpline|Draft BSpline]] and [[Draft BezCurve|Draft BezCurve]] tools.


</translate>
</translate>
Line 38: Line 39:


<!--T:5-->
<!--T:5-->
# There are several ways to invoke the command:
# Press the {{Button|[[Image:Draft_Ellipse.svg|16px]] [[Draft Ellipse|Draft Ellipse]]}} button, or press {{KEY|E}} then {{KEY|L}} keys.
# Click a first point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.
#* Press the {{Button|[[Image:Draft_Ellipse.svg|16px]] [[Draft_Ellipse|Draft Ellipse]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Ellipse.svg|16px]] Ellipse}} option from the menu.
# Click a second point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.
#* Use the keyboard shortcut: {{KEY|E}} then {{KEY|L}}.

# Click the 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.
<!--T:15-->
# Click the 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.
The ellipse can be turned into an elliptical arc after creation, by setting its first angle and last angle properties to different values.


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


<!--T:7-->
<!--T:7-->
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component. You can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button when you have the desired values to insert the point.
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component. 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 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|T}} or click the checkbox to toggle ''continue'' mode. If continue mode is on, the Ellipse tool will restart after you finish the shape, allowing you to draw another one without pressing the tool button again.
* Press {{KEY|T}} or click the checkbox to toggle ''continue'' mode. If continue mode is on, the Ellipse command will restart after you finish the shape, allowing you to draw another one without pressing the command button again.
* Press {{KEY|L}} or click the checkbox to toggle ''filled'' mode. If filled mode is on, the ellipse will create a filled face ({{PropertyData|Make Face}} {{TRUE}}); if not, the ellipse will not make a face ({{PropertyData|Make Face}} {{FALSE}}).
* Press {{KEY|L}} or click the checkbox to toggle ''filled'' mode. If filled mode is on, the ellipse will create a filled face ({{PropertyData|Make Face}} {{TRUE}}); if not, the ellipse will not make a face ({{PropertyData|Make Face}} {{FALSE}}).
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Hold {{KEY|Shift}} while drawing to [[Draft_Constrain|constrain]] your second point horizontally or vertically in relation to the first one.
* Hold {{KEY|Shift}} while drawing to [[Draft_Constrain|constrain]] your second point horizontally or vertically in relation to the first one.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.

==Notes==

* A Draft Ellipse can be edited with the [[Draft_Edit|Draft Edit]] command.


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


See also: [[property_editor|Property editor]].
<!--T:16-->
An Ellipse object shares many properties with a [[Draft Circle|Draft Circle]], but some properties only make sense for the ellipse.


A Draft Ellipse object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:
===Data=== <!--T:9-->
* {{PropertyData|First Angle}}: specifies the angle of the first point of the ellipse; normally 0&#176;.
* {{PropertyData|Last Angle}}: specifies the angle of the last point of the ellipse; normally 0&#176;.
* {{PropertyData|Major Radius}}: specifies the major radius of the ellipse.
* {{PropertyData|Minor Radius}}: specifies the minor radius of the ellipse.
:If the both radius have the same value, the ellipse looks the same as a [[Draft Circle|Draft Circle]].
* {{PropertyData|Make Face}}: specifies if the Ellipse makes a face or not. If it is {{TRUE}} a face is created, otherwise only the perimeter is considered part of the object. This property only works if the shape is a full ellipse.
:For it to be a full ellipse {{PropertyData|First Angle}} and {{PropertyData|Last Angle}} should have the same value; otherwise, an elliptical arc is displayed. The values 0&#176; and 360&#176; are considered the same.


===View=== <!--T:13-->
===Data===
* {{PropertyView|Pattern}}: specifies a [[Draft Pattern|Draft Pattern]] with which to fill the face of the shape. This property only works if {{PropertyData|Make Face}} is {{TRUE}}, and if {{PropertyView|Display Mode}} is "Flat Lines".
* {{PropertyView|Pattern Size}}: specifies the size of the [[Draft Pattern|Draft Pattern]].


{{TitleProperty|Draft}}
==Scripting== <!--T:10-->

{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
<!--T:9-->
* {{PropertyData|Area|Area}}: (read-only) specifies the area of the face of the ellipse. The value will be {{value|0.0}} if {{PropertyData|Make Face}} if {{FALSE}} or the face cannot be created.
* {{PropertyData|First Angle|Angle}}: specifies the angle of the first point of the ellipse, normally {{value|0&#176;}}.
* {{PropertyData|Last Angle|Angle}}: specifies the angle of the last point of the ellipse, normally {{value|0&#176;}}.
* {{PropertyData|Major Radius|Length}}: specifies the major radius of the ellipse.
* {{PropertyData|Make Face|Bool}}: specifies if the ellipse makes a face or not. If it is {{TRUE}} a face is created, otherwise only the perimeter is considered part of the object. This property only works if the shape is a full ellipse.
* {{PropertyData|Minor Radius|Length}}: specifies the minor radius of the ellipse.

===View===

{{TitleProperty|Draft}}

<!--T:13-->
* {{PropertyView|Pattern|Enumeration}}: specifies the [[Draft_Pattern|Draft Pattern]] with which to fill the face of the ellipse. This property only works if {{PropertyData|Make Face}} is {{TRUE}} and if {{PropertyView|Display Mode}} is {{value|Flat Lines}}.
* {{PropertyView|Pattern Size|Float}}: specifies the size of the [[Draft_Pattern|Draft Pattern]].

==Scripting==

<!--T:10-->
See also: [https://www.freecadweb.org/api Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


<!--T:17-->
<!--T:17-->
To create a Draft Ellipse use the {{incode|make_ellipse}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeEllipse}} method.
The Ellipse tool can by used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:

</translate>
</translate>
{{Code|code=
{{Code|code=
Ellipse = makeEllipse(majradius, minradius, placement=None, face=True, support=None)
ellipse = make_ellipse(majradius, minradius, placement=None, face=True, support=None)
}}
}}
<translate>
<translate>


<!--T:11-->
<!--T:11-->
* Creates an {{incode|Ellipse}} object with given major ({{incode|majradius}}) and minor ({{incode|minradius}}) radius in millimeters.
* Creates an {{incode|ellipse}} object with given major ({{incode|majradius}}) and minor ({{incode|minradius}}) radius in millimeters.
** The bigger value will be used for the major radius (X axis) if no other placement is given.
** The bigger value will be used for the major radius (X axis) if no other placement is given.
* If a {{incode|placement}} is given, it is used; otherwise the shape is created at the origin.
* If {{incode|placement}} is {{incode|None}} the shape is created at the origin.
* If {{incode|face}} is {{incode|True}}, the ellipse will make a face, that is, it will appear filled.
* If {{incode|face}} is {{incode|True}}, the ellipse will make a face, that is, it will appear filled.


<!--T:12-->
<!--T:12-->
Example:
Example:

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


doc = App.newDocument()
Ellipse1 = Draft.makeEllipse(3000, 200)
Ellipse2 = Draft.makeEllipse(700, 1000)


ellipse1 = Draft.make_ellipse(3000, 200)
ZAxis = FreeCAD.Vector(0, 0, 1)
p3 = FreeCAD.Vector(1000, 1000, 0)
ellipse2 = Draft.make_ellipse(700, 1000)
place3 = FreeCAD.Placement(p3, FreeCAD.Rotation(ZAxis, 90))


zaxis = App.Vector(0, 0, 1)
Ellipse3 = Draft.makeEllipse(700, 1000, placement=place3)
p3 = App.Vector(1000, 1000, 0)
place3 = App.Placement(p3, App.Rotation(zaxis, 90))

ellipse3 = Draft.make_ellipse(700, 1000, placement=place3)

doc.recompute()
}}
}}
<translate>
<translate>



<!--T:18-->
<!--T:18-->
{{Docnav
{{Docnav
|[[Draft_Arc|Arc]]
|[[Draft_Circle|Circle]]
|[[Draft_Rectangle|Rectangle]]
|[[Draft_Polygon|Polygon]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft_Arc.svg
|IconL=Draft_Circle.svg
|IconR=Draft_Polygon.svg
|IconR=Draft_Rectangle.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 121: Line 144:
{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 09:19, 30 March 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 Ellipse

Menu location
Drafting → Ellipse
Workbenches
Draft, Arch
Default shortcut
E L
Introduced in version
0.7
See also
None

Description

The Draft Ellipse command creates an ellipse in the current working plane by entering two points, defining the corners of a rectangular box in which the ellipse will fit. It uses the Draft Linestyle set on the Draft Tray.

A Draft Ellipse can be turned into an elliptical arc by setting its DataFirst Angle and DataLast Angle properties to different values.

Ellipse defined by the rectangle corners

Usage

  1. There are several ways to invoke the command:
    • Press the Draft Ellipse button.
    • Select the Drafting → Ellipse option from the menu.
    • Use the keyboard shortcut: E then L.
  2. Click the first point in the 3D view, or type coordinates and press the Enter point button.
  3. Click the second point in the 3D view, or type coordinates and press the Enter point button.

Options

  • To enter coordinates manually, simply enter the numbers, then press Enter between each X, Y and Z component. You can press the Enter point button when you have the desired values to insert the point.
  • Press 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 T or click the checkbox to toggle continue mode. If continue mode is on, the Ellipse command will restart after you finish the shape, allowing you to draw another one without pressing the command button again.
  • Press L or click the checkbox to toggle filled mode. If filled mode is on, the ellipse will create a filled face (DataMake Face true); if not, the ellipse will not make a face (DataMake Face false).
  • Hold Ctrl while drawing to force snapping your point to the nearest snap location, independently of the distance.
  • Hold Shift while drawing to constrain your second point horizontally or vertically in relation to the first one.
  • Press Esc or the Close button to abort the current command.

Notes

  • A Draft Ellipse can be edited with the Draft Edit command.

Properties

See also: Property editor.

A Draft Ellipse object is derived from a Part Part2DObject and inherits all its properties. It also has the following additional properties:

Data

Draft

  • DataArea (Area): (read-only) specifies the area of the face of the ellipse. The value will be 0.0 if DataMake Face if false or the face cannot be created.
  • DataFirst Angle (Angle): specifies the angle of the first point of the ellipse, normally .
  • DataLast Angle (Angle): specifies the angle of the last point of the ellipse, normally .
  • DataMajor Radius (Length): specifies the major radius of the ellipse.
  • DataMake Face (Bool): specifies if the ellipse makes a face or not. If it is true a face is created, otherwise only the perimeter is considered part of the object. This property only works if the shape is a full ellipse.
  • DataMinor Radius (Length): specifies the minor radius of the ellipse.

View

Draft

  • ViewPattern (Enumeration): specifies the Draft Pattern with which to fill the face of the ellipse. This property only works if DataMake Face is true and if ViewDisplay Mode is Flat Lines.
  • ViewPattern Size (Float): specifies the size of the Draft Pattern.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft Ellipse use the make_ellipse method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeEllipse method.

ellipse = make_ellipse(majradius, minradius, placement=None, face=True, support=None)
  • Creates an ellipse object with given major (majradius) and minor (minradius) radius in millimeters.
    • The bigger value will be used for the major radius (X axis) if no other placement is given.
  • If placement is None the shape is created at the origin.
  • If face is True, the ellipse will make a face, that is, it will appear filled.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

ellipse1 = Draft.make_ellipse(3000, 200)
ellipse2 = Draft.make_ellipse(700, 1000)

zaxis = App.Vector(0, 0, 1)
p3 = App.Vector(1000, 1000, 0)
place3 = App.Placement(p3, App.Rotation(zaxis, 90))

ellipse3 = Draft.make_ellipse(700, 1000, placement=place3)

doc.recompute()