Part Ellipse/en: Difference between revisions

Latest revision as of 10:26, 3 March 2022

Other languages:

Circle

Point

Part

Menu location
Part Ellipse
Part → Create primitives → Ellipse
Workbenches
Part, OpenSCAD
Default shortcut
None
Introduced in version
-
See also
Part Primitives

Description

A Part Ellipse is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement property, the ellipse lies on the XY plane with its center at the origin. Its mayor axis is parallel to the X axis.

A Part Ellipse is in fact a closed counterclockwise elliptical arc, it can be turned into an arc by changing its DataAngle1 and/or DataAngle2 properties.

Usage

See Part Primitives.

Example

A Part Ellipse object created with the scripting example below is shown here.

Properties

Data

Attachment

The object has the same attachment properties as a Part Part2DObject.

Base

DataMajorRadius (Length): The major radius of the ellipse or elliptical arc. The default is 4mm.
DataMinorRadius (Length): The minor radius of the ellipse or elliptical arc. The default is 2mm.
DataAngle1 (Angle): The start angle of the elliptical arc. Valid range: 0° < value <= 360°. The default is 0°.
DataAngle2 (Angle): The end angle of the elliptical arc. Valid range: 0° < value <= 360°. The default is 360°. If DataAngle1 and DataAngle2 are equal, or if one angle is 0° and the other 360°, a full ellipse is created.

Scripting

A Part Ellipse can be created with the addObject() method of the document:

ellipse = FreeCAD.ActiveDocument.addObject("Part::Ellipse", "myEllipse")

Where "myEllipse" is the name for the object.
The function returns the newly created object.

Example:

import FreeCAD as App

doc = App.activeDocument()

ellipse = doc.addObject("Part::Ellipse", "myEllipse")
ellipse.MajorRadius = 20
ellipse.MinorRadius = 10
ellipse.Angle1 = 45
ellipse.Angle2 = 135
ellipse.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(30, 45, 10))

doc.recompute()

Circle

Point

Part

Primitives: Box, Cylinder, Sphere, Cone, Torus, Tube, Create primitives, Shape builder

Creation and modification: Extrude, Revolve, Mirror, Fillet, Chamfer, Make face from wires, Ruled Surface, Loft, Sweep, Section, Cross sections, 3D Offset, 2D Offset, Thickness, Projection on surface, Attachment

Boolean: Make compound, Explode Compound, Compound Filter, Boolean, Cut, Fuse, Common, Connect, Embed, Cutout, Boolean fragments, Slice apart, Slice, XOR

Measure: Measure Linear, Measure Angular, Measure Refresh, Clear All, Toggle All, Toggle 3D, Toggle Delta

Other tools: Import, Export, Box selection, Shape from Mesh, Points from mesh, Convert to solid, Reverse shapes, Create simple copy, Create transformed copy, Create shape element copy, Refine shape, Check geometry, Defeaturing, Appearance, Color per face

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
 <languages/>
-{{UnfinishedDocu{{#translation:}}}}
 {{Docnav
@@ Line 20: / Line 19: @@
 == Description ==
+A [[Image:Part_Ellipse.svg|24px]] '''Part Ellipse''' is a parametric shape that can be created with the [[Image:Part_Primitives.svg|24px]] [[Part_Primitives|Part Primitives]] command. In the coordinate system defined by its {{PropertyData|Placement}} property, the ellipse lies on the XY plane with its center at the origin. Its mayor axis is parallel to the X axis.
-This command will create a elliptical curved edge. With the default values, the elliptical curved edge will be closed and therefore will be an ellipse. If the properties Angle 1 or Angle 2 are changed from their default values (0 and 360) the edge will be an open curve.
+A Part Ellipse is in fact a closed counterclockwise elliptical arc, it can be turned into an arc by changing its {{PropertyData|Angle1}} and/or {{PropertyData|Angle2}} properties.
+[[Image:Part_Ellipse_Example.png|400px]]
 == Usage ==
+See [[Part_Primitives#Usage|Part Primitives]].
-The Create Primitives dialogue can be accessed via the [[Part_Primitives|Primitives]] icon [[Image:Part_Primitives.svg|32px]] located in the Part menu or the Part toolbar, in the Part Workbench.
+== Example ==
+[[Image:Part_Ellipse_Scripting_Example.png|thumb|Part Ellipse from the scripting example]]
-==Properties==
-* '''Major radius:''' the major radius of the ellipse, the default value is 4
+A Part Ellipse object created with the [[#Scripting|scripting example]] below is shown here.
-* '''Minor radius:''' the minor radius of the ellipse, the default value is 2
-* '''Angle 1:''' start of the edge of the ellipse or elliptical curved edge, (degrees anti-clockwise), the default value is 0
+== Properties ==
-* '''Angle 2:''' end of the edge  of the ellipse or elliptical curved edge, (degrees anti-clockwise), the default value is 360
+See also: [[Property_editor|Property editor]].
+A Part Ellipse object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties:
+=== Data ===
+{{TitleProperty|Attachment}}
+The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]].
+{{TitleProperty|Base}}
+* {{PropertyData|MajorRadius|Length}}: The major radius of the ellipse or elliptical arc. The default is {{Value|4mm}}.
+* {{PropertyData|MinorRadius|Length}}: The minor radius of the ellipse or elliptical arc. The default is {{Value|2mm}}.
+* {{PropertyData|Angle1|Angle}}: The start angle of the elliptical arc. Valid range: {{Value|0° &lt; value &lt;&#61; 360°}}. The default is {{Value|0°}}.
+* {{PropertyData|Angle2|Angle}}: The end angle of the elliptical arc. Valid range: {{Value|0° &lt; value &lt;&#61; 360°}}. The default is {{Value|360°}}. If {{PropertyData|Angle1}} and {{PropertyData|Angle2}} are equal, or if one angle is {{Value|0°}} and the other {{Value|360°}}, a full ellipse is created.
+== Scripting ==
+See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
+A Part Ellipse can be created with the {{Incode|addObject()}} method of the document:
+{{Code|code=
+ellipse = FreeCAD.ActiveDocument.addObject("Part::Ellipse", "myEllipse")
+}}
+* Where {{Incode|"myEllipse"}} is the name for the object.
+* The function returns the newly created object.
+Example:
+{{Code|code=
+import FreeCAD as App
+doc = App.activeDocument()
+ellipse = doc.addObject("Part::Ellipse", "myEllipse")
+ellipse.MajorRadius = 20
+ellipse.MinorRadius = 10
+ellipse.Angle1 = 45
+ellipse.Angle2 = 135
+ellipse.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(30, 45, 10))
+doc.recompute()
+}}
@@ Line 43: / Line 94: @@
 }}
-{{Part Tools navi{{#translation:}}}}
+{{Part_Tools_navi{{#translation:}}}}
 {{Userdocnavi{{#translation:}}}}