Part Ellipse

From FreeCAD Documentation
Revision as of 15:35, 2 March 2022 by Roy 043 (talk | contribs) (Revising...)

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Part Ellipse

Menu location
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

Part Ellipse from the scripting example

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

Properties

See also: Property editor.

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

Data

Base

  • DataMajorRadius (Length): The major radius of the ellipse. This is the dimension in the x-direction.
  • DataMinorRadius (Length): The minor radius of the ellipse. This is the dimension in the y-direction.
  • DataAngle1 (Angle): The first angle of the ellipse. This is the angle for the start point of the curve.
  • DataAngle2 (Angle): The second angle of the ellipse. This is the angle for the end point of the curve.

Scripting

A Part Ellipse is created with the addObject() method of the document.

ellipse = FreeCAD.ActiveDocument.addObject("Part::Ellipse", "myEllipse")
  • Where myEllipse is the name for the object. The name must be unique for the entire document.
  • The function returns the newly created object.

The Label is the user editable name for the object. It can be easily changed by

ellipse.label = "new ellipseName"

You can access and modify attributes of the ellipse object. For example, you may wish to modify the two radii and angles of the ellipse.

ellipse.MajorRadius = 20
ellipse.MinorRadius = 10
ellipse.Angle1 = 45
ellipse.Angle2 = 135

The result will be a part of an ellipse.

You can change its placement and orientation with:

ellipse.Placement = FreeCAD.Placement(FreeCAD.Vector(1, 2, 3), FreeCAD.Rotation(30, 45, 10))