Draft Ellipse: Difference between revisions

From FreeCAD Documentation
(link to draft pattern)
m (Docnav)
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
<!--T:19-->
{{Docnav|[[Draft_Arc|Arc]]|[[Draft_Polygon|Polygon]]|[[Draft_Module|Draft]]|IconL=Draft_Arc.svg |IconC=Workbench_Draft.svg|IconR=Draft_Polygon.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]]}}
|Name=Draft Ellipse
|MenuLocation=Draft → Ellipse
|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]
|Shortcut=E L
|SeeAlso=[[Draft Circle|Draft Circle]], [[Draft Arc]]
|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 corner of a rectangular box in which the ellipse will fit. It takes the [[Draft Linestyle|linewidth and color]] previously set on the Tasks tab.
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]].


<!--T:4-->
<!--T:14-->
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]] and [[Draft Arc]] tools. You can also approximate an elliptical or circular arc using the [[Draft BSpline]] and [[Draft BezCurve]] tools.

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


==How to use== <!--T:5-->
==How to use== <!--T:5-->
# Press the {{KEY|[[Image:Draft Ellipse.png|16px]] [[Draft Ellipse]]}} button, or press {{KEY|E}} then {{KEY|L}} keys
# Press the {{Button|[[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 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.
# Click a second 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]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.

<!--T:15-->
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.
* 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.
* Press {{KEY|T}} or click the checkbox to check/uncheck the {{KEY|'''Continue'''}} button. If continue mode is on, the Ellipse tool will restart after you give the second point, allowing you to draw another ellipse without pressing the Ellipse button again.
* 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|CTRL}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* 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|SHIFT}} while drawing to [[Draft_Constrain|constrain]] your second point horizontally or vertically in relation to the first one.
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Press {{KEY|I}} or the {{KEY|'''Filled'''}} button to have the ellipse to appear as a face after it has been closed. This simply sets the View->Property of the ellipse to "Flat lines" or "Wireframe", so it can easily be changed later.
* 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 {{KEY|'''Cancel'''}} button to abort the command.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.
* Ellipses, when in "Flat Lines" display mode, can display a hatch pattern, by setting their "Pattern" property below.


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


<!--T:9-->
<!--T:16-->
An Ellipse object shares many properties with a [[Draft Circle]], but some properties only make sense for the ellipse.
* {{PropertyData|Major Radius}}: The major radius of the ellipse
* {{PropertyData|Minor Radius}}: The minor radius of the ellipse
* {{PropertyView|Pattern}}: Specifies a hatch pattern to fill the ellipse with
* {{PropertyView|Pattern Size}}: Specifies the size of the hatch pattern


===Data=== <!--T:9-->
See also [[Draft Pattern|Draft Pattern]] page.
* {{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-->
* {{PropertyView|Pattern}}: specifies a [[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]].


==Scripting== <!--T:10-->
==Scripting== <!--T:10-->
{{Emphasis|See also:}} [[Draft API]] and [[FreeCAD Scripting Basics]].
The Ellipse tool can by used in [[macros]] and from the python console by using the following function:

<!--T:17-->
The Ellipse tool can by used in [[macros]] and from the [[Python]] console by using the following function:
</translate>
</translate>
{{Code|code=
<syntaxhighlight>
Ellipse = makeEllipse(majradius, minradius, placement=None, face=True, support=None)
makeEllipse (majorradius, minorradius, [placement], [facemode])
}}
</syntaxhighlight>
<translate>
<translate>

<!--T:11-->
<!--T:11-->
* Creates an ellipse object with given major and minor radius.
* 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.
* If a placement is given, it is used.
* If a {{incode|placement}} is given, it is used; otherwise the shape is created at the origin.
* If facemode is False, the ellipse is shown as a wireframe, otherwise as a face.
* If {{incode|face}} is {{incode|True}}, the ellipse will make a face, that is, it will appear filled.
* Returns the newly created object.


<!--T:12-->
<!--T:12-->
Example:
Example:
</translate>
</translate>
{{Code|code=
<syntaxhighlight>
import Draft
import FreeCAD, Draft
myEllipse = Draft.makeEllipse(4,2)


Ellipse1 = Draft.makeEllipse(3000, 200)
</syntaxhighlight>
Ellipse2 = Draft.makeEllipse(700, 1000)

ZAxis = FreeCAD.Vector(0, 0, 1)
p3 = FreeCAD.Vector(1000, 1000, 0)
place3 = FreeCAD.Placement(p3, FreeCAD.Rotation(ZAxis, 90))

Ellipse3 = Draft.makeEllipse(700, 1000, placement=place3)
}}
<translate>

<!--T:18-->
{{Docnav|[[Draft_Arc|Arc]]|[[Draft_Polygon|Polygon]]|[[Draft_Module|Draft]]|IconL=Draft_Arc.svg |IconC=Workbench_Draft.svg|IconR=Draft_Polygon.svg }}

<!--T:20-->
{{Draft Tools navi}}

<!--T:21-->
{{Userdocnavi}}
</translate>
{{clear}}
{{clear}}
<languages/>

Revision as of 19:50, 11 February 2019

Draft Ellipse

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

Description

The Ellipse tool creates an ellipse in the current 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.

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 and Draft Arc tools. You can also approximate an elliptical or circular arc using the Draft BSpline and Draft BezCurve tools.

Ellipse defined by the rectangle corners

How to use

  1. Press the Draft Ellipse button, or press E then L keys.
  2. Click a first point on the 3D view, or type a coordinate and press the add point button.
  3. Click a second point on the 3D view, or type a coordinate and press the add 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

  • To enter coordinates manually, simply enter the numbers, then press Enter between each X, Y and Z component. You can press the add 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 tool will restart after you finish the shape, allowing you to draw another one without pressing the tool 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.

Properties

An Ellipse object shares many properties with a Draft Circle, but some properties only make sense for the ellipse.

Data

  • DataFirst Angle: specifies the angle of the first point of the ellipse; normally 0°.
  • DataLast Angle: specifies the angle of the last point of the ellipse; normally 0°.
  • DataMajor Radius: specifies the major radius of the ellipse.
  • DataMinor 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.
  • DataMake 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 DataFirst Angle and DataLast Angle should have the same value; otherwise, an elliptical arc is displayed. The values 0° and 360° are considered the same.

View

  • ViewPattern: specifies a Draft Pattern with which to fill the face of the shape. This property only works if DataMake Face is true, and if ViewDisplay Mode is "Flat Lines".
  • ViewPattern Size: specifies the size of the Draft Pattern.

Scripting

See also: Draft API and FreeCAD Scripting Basics.

The Ellipse tool can by used in macros and from the Python console by using the following function:

Ellipse = makeEllipse(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 a placement is given, it is used; otherwise 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, Draft

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

ZAxis = FreeCAD.Vector(0, 0, 1)
p3 = FreeCAD.Vector(1000, 1000, 0)
place3 = FreeCAD.Placement(p3, FreeCAD.Rotation(ZAxis, 90))

Ellipse3 =  Draft.makeEllipse(700, 1000, placement=place3)