Draft BezCurve: Difference between revisions

From FreeCAD Documentation
(Added Preferences.)
(Updated default shortcuts.)
 
(14 intermediate revisions by 2 users not shown)
Line 6: Line 6:
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_Point|Point]]
|[[Draft_Point|Point]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_CubicBezCurve.svg
|IconL=Draft_CubicBezCurve.svg
|IconR=Draft_Point.svg
|IconR=Draft_Point.svg
Line 16: Line 16:
|Name=Draft BezCurve
|Name=Draft BezCurve
|MenuLocation=Drafting → Bézier tools → Bézier curve
|MenuLocation=Drafting → Bézier tools → Bézier curve
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|B}} {{KEY|Z}}
|Version=0.14
|Version=0.14
|SeeAlso=[[Draft_CubicBezCurve|Draft CubicBezCurve]], [[Draft_BSpline|Draft BSpline]]
|SeeAlso=[[Draft_CubicBezCurve|Draft CubicBezCurve]], [[Draft_BSpline|Draft BSpline]]
Line 24: Line 25:


<!--T:2-->
<!--T:2-->
The [[Image:Draft_BezCurve.svg|24px]] '''Draft BezCurve''' command creates a [http://en.wikipedia.org/wiki/Bezier_curve Bézier Curve] from several points.
The [[Image:Draft_BezCurve.svg|24px]] '''Draft BezCurve''' command creates a [http://en.wikipedia.org/wiki/Bezier_curve Bézier curve] from several points.


<!--T:12-->
<!--T:12-->
Line 45: Line 46:
<!--T:17-->
<!--T:17-->
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_BezCurve.svg|16px]] [[Draft_BezCurve|Draft BezCurve]]}} button.
#* Press the {{Button|[[Image:Draft_BezCurve.svg|16px]] [[Draft_BezCurve|Bézier curve]]}} button.
#* Select the {{MenuCommand|Drafting → Bézier tools → [[Image:Draft_BezCurve.svg|16px]] Bézier curve}} option from the menu.
#* Select the {{MenuCommand|Drafting → Bézier tools → [[Image:Draft_BezCurve.svg|16px]] Bézier curve}} option from the menu.
#* Use the keyboard shortcut: {{KEY|B}} then {{KEY|Z}}. {{Version|0.20}}
# The {{MenuCommand|Bézier curve}} task panel opens. See [[#Options|Options]] for more information.
# The {{MenuCommand|Bézier curve}} 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 first point in the [[3D_view|3D view]], or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
Line 55: Line 57:


<!--T:28-->
<!--T:28-->
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.
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-->
<!--T:5-->
Line 61: Line 63:
* Press {{KEY|R}} or click the {{MenuCommand|Relative}} checkbox to toggle relative mode. If relative mode is on, coordinates are relative to the last point, if available, else they are relative to the coordinate system origin.
* Press {{KEY|R}} or click the {{MenuCommand|Relative}} checkbox to toggle relative mode. If relative mode is on, coordinates are relative to the last point, if available, 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|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|L}} or click the {{MenuCommand|Filled}} checkbox to toggle filled mode. If filled mode is on, the created curve will have {{PropertyData|Make Face}} set to {{TRUE}} and will have a filled face, provided it is closed and does not self-intersect. Note that a self-intersecting curve with a face will not display properly, for such a curve {{PropertyData|Make Face}} must be set to {{FALSE}}.
* Press {{KEY|F}} or click the {{MenuCommand|Filled}} checkbox to toggle filled mode. If filled mode is on, the created curve will have {{PropertyData|Make Face}} set to {{TRUE}} and will have a filled face, provided it is closed and does not self-intersect. Note that a self-intersecting curve with a face will not display properly, for such a curve {{PropertyData|Make Face}} must be set to {{FALSE}}.
* Press {{KEY|T}} or click the {{MenuCommand|Continue}} checkbox to toggle continue mode. If continue mode is on, the command will restart after using {{Button|[[Image:Draft_FinishLine.svg|16px]] Finish}} or {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}}, or after creating a closed curve by snapping to the first point of the curve, allowing you to continue creating curves.
* Press {{KEY|N}} or click the {{MenuCommand|Continue}} checkbox to toggle continue mode. If continue mode is on, the command will restart after using {{Button|[[Image:Draft_FinishLine.svg|16px]] Finish}} or {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}}, or after creating a closed curve by snapping to the first point of the curve, allowing you to continue creating curves.
* Press the {{button|[[Image:Draft_UndoLine.svg|16px]] Undo}} button to undo the last point. The {{KEY|Ctrl}}+{{KEY|Z}} keyboard shortcut currently does not work.
* Press {{KEY|/}} or the {{Button|[[Image:Draft_UndoLine.svg|16px]] Undo}} button to undo the last point.
* Press {{KEY|A}} or the {{Button|[[Image:Draft_FinishLine.svg|16px]] Finish}} button to finish the command and leave the curve open.
* Press {{KEY|A}} or the {{Button|[[Image:Draft_FinishLine.svg|16px]] Finish}} button to finish the command and leave the curve open.
* Press {{KEY|O}} or the {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}} button to finish the command and close the curve. A closed curve can also be created by snapping to the first point of the curve.
* Press {{KEY|O}} or the {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}} button to finish the command and close the curve. A closed curve can also be created by snapping to the first point of the curve.
Line 69: Line 71:
* Press {{KEY|U}} or the {{Button|[[Image:Draft SelectPlane.svg|16px]] [[Draft_SelectPlane|Set WP]]}} button to adjust the current working plane in the orientation defined by the last and the previous point.
* Press {{KEY|U}} or the {{Button|[[Image:Draft SelectPlane.svg|16px]] [[Draft_SelectPlane|Set WP]]}} button to adjust the current working plane in the orientation defined by the last and the previous point.
* Press {{KEY|S}} to switch [[Draft_Snap|Draft snapping]] on or off.
* Press {{KEY|S}} to switch [[Draft_Snap|Draft snapping]] on or off.
* Press {{KEY|Esc}} or the {{button|Close}} button to finish the command.
* Press {{KEY|Esc}} or the {{Button|Close}} button to finish the command.


==Notes== <!--T:29-->
==Notes== <!--T:29-->
Line 76: Line 78:
* A Draft BezCurve can be edited with the [[Draft_Edit|Draft Edit]] command.
* A Draft BezCurve can be edited with the [[Draft_Edit|Draft Edit]] command.
* OpenCascade, and therefore FreeCAD, does not support Bézier curves of degrees larger than 25. This should not be a problem in practice, as most users typically use Bézier curves of degrees 3 to 5.
* OpenCascade, and therefore FreeCAD, does not support Bézier curves of degrees larger than 25. This should not be a problem in practice, as most users typically use Bézier curves of degrees 3 to 5.

==Preferences==

See also: [[Preferences_Editor|Preferences Editor]] and [[Draft_Preferences|Draft Preferences]].

* The initial value of filled mode can be changed: {{MenuCommand|Edit → Preferences... → Draft → General settings → Draft tools options → Fill objects with faces whenever possible}}. Changing the filled mode in a task panel will override this preference for the current FreeCAD session.


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


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


<!--T:31-->
<!--T:31-->
Line 168: Line 164:
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_Point|Point]]
|[[Draft_Point|Point]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_CubicBezCurve.svg
|IconL=Draft_CubicBezCurve.svg
|IconR=Draft_Point.svg
|IconR=Draft_Point.svg

Latest revision as of 18:28, 6 January 2024

Draft BezCurve

Menu location
Drafting → Bézier tools → Bézier curve
Workbenches
Draft, Arch
Default shortcut
B Z
Introduced in version
0.14
See also
Draft CubicBezCurve, Draft BSpline

Description

The Draft BezCurve command creates a Bézier curve from several points.

The command creates a single Bézier curve with a DataDegree that is number_of_points - 1. It can be transformed into a piecewise Bézier curve by reducing this property.

The Draft BezCurve and the Draft CubicBezCurve commands use control points to define the position and curvature of the spline. The Draft BSpline command, on the other hand, specifies the exact points through which the curve will pass.

Bézier curve defined by multiple points

Usage

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

  1. There are several ways to invoke the command:
  2. The Bézier curve 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 additional points in the 3D view, or type coordinates and press the Enter point button.
  5. Press Esc or the Close button to finish the command.

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, coordinates are relative to the last point, if available, 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 curve will have DataMake Face set to true and will have a filled face, provided it is closed and does not self-intersect. Note that a self-intersecting curve with a face will not display properly, for such a curve DataMake Face must be set to false.
  • Press N or click the Continue checkbox to toggle continue mode. If continue mode is on, the command will restart after using Finish or Close, or after creating a closed curve by snapping to the first point of the curve, allowing you to continue creating curves.
  • Press / or the Undo button to undo the last point.
  • Press A or the Finish button to finish the command and leave the curve open.
  • Press O or the Close button to finish the command and close the curve. A closed curve can also be created by snapping to the first point of the curve.
  • Press W or the Wipe button to delete the segments already placed, but keep working from the last point.
  • Press U or the Set WP button to adjust the current working plane in the orientation defined by the last and the previous point.
  • Press S to switch Draft snapping on or off.
  • Press Esc or the Close button to finish the command.

Notes

  • A Draft BezCurve can be edited with the Draft Edit command.
  • OpenCascade, and therefore FreeCAD, does not support Bézier curves of degrees larger than 25. This should not be a problem in practice, as most users typically use Bézier curves of degrees 3 to 5.

Properties

See also: Property editor.

A Draft BezCurve 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 curve. The value will be 0.0 if DataMake Face if false or the face cannot be created.
  • DataClosed (Bool): specifies if the curve is closed or not. If the curve is initially open this value is false, setting it to true will draw a segment to close the curve. If the curve is initially closed this value is true, setting it to false will remove the last segment and make the curve open.
  • DataContinuity (IntegerList): (read-only) specifies the continuity of the curve.
  • DataDegree (Integer): specifies the degree of the curve.
  • DataLength (Length): (read-only) specifies the total length of the curve.
  • DataMake Face (Bool): specifies if the curve 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 DataClosed is true and if the curve does not self-intersect.
  • DataPoints (VectorList): specifies the control points of the curve in its local coordinate system.

View

Draft

  • ViewArrow Size (Length): specifies the size of the symbol displayed at the end of the curve.
  • ViewArrow Type (Enumeration): specifies the type of symbol displayed at the end of the curve, which can be Dot, Circle, Arrow, Tick or Tick-2.
  • ViewEnd Arrow (Bool): specifies whether to show a symbol at the end of the curve, so it can be used as an annotation line.
  • ViewPattern (Enumeration): specifies the Draft Pattern with which to fill the face of the closed curve. 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 Line use the make_bezcurve method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeBezCurve method.

bezcurve = make_bezcurve(pointslist, closed=False, placement=None, face=None, support=None, degree=None)
bezcurve = make_bezcurve(Part.Wire, closed=False, placement=None, face=None, support=None, degree=None)
  • Creates a bezcurve object with the given list of points, pointslist.
    • Each point in the list is defined by its FreeCAD.Vector, with units in millimeters.
    • Alternatively, the input can be a Part.Wire, from which points are extracted.
  • If closed is True, or if the first and last points are identical, the curve is closed.
  • If placement is None the curve is created at the origin.
  • If face is True, and the curve is closed, the curve will make a face, that is, it will appear filled.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

p1 = App.Vector(0, 0, 0)
p2 = App.Vector(1000, 1000, 0)
p3 = App.Vector(2000, 0, 0)
p4 = App.Vector(1500, -2000, 0)

bezcurve1 = Draft.make_bezcurve([p1, p2, p3, p4], closed=True)
bezcurve2 = Draft.make_bezcurve([p4, 1.3*p2, p1, 4.1*p3], closed=True)
bezcurve3 = Draft.make_bezcurve([1.7*p3, 1.5*p4, 2.1*p2, p1], closed=True)

doc.recompute()