Draft Ellipse: Difference between revisions

From FreeCAD Documentation
(See also Draft Arc)
mNo edit summary
 
(80 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:19-->
{{Docnav
|[[Draft_Circle|Circle]]
|[[Draft_Rectangle|Rectangle]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Circle.svg
|IconR=Draft_Rectangle.svg
|IconC=Workbench_Draft.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Draft Ellipse|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|MenuLocation=Draft → Ellipse|Shortcut=E L|SeeAlso=[[Draft Circle|Draft Circle]], [[Draft Arc]]}}
|Name=Draft Ellipse
|MenuLocation=Drafting → Ellipse
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|E}} {{KEY|L}}
|Version=0.7
}}


==Description== <!--T:2-->
==Description== <!--T:2-->


<!--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]] set on the [[Draft Tray]].
The [[Image:Draft_Ellipse.svg|24px]] '''Draft Ellipse''' command creates an ellipse on the current [[Draft_SelectPlane|working plane]] from two points defining a rectangle in which the ellipse will fit.


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

</translate>
[[Image:Draft_ellipse_example.jpg|400px]]
[[Image:Draft_ellipse_example.jpg|400px]]
<translate>
<!--T:4-->
{{Caption|Ellipse defined by the corners of a rectangle}}


==How to use== <!--T:5-->
==Usage== <!--T:22-->
# Press the {{KEY|[[Image:Draft Ellipse.png|16px]] [[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]]
# Click a second point on the 3D view, or type a [[Draft_Coordinates|coordinate]]


<!--T:23-->
The ellipse can be turned into an elliptical arc after creation, by setting its first angle and last angle properties to different values.
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]].

<!--T:5-->
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Ellipse.svg|16px]] [[Draft_Ellipse|Ellipse]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Ellipse.svg|16px]] Ellipse}} option from the menu.
#* Use the keyboard shortcut: {{KEY|E}} then {{KEY|L}}.
# The {{MenuCommand|Ellipse}} task panel opens. See [[#Options|Options]] for more information.
# 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. This point must not be constrained to the X, Y or Z axis.


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

<!--T:24-->
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:7-->
<!--T:7-->
* 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.
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component.
* 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|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|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|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|F}} or click the {{MenuCommand|Filled}} checkbox to toggle filled mode. If filled mode is on, the created ellipse will have {{PropertyData|Make Face}} set to {{TRUE}} and will have a filled face.
* Press {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* 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 ellipses.
* Press {{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|Cancel}} button to abort the current command.
* Press {{KEY|S}} to switch [[Draft_Snap|Draft snapping]] on or off.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the command.

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

<!--T:26-->
* A Draft Ellipse can be edited with the [[Draft_Edit|Draft Edit]] command.

==Preferences== <!--T:34-->

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

<!--T:36-->
* If the {{MenuCommand|Edit → Preferences... → Draft → General → Create Part primitives if possible}} option is checked, the command will create a [[Part_Ellipse|Part Ellipse]] instead of a Draft Ellipse.


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


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


===Data===<!--T:9-->
<!--T:28-->
A Draft Ellipse object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:
* {{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]].
* {{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=== <!--T:29-->
* {{PropertyView|Pattern}}: specifies a [[Draft Pattern]] with which to fill the face of the ellipse. This property only works if {{PropertyData|Make Face}} is {{TRUE}}.
* {{PropertyView|Pattern Size}}: specifies the size of the [[Draft Pattern]].


==Scripting== <!--T:10-->
<!--T:30-->
{{TitleProperty|Draft}}
{{emphasis|See also:}} [[FreeCAD Scripting Basics]], [[Draft API]], and the [https://www.freecadweb.org/api autogenerated API documentation].

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

<!--T:32-->
{{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:33-->

<!--T:10-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].

<!--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]] and from the [[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.
* If {{incode|placement}} is {{incode|None}} the ellipse 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)
rotation90 = App.Placement(App.Vector(0,0,0), App.Rotation(App.Vector(0,0,1),90))
Ellipse3 = Draft.makeEllipse(700, 1000, placement=rotation90)
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()
}}
}}
<translate>
{{clear}}

[[Category:Draft]]

<!--T:18-->
{{Docnav
|[[Draft_Circle|Circle]]
|[[Draft_Rectangle|Rectangle]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Circle.svg
|IconR=Draft_Rectangle.svg
|IconC=Workbench_Draft.svg
}}

</translate>
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 10:05, 30 January 2024

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 on the current working plane from two points defining a rectangle in which the ellipse will fit.

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 corners of a rectangle

Usage

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

  1. There are several ways to invoke the command:
    • Press the Ellipse button.
    • Select the Drafting → Ellipse option from the menu.
    • Use the keyboard shortcut: E then L.
  2. The Ellipse 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. This point must not be constrained to the X, Y or Z axis.

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.
  • 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 F or click the Filled checkbox to toggle filled mode. If filled mode is on, the created ellipse will have DataMake Face set to true and will have a filled face.
  • 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 ellipses.
  • Press S to switch Draft snapping on or off.
  • Press Esc or the Close button to abort the command.

Notes

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

Preferences

See also: Preferences Editor and Draft Preferences.

  • If the Edit → Preferences... → Draft → General → Create Part primitives if possible option is checked, the command will create a Part Ellipse instead of a Draft Ellipse.

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