Part Circle: Difference between revisions

From FreeCAD Documentation
(Removed the UnfinishedDocu template.)
(Marked this version for translation)
Line 25: Line 25:
A [[Image:Part_Circle.svg|24px]] '''Part Circle''' 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 circle lies on the XY plane with its center at the origin.
A [[Image:Part_Circle.svg|24px]] '''Part Circle''' 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 circle lies on the XY plane with its center at the origin.


<!--T:14-->
A Part Circle is in fact a closed counterclockwise circular arc, it can be turned into an arc by changing its {{PropertyData|Angle1}} and/or {{PropertyData|Angle2}} properties.
A Part Circle is in fact a closed counterclockwise circular arc, it can be turned into an arc by changing its {{PropertyData|Angle1}} and/or {{PropertyData|Angle2}} properties.


Line 33: Line 34:
==Usage== <!--T:11-->
==Usage== <!--T:11-->


<!--T:15-->
See [[Part_Primitives#Usage|Part Primitives]].
See [[Part_Primitives#Usage|Part Primitives]].


<!--T:16-->
A Part Circle can alternatively be created by selecting three points:
A Part Circle can alternatively be created by selecting three points:
# In the task panel of the [[Image:Part_Primitives.svg|16px]] [[Part_Primitives|Part Primitives]] command select the {{MenuCommand|[[Image:Part_Circle.svg|16px]] Circle}} option from the dropdown list.
# In the task panel of the [[Image:Part_Primitives.svg|16px]] [[Part_Primitives|Part Primitives]] command select the {{MenuCommand|[[Image:Part_Circle.svg|16px]] Circle}} option from the dropdown list.
Line 42: Line 45:
# The selected vertices are only used at creation time to calculate the {{PropertyData|Radius}} and {{PropertyData|Placement}} of the circle.
# The selected vertices are only used at creation time to calculate the {{PropertyData|Radius}} and {{PropertyData|Placement}} of the circle.


== Example ==
== Example == <!--T:17-->


<!--T:18-->
[[Image:Part_Circle_Scripting_Example.png|thumb|Part Circle from the scripting example]]
[[Image:Part_Circle_Scripting_Example.png|thumb|Part Circle from the scripting example]]


<!--T:19-->
A Part Circle object created with the [[#Scripting|scripting example]] below is shown here.
A Part Circle object created with the [[#Scripting|scripting example]] below is shown here.


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


<!--T:20-->
See also: [[Property_editor|Property editor]].
See also: [[Property_editor|Property editor]].


<!--T:21-->
A Part Circle object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties:
A Part Circle object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties:


=== Data ===
=== Data === <!--T:22-->


<!--T:23-->
{{TitleProperty|Attachment}}
{{TitleProperty|Attachment}}


<!--T:24-->
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]].
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]].


<!--T:25-->
{{TitleProperty|Base}}
{{TitleProperty|Base}}


Line 67: Line 77:
* {{PropertyData|Angle2|Angle}}: The end angle of the circular 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 circle is created.
* {{PropertyData|Angle2|Angle}}: The end angle of the circular 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 circle is created.


== Scripting ==
== Scripting == <!--T:26-->


<!--T:27-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:28-->
A Part Circle can be created with the {{Incode|addObject()}} method of the document:
A Part Circle can be created with the {{Incode|addObject()}} method of the document:


Line 79: Line 91:
<translate>
<translate>


<!--T:29-->
* Where {{Incode|"myCircle"}} is the name for the object.
* Where {{Incode|"myCircle"}} is the name for the object.
* The function returns the newly created object.
* The function returns the newly created object.


<!--T:30-->
Example:
Example:


Revision as of 10:24, 3 March 2022

Other languages:

Part Circle

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

Description

A Part Circle is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement property, the circle lies on the XY plane with its center at the origin.

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

Usage

See Part Primitives.

A Part Circle can alternatively be created by selecting three points:

  1. In the task panel of the Part Primitives command select the Circle option from the dropdown list.
  2. Press the From three points button.
  3. Select three vertices in the 3D view. There is no need to hold down the Ctrl key.
  4. A circle is created.
  5. The selected vertices are only used at creation time to calculate the DataRadius and DataPlacement of the circle.

Example

Part Circle from the scripting example

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

Properties

See also: Property editor.

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

Data

Attachment

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

Base

  • DataRadius (Length): The radius of the circle or circular arc. The default is 2mm.
  • DataAngle1 (Angle): The start angle of the circular arc. Valid range: 0° < value <= 360°. The default is 0°.
  • DataAngle2 (Angle): The end angle of the circular 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 circle is created.

Scripting

See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.

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

circle = FreeCAD.ActiveDocument.addObject("Part::Circle", "myCircle")
  • Where "myCircle" is the name for the object.
  • The function returns the newly created object.

Example: 

import FreeCAD as App

doc = App.activeDocument()

circle = doc.addObject("Part::Circle", "myCircle")
circle.Radius = 10
circle.Angle1 = 45
circle.Angle2 = 225
circle.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(30, 45, 10))

doc.recompute()


Part
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Part_Circle&oldid=1106618"