Draft Circle: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
 
(116 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
{{GuiCommand|Name=Draft_Circle|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|MenuLocation=Draft -> Circle|Shortcut=C I|SeeAlso=[[Draft Arc]]}}
<translate>


<!--T:18-->
==Description==
{{Docnav
|[[Draft_Arc_3Points|Arc 3Points]]
|[[Draft_Ellipse|Ellipse]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Arc_3Points.svg
|IconR=Draft_Ellipse.svg
|IconC=Workbench_Draft.svg
}}


<!--T:1-->
The Circle tool creates a circle in the current [[Draft Workingplane|work plane]] by entering two points, the center and the radius, or by picking tangents, or any combination of those. It takes the [[Draft Linestyle|linewidth and color]] previously set on the Tasks tab. This tool works the same way as the [[Draft Arc]] tool, except that it stops after entering the radius.
{{GuiCommand
|Name=Draft Circle
|MenuLocation=Drafting → Circle
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|C}} {{KEY|I}}
|Version=0.7
|SeeAlso=[[Draft_Arc|Draft Arc]], [[Draft_Arc_3Points|Draft Arc 3Points]]
}}


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

<!--T:2-->
The [[Image:Draft_Circle.svg|24px]] '''Draft Circle''' command creates a circle on the current [[Draft_SelectPlane|working plane]] from a center and a radius. The radius can be defined by picking a point.

<!--T:11-->
A Draft Circle can be turned into an arc by setting its {{PropertyData|First Angle}} and {{PropertyData|Last Angle}} properties to different values.

</translate>
[[Image:Draft_Circle_example.jpg|400px]]
[[Image:Draft_Circle_example.jpg|400px]]
<translate>
<!--T:3-->
{{Caption|Circle defined by two points, center and radius}}

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

<!--T:23-->
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]].

<!--T:4-->
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Circle.svg|16px]] [[Draft_Circle|Circle]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Circle.svg|16px]] Circle}} option from the menu.
#* Use the keyboard shortcut: {{KEY|C}} then {{KEY|I}}.
# The {{MenuCommand|Circle}} task panel opens. See [[#Options|Options]] for more information.
# Pick the first point, the center of the circle, 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 enter a {{MenuCommand|Radius}}.

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

<!--T:25-->
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:5-->
* To manually enter the coordinates for the center 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.
* 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 circle will have {{PropertyData|Make Face}} set to {{TRUE}} and will have a filled face.
* 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 circles.
* 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:26-->

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

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

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

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

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

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

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

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

<!--T:31-->
{{TitleProperty|Draft}}

<!--T:14-->
* {{PropertyData|Area|Area}}: (read-only) specifies the area of the face of the circle. 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 start angle of the circle, normally {{value|0&#176;}}.
* {{PropertyData|Last Angle|Angle}}: specifies the end angle of the circle, normally {{value|0&#176;}}.
* {{PropertyData|Make Face|Bool}}: specifies if the circle 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 {{PropertyData|First Angle}} and {{PropertyData|Last Angle}} have the same value. Note that {{value|0&#176;}} and {{value|360&#176;}} are not considered the same.
* {{PropertyData|Radius|Length}}: specifies the radius of the circle.

===View=== <!--T:32-->

<!--T:33-->
{{TitleProperty|Draft}}

<!--T:15-->
* {{PropertyView|Pattern|Enumeration}}: specifies the [[Draft_Pattern|Draft Pattern]] with which to fill the face of the circle. 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:34-->

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

<!--T:16-->
To create a Draft Circle use the {{incode|make_circle}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeCircle}} method.

</translate>
{{Code|code=
circle = make_circle(radius, placement=None, face=None, startangle=None, endangle=None, support=None)
circle = make_circle(Part.Edge, placement=None, face=None, startangle=None, endangle=None, support=None)
}}
<translate>


<!--T:8-->
==How to use==
* Creates a {{incode|circle}} object with given {{incode|radius}} in millimeters.
** {{incode|radius}} can also be a {{incode|Part.Edge}}, whose {{incode|Curve}} attribute must be a {{incode|Part.Circle}}.
* If {{incode|placement}} is {{incode|None}} the circle is created at the origin.
* If {{incode|face}} is {{incode|True}}, the circle will make a face, that is, it will appear filled.
* If {{incode|startangle}} and {{incode|endangle}} are given in degrees, and have different values, they are used and the object appears as a [[Draft Arc|Draft Arc]].


<!--T:9-->
# Press the {{KEY|[[Image:Draft Circle.png|16px]] [[Draft Circle]]}} button, or press {{KEY|C}} then {{KEY|I}} keys
Example:
# Click a first point on the 3D view, or type a [[Draft_Coordinates|coordinate]]
</translate>
# Click a second point on the 3D view, or enter a radius value.
{{Code|code=
import FreeCAD as App
import Draft


doc = App.newDocument()
==Options==


circle1 = Draft.make_circle(200)
* The primary use of the circle tool is by picking two points, the centre and a point on the circumference, defining the radius.
* By pressing {{KEY|ALT}}, you can select a tangent instead of picking a point. You can therefore construct several types of circles by selecting one, two or three tangents.
* 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 check/uncheck the {{KEY|'''Continue'''}} button. If continue mode is on, the Circle tool will restart after you give the second point, allowing you to draw another circle without pressing the Circle 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|SHIFT}} while drawing to [[Draft_Constrain|constrain]] your second point horizontally or vertically in relation to the first one.
* Press {{KEY|I}} or the {{KEY|'''Filled'''}} button to have the circle to appear as a face after it has been closed. This simply sets the View->Property of the Circle to "Flat lines" or "Wireframe", so it can easily be changed later.
* Press {{KEY|ESC}} or the {{KEY|'''Cancel'''}} button to abort the current Line command.
* The circle can be turned into an arc after creation, by setting its first angle and last angle properties to different values.


zaxis = App.Vector(0, 0, 1)
==Properties==
p2 = App.Vector(1000, 1000, 0)
place2 = App.Placement(p2, App.Rotation(zaxis, 0))
circle2 = Draft.make_circle(500, placement=place2)


p3 = App.Vector(-1000, -1000, 0)
* {{PropertyData|Radius}}: The radius of the circle
place3 = App.Placement(p3, App.Rotation(zaxis, 0))
circle3 = Draft.make_circle(750, placement=place3)


doc.recompute()
==Scripting==
}}
<translate>


The Circle tool can by used in [[macros]] and from the python console the following way:


<!--T:17-->
import Draft
{{Docnav
myCircle = Draft.makeCircle(2)
|[[Draft_Arc_3Points|Arc 3Points]]
|[[Draft_Ellipse|Ellipse]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Arc_3Points.svg
|IconR=Draft_Ellipse.svg
|IconC=Workbench_Draft.svg
}}


</translate>
{{languages | {{es|Draft Circle/es}} {{fr|Draft Circle/fr}} {{it|Draft Circle/it}} {{se|Draft Circle/se}} }}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 10:04, 30 January 2024

Draft Circle

Menu location
Drafting → Circle
Workbenches
Draft, Arch
Default shortcut
C I
Introduced in version
0.7
See also
Draft Arc, Draft Arc 3Points

Description

The Draft Circle command creates a circle on the current working plane from a center and a radius. The radius can be defined by picking a point.

A Draft Circle can be turned into an arc by setting its DataFirst Angle and DataLast Angle properties to different values.

Circle defined by two points, center and radius

Usage

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

  1. There are several ways to invoke the command:
    • Press the Circle button.
    • Select the Drafting → Circle option from the menu.
    • Use the keyboard shortcut: C then I.
  2. The Circle task panel opens. See Options for more information.
  3. Pick the first point, the center of the circle, in the 3D view, or type coordinates and press the Enter point button.
  4. Pick the second point in the 3D view, or enter a Radius.

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 the coordinates for the center 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 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 circle 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 circles.
  • Press S to switch Draft snapping on or off.
  • Press Esc or the Close button to abort the command.

Notes

  • A Draft Circle 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 Circle instead of a Draft Circle.

Properties

See also: Property editor.

A Draft Circle 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 circle. The value will be 0.0 if DataMake Face if false or the face cannot be created.
  • DataFirst Angle (Angle): specifies the start angle of the circle, normally .
  • DataLast Angle (Angle): specifies the end angle of the circle, normally .
  • DataMake Face (Bool): specifies if the circle 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 DataFirst Angle and DataLast Angle have the same value. Note that and 360° are not considered the same.
  • DataRadius (Length): specifies the radius of the circle.

View

Draft

  • ViewPattern (Enumeration): specifies the Draft Pattern with which to fill the face of the circle. 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 Circle use the make_circle method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeCircle method.

circle = make_circle(radius, placement=None, face=None, startangle=None, endangle=None, support=None)
circle = make_circle(Part.Edge, placement=None, face=None, startangle=None, endangle=None, support=None)
  • Creates a circle object with given radius in millimeters.
    • radius can also be a Part.Edge, whose Curve attribute must be a Part.Circle.
  • If placement is None the circle is created at the origin.
  • If face is True, the circle will make a face, that is, it will appear filled.
  • If startangle and endangle are given in degrees, and have different values, they are used and the object appears as a Draft Arc.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

circle1 = Draft.make_circle(200)

zaxis = App.Vector(0, 0, 1)
p2 = App.Vector(1000, 1000, 0)
place2 = App.Placement(p2, App.Rotation(zaxis, 0))
circle2 = Draft.make_circle(500, placement=place2)

p3 = App.Vector(-1000, -1000, 0)
place3 = App.Placement(p3, App.Rotation(zaxis, 0))
circle3 = Draft.make_circle(750, placement=place3)

doc.recompute()