Draft Rectangle: Difference between revisions

From FreeCAD Documentation
m (Changed section to 'Usage')
mNo edit summary
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:18-->
<!--T:18-->
{{Docnav
{{Docnav
|[[Draft_Ellipse|Ellipse]]
|[[Draft_Polygon|Polygon]]
|[[Draft_Polygon|Polygon]]
|[[Draft_Text|Text]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Ellipse.svg
|[[Draft_Module|Draft]]
|IconL=Draft_Polygon.svg
|IconR=Draft_Polygon.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_Text.svg
}}
}}


Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Draft Rectangle
|Name=Draft Rectangle
|MenuLocation=Draft → Rectangle
|MenuLocation=Drafting → Rectangle
|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut=R E
|Shortcut={{KEY|R}} {{KEY|E}}
|SeeAlso=[[Draft Ellipse|Draft Ellipse]], [[Part Box|Part Box]]
|Version=0.7
|Version=0.7
}}
}}


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

The Rectangle tool creates a rectangle by picking two points. It uses the [[Draft Linestyle|Draft Linestyle]] set on the [[Draft Tray|Draft Tray]].
<!--T:2-->
The [[Image:Draft_Rectangle.svg|24px]] '''Draft Rectangle''' command creates a rectangle on the current [[Draft_SelectPlane|working plane]] from two points.


<!--T:11-->
<!--T:11-->
The corners of a Draft Rectangle can be filleted (rounded) or chamfered by changing its {{PropertyData|Fillet Radius}} or {{PropertyData|Chamfer Size}} respectively. It is also possible to subdivide a Draft Rectangle by changing its {{PropertyData|Columns}} and/or {{PropertyData|Rows}} property.
You can optionally add a 45 degree chamfer or circular fillet to every corner of the rectangle, and you can divide the rectangle into a series of equal-sized rows and columns.


</translate>
</translate>
Line 31: Line 33:
<translate>
<translate>
<!--T:3-->
<!--T:3-->
{{Caption|Rectangle defined by the two corner points}}
{{Caption|Rectangle defined by two points}}


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

# Press the {{Button|[[Image:Draft Rectangle.png|16px]] [[Draft Rectangle|Draft Rectangle]]}} button, or press {{KEY|R}} then {{KEY|E}} keys.
<!--T:24-->
# Click a first corner 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.
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]].
# Click another point on the 3D view that is opposite the first one, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.

:The second point must not be constrained to the X, Y, or Z axes, or the resulting rectangle will be malformed.
<!--T:4-->
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Rectangle.svg|16px]] [[Draft_Rectangle|Rectangle]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Rectangle.svg|16px]] Rectangle}} option from the menu.
#* Use the keyboard shortcut: {{KEY|R}} then {{KEY|E}}.
# The {{MenuCommand|Rectangle}} task panel opens. See [[#Options|Options]] for more information.
# Pick the first point 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 type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button. This point must not be constrained to the X, Y or Z axis.

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

<!--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 coordinates 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|R}} or click the {{MenuCommand|Relative}} checkbox to toggle relative mode. If relative mode is on, the coordinates of the second point are relative to the first point, else they are relative to the coordinate system origin.
* 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 rectangle 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 rectangles.
* 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-->
<!--T:12-->
* A Draft Rectangle can be edited with the [[Draft_Edit|Draft Edit]] command.
The rectangle can be edited by double clicking on the element in the tree view, or by pressing the {{Button|[[Image:Draft Edit.svg|16px]] [[Draft Edit|Draft Edit]]}} button. Then you can move the points to a new position.

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


<!--T:13-->
<!--T:35-->
See also: [[Preferences_Editor|Preferences Editor]] and [[Draft_Preferences|Draft Preferences]].
The length and width of the rectangle can be changed after creation by changing its properties.


==Options== <!--T:5-->
<!--T:36-->
* If the {{MenuCommand|Edit → Preferences... → Draft → General → Create Part primitives if possible}} option is checked, the command will create a [[Part_Plane|Part Plane]] instead of a Draft Rectangle.
* 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|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 Rectangle tool will restart after you give the second point, allowing you to draw another rectangle without pressing the tool button again.
* Press {{KEY|L}} or click the checkbox to toggle ''filled'' mode. If filled mode is on, the rectangle will create a filled face ({{PropertyData|Make Face}} {{TRUE}}); if not, the rectangle will not make a face ({{PropertyData|Make Face}} {{FALSE}}).
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.


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


=== Data === <!--T:14-->
<!--T:27-->
See also: [[Property_editor|Property editor]].
* {{PropertyData|Length}}: specifies the length of the shape in the X axis direction.
* {{PropertyData|Height}}: specifies the height of the shape in the Y axis direction.
* {{PropertyData|Chamfer Size}}: specifies the diagonal length of the 45&#176; chamfer at each corner of the rectangle.
* {{PropertyData|Fillet Radius}}: specifies the radius of the 90&#176; fillet at each corner of the rectangle.
* {{PropertyData|Rows}}: specifies the number of equal-sized rows in which the original shape is divided; by default, 1 row.
* {{PropertyData|Columns}}: specifies the number of equal-sized columns in which the original shape is divided; by default, 1 column.
* {{PropertyData|Make Face}}: specifies if the shape makes a face or not. If it is {{TRUE}} a face is created, otherwise only the perimeter is considered part of the object.


=== View === <!--T:15-->
<!--T:28-->
A Draft Rectangle object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:
* {{PropertyView|Pattern}}: specifies a [[Draft Pattern|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|Draft Pattern]].
* {{PropertyView|Texture Image}}: specifies the path to an image file to be mapped on the face of the shape. Blanking this property will remove the image.
:The rectangle should have the same proportions as the image to avoid distortions in the mapping.


==Scripting== <!--T:7-->
=== Data === <!--T:29-->

{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
<!--T:30-->
{{TitleProperty|Draft}}

<!--T:14-->
* {{PropertyData|Area|Area}}: (read-only) specifies the area of the face of the rectangle. The value will be {{value|0.0}} if {{PropertyData|Make Face}} if {{FALSE}}.
* {{PropertyData|Chamfer Size|Length}}: specifies the length of the chamfers at the corners of the rectangle.
* {{PropertyData|Columns|Integer}}: specifies the number of equal-sized columns in which the rectangle is divided.
* {{PropertyData|Fillet Radius|Length}}: specifies the radius of the fillets at the corners of the rectangle.
* {{PropertyData|Height|Distance}}: specifies the height of the rectangle.
* {{PropertyData|Length|Distance}}: specifies the length of the rectangle.
* {{PropertyData|Make Face|Bool}}: specifies if the rectangle makes a face or not. If it is {{TRUE}} a face is created, otherwise only the perimeter is considered part of the object.
* {{PropertyData|Rows|Integer}}: specifies the number of equal-sized rows in which the rectangle is divided.

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

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

<!--T:15-->
* {{PropertyView|Pattern|Enumeration}}: specifies the [[Draft_Pattern|Draft Pattern]] with which to fill the face of the rectangle. 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]].
* {{PropertyView|Texture Image|File}}: specifies the path of the image file to be mapped onto the face of the rectangle. Blanking this property will remove the image. The rectangle should have the same proportions as the image to avoid distortions.

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

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


<!--T:16-->
<!--T:16-->
To create a Draft Rectangle use the {{incode|make_rectangle}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeRectangle}} method.
The Rectangle tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:


</translate>
</translate>
{{Code|code=
{{Code|code=
Rectangle = makeRectangle(length, height, placement=None, face=None, support=None)
rectangle = make_rectangle(length, height, placement=None, face=None, support=None)
}}
}}
<translate>
<translate>


<!--T:8-->
<!--T:8-->
* Creates a {{incode|Rectangle}} object with {{incode|length}} in the X direction and {{incode|height}} in the Y direction, with units in millimeters.
* Creates a {{incode|rectangle}} object with {{incode|length}} in the X direction and {{incode|height}} in the Y direction, with units in millimeters.
** The length will be parallel to the X axis if no other placement in given.
* If {{incode|placement}} is {{incode|None}} the rectangle is created at the origin and the length will be parallel to the X axis.
* If a {{incode|placement}} is given, it is used; otherwise the shape is created at the origin.
* If {{incode|face}} is {{incode|True}}, the rectangle will make a face, that is, it will appear filled.
* If {{incode|face}} is {{incode|True}}, the shape will make a face, that is, it will appear filled.


<!--T:9-->
<!--T:9-->
Line 92: Line 132:
</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD, Draft
import FreeCAD as App
import Draft


doc = App.newDocument()
Rectangle1 = Draft.makeRectangle(4000, 1000)
Rectangle2 = Draft.makeRectangle(1000, 4000)


rectangle1 = Draft.make_rectangle(4000, 1000)
ZAxis = FreeCAD.Vector(0, 0, 1)
p3 = FreeCAD.Vector(1000, 1000, 0)
rectangle2 = Draft.make_rectangle(1000, 4000)
place3 = FreeCAD.Placement(p3, FreeCAD.Rotation(ZAxis, 45))


zaxis = App.Vector(0, 0, 1)
Rectangle3 = Draft.makeRectangle(3500, 250, placement=place3)
p3 = App.Vector(1000, 1000, 0)
place3 = App.Placement(p3, App.Rotation(zaxis, 45))

rectangle3 = Draft.make_rectangle(3500, 250, placement=place3)

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



<!--T:17-->
<!--T:17-->
{{Docnav
{{Docnav
|[[Draft_Ellipse|Ellipse]]
|[[Draft_Polygon|Polygon]]
|[[Draft_Polygon|Polygon]]
|[[Draft_Text|Text]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Ellipse.svg
|[[Draft_Module|Draft]]
|IconL=Draft_Polygon.svg
|IconR=Draft_Polygon.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_Text.svg
}}
}}


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

<!--T:20-->
{{Userdocnavi}}
</translate>
</translate>
{{Draft Tools navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 10:05, 30 January 2024

Draft Rectangle

Menu location
Drafting → Rectangle
Workbenches
Draft, Arch
Default shortcut
R E
Introduced in version
0.7
See also
None

Description

The Draft Rectangle command creates a rectangle on the current working plane from two points.

The corners of a Draft Rectangle can be filleted (rounded) or chamfered by changing its DataFillet Radius or DataChamfer Size respectively. It is also possible to subdivide a Draft Rectangle by changing its DataColumns and/or DataRows property.

Rectangle defined by two points

Usage

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

  1. There are several ways to invoke the command:
    • Press the Rectangle button.
    • Select the Drafting → Rectangle option from the menu.
    • Use the keyboard shortcut: R then E.
  2. The Rectangle task panel opens. See Options for more information.
  3. Pick the first point in the 3D view, or type coordinates and press the Enter point button.
  4. Pick the second point in the 3D view, or type coordinates and press the Enter point button. This point must not be constrained to the X, Y or Z axis.

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 coordinates 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 R or click the Relative checkbox to toggle relative mode. If relative mode is on, the coordinates of the second point are relative to the first point, else they are relative to the coordinate system origin.
  • 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 rectangle 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 rectangles.
  • Press S to switch Draft snapping on or off.
  • Press Esc or the Close button to abort the command.

Notes

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

Properties

See also: Property editor.

A Draft Rectangle 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 rectangle. The value will be 0.0 if DataMake Face if false.
  • DataChamfer Size (Length): specifies the length of the chamfers at the corners of the rectangle.
  • DataColumns (Integer): specifies the number of equal-sized columns in which the rectangle is divided.
  • DataFillet Radius (Length): specifies the radius of the fillets at the corners of the rectangle.
  • DataHeight (Distance): specifies the height of the rectangle.
  • DataLength (Distance): specifies the length of the rectangle.
  • DataMake Face (Bool): specifies if the rectangle makes a face or not. If it is true a face is created, otherwise only the perimeter is considered part of the object.
  • DataRows (Integer): specifies the number of equal-sized rows in which the rectangle is divided.

View

Draft

  • ViewPattern (Enumeration): specifies the Draft Pattern with which to fill the face of the rectangle. 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.
  • ViewTexture Image (File): specifies the path of the image file to be mapped onto the face of the rectangle. Blanking this property will remove the image. The rectangle should have the same proportions as the image to avoid distortions.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft Rectangle use the make_rectangle method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeRectangle method.

rectangle = make_rectangle(length, height, placement=None, face=None, support=None)
  • Creates a rectangle object with length in the X direction and height in the Y direction, with units in millimeters.
  • If placement is None the rectangle is created at the origin and the length will be parallel to the X axis.
  • If face is True, the rectangle will make a face, that is, it will appear filled.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

rectangle1 = Draft.make_rectangle(4000, 1000)
rectangle2 = Draft.make_rectangle(1000, 4000)

zaxis = App.Vector(0, 0, 1)
p3 = App.Vector(1000, 1000, 0)
place3 = App.Placement(p3, App.Rotation(zaxis, 45))

rectangle3 = Draft.make_rectangle(3500, 250, placement=place3)

doc.recompute()