Draft BSpline: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Page_in_progress}}
<languages/>
<languages/>
<translate>
<translate>

<!--T:18-->
<!--T:18-->
{{Docnav
{{Docnav
|[[Draft_Polygon|Polygon]]
|[[Draft_Dimension|Dimension]]
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_Point|Point]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft_Dimension.svg
|IconL=Draft_Polygon.svg
|IconR=Draft_Point.svg
|IconR=Draft_CubicBezCurve.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 14: Line 16:
{{GuiCommand
{{GuiCommand
|Name=Draft BSpline
|Name=Draft BSpline
|MenuLocation=DraftBSpline
|MenuLocation=DraftingB-spline
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Shortcut={{KEY|B}} {{KEY|S}}
|Shortcut={{KEY|B}} {{KEY|S}}
|Version=0.7
|Version=0.7
|SeeAlso=[[Draft_Wire|Draft Wire]], [[Draft_BezCurve|Draft BezCurve]]
|SeeAlso=[[Draft_Wire|Draft Wire]], [[Draft_CubicBezCurve|Draft CubicBezCurve]], [[Draft_BezCurve|Draft BezCurve]]
}}
}}


Line 24: Line 26:


<!--T:2-->
<!--T:2-->
The {{Button|[[File:Draft_BSpline.svg|16px]] [[Draft_BSpline|Draft BSpline]]}} tool creates a [http://en.wikipedia.org/wiki/B-spline B-spline curve] from several points. It uses the [[Draft_Linestyle|Draft Linestyle]] set on the [[Draft_Tray|Draft Tray]].
The [[Image:Draft_BSpline.svg|24px]] [[Draft_BSpline|Draft BSpline]] command creates a [http://en.wikipedia.org/wiki/B-spline B-spline curve] from several points. It uses the [[Draft_Linestyle|Draft Linestyle]] set on the [[Draft_Tray|Draft Tray]].

<!--T:10-->
The BSpline tool behaves like the {{Button|[[File:Draft_Wire.svg|16px]] [[Draft_Wire|Wire]]}} tool, except that each of its segments is curved instead of being a straight line. Use {{Button|[[File:Draft_WireToBSpline.svg|16px]] [[Draft_WireToBSpline|Wire to B-spline]]}} to convert one to the other.


<!--T:11-->
<!--T:11-->
The BSpline tool specifies the exact points through which the curve will go; on the other hand the {{Button|[[File:Draft_BezCurve.svg|16px]] [[Draft_BezCurve|Bezier curve]]}} tool uses {{Emphasis|control points}} to define the direction of the curve. To create exact circular or elliptical curves, use {{Button|[[File:Draft_Arc.svg|16px]] [[Draft_Arc|Arc]]}} and {{Button|[[File:Draft_Ellipse.svg|16px]] [[Draft_Ellipse|Ellipse]]}}.
The Draft BSpline command specifies the {{Emphasis|exact points}} through which the curve will pass. The [[Draft BezCurve|Draft BezCurve]] and the [[Draft_CubicBezCurve|Draft CubicBezCurve]] commands, on the other hand, use {{Emphasis|control points}} to define the position and curvature of the spline.


</translate>
</translate>
Line 41: Line 40:


<!--T:4-->
<!--T:4-->
# There are several ways to invoke the command:
# Press the {{Button|[[Image:Draft_BSpline.svg|16px]] [[Draft BSpline]]}} button, or press {{KEY|B}} then {{KEY|S}} keys
# Click a first 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.
#* Press the {{Button|[[Image:Draft_BSpline.svg|16px]] [[Draft_BSpline|Draft BSpline]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_BSpline.svg|16px]] B-spline}} option from the menu.
# Click additional points on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.
#* Use the keyboard shortcut: {{KEY|B}} then {{KEY|S}}.
# Press {{KEY|Esc}} or the {{Button|Close}} button to complete the edition.
# Click the first point in the [[3D_view|3D view]], or type [[Draft_Coordinates|coordinates]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button in the related Line task panel.
# Click additional points in the [[3D_view|3D view]], or type [[Draft_Coordinates|coordinates]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button in the related Line task panel.
# Press {{KEY|Esc}} or the {{Button|Close}} button in the related Line task panel to finish the command.


==Options==
<!--T:12-->
The spline 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, or click {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} or {{Button|[[Image:Draft_DelPoint.svg|16px]] [[Draft_DelPoint|remove point]]}} and then click on the wire to add or remove points.


==Options== <!--T:5-->
<!--T:5-->
* Press {{KEY|A}} or the {{Button|[[Image:Draft_FinishLine.svg|12px]] [[Draft_FinishLine|Finish]]}} button to finish the spline, leaving it open.
* Press {{KEY|A}} or the {{Button|[[Image:Draft_FinishLine.svg|12px]] Finish}} button to finish the spline, leaving it open.
* Press {{KEY|O}} or the {{Button|[[Image:Draft_CloseLine.svg|12px]] [[Draft_CloseLine|Close]]}} button to close the spline, that is, a curve will be added from the last point to the first one to form a face. At least three points are required to form a face.
* Press {{KEY|O}} or the {{Button|[[Image:Draft_CloseLine.svg|12px]] Close}} button to close the spline, that is, a curve will be added from the last point to the first one to form a face. At least three points are required to form a face.
* Press {{KEY|W}} or the {{Button|[[Image:Draft Wipe.svg|12px]] [[Draft_Wipe|Wipe]]}} button to remove the curve segments already placed, but keep editing the spline from the last point.
* Press {{KEY|W}} or the {{Button|[[Image:Draft Wipe.svg|12px]] Wipe}} button to remove the curve segments already placed, but keep editing the spline from the last point.
* Press {{KEY|U}} or the {{Button|[[Image:Draft SelectPlane.svg|12px]] [[Draft_SelectPlane|Set WP]]}} button to adjust the current working plane in the orientation of the last point.
* Press {{KEY|U}} or the {{Button|[[Image:Draft SelectPlane.svg|12px]] [[Draft_SelectPlane|Set WP]]}} button to adjust the current working plane in the orientation of the last point.
* Press {{KEY|X}}, {{KEY|Y}} or {{KEY|Z}} after a point to constrain the next point on the given axis.
* Press {{KEY|X}}, {{KEY|Y}} or {{KEY|Z}} after a point to constrain the next point on the given axis.
* 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.
* 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]] Enter 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 next point are relative to the last one; if not, they are absolute, taken from the origin (0,0,0).
* Press {{KEY|R}} or click the checkbox to toggle ''relative'' mode. If relative mode is on, the coordinates of the next point are relative to the last 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 BSpline tool will restart after you finish the spline, allowing you to draw another one without pressing the tool button again.
* Press {{KEY|T}} or click the checkbox to toggle ''continue'' mode. If continue mode is on, the BSpline command will restart after you finish the spline, allowing you to draw another one without pressing the command button again.
* Press {{KEY|L}} or click the checkbox to toggle ''filled'' mode. If filled mode is on, a closed spline will create a filled face ({{PropertyData|Make Face}} {{TRUE}}); if not, the closed spline will not make a face ({{PropertyData|Make Face}} {{FALSE}}).
* Press {{KEY|L}} or click the checkbox to toggle ''filled'' mode. If filled mode is on, a closed spline will create a filled face ({{PropertyData|Make Face}} {{TRUE}}); if not, the closed spline will not make a face ({{PropertyData|Make Face}} {{FALSE}}).
:{{Emphasis|Note:}} the spline should not be filled if it intersects itself, as it won't create a proper face. If the spline is filled but no shape is visible, manually set {{PropertyData|Make Face}} to {{FALSE}} to see the spline.
:{{Emphasis|Note:}} the spline should not be filled if it intersects itself, as it won't create a proper face. If the spline is filled but no shape is visible, manually set {{PropertyData|Make Face}} to {{FALSE}} to see the spline.
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Hold {{KEY|Ctrl}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Hold {{KEY|Shift}} while drawing to [[Draft_Constrain|constrain]] your next point horizontally or vertically in relation to the last one.
* Hold {{KEY|Shift}} while drawing to [[Draft_Constrain|constrain]] your next point horizontally or vertically in relation to the last one.
* Press {{KEY|Ctrl}}+{{KEY|Z}} or press the {{Button|[[Image:Draft_UndoLine.svg|12px]] [[Draft_UndoLine|Undo]]}} button to undo the last point.
* Press {{KEY|Ctrl}}+{{KEY|Z}} or press the {{Button|[[Image:Draft_UndoLine.svg|12px]] Undo}} button to undo the last point.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command; curve segments already placed will remain.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command; curve segments already placed will remain.

==Notes==

<!--T:10-->
* A Draft BSpline can be edited with the [[Draft_Edit|Draft Edit]] command.
* A Draft BSpline can be converted to a [[Draft_Wire|Draft Wire]] with the [[Draft_WireToBSpline|Draft WireToBSpline]] command.


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


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

A BSpline object shares most properties from a [[Draft Wire|Draft Wire]], however, most properties only make sense for a Wire.
A Draft BSpline object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:

=== Data ===

<!--T:14-->
* {{PropertyData|Area|Area}}: (read-only) specifies the area of the face of the spline. The value will be {{value|0.0}} if {{PropertyData|Make Face}} if {{FALSE}} or the face cannot be created.
* {{PropertyData|Closed|Bool}}: specifies if the spline is closed or not. If the spline is initially open this value is {{FALSE}}, setting it to {{TRUE}} will draw a curve segment to close the spline. If the spline is initially closed this value is {{TRUE}}, setting it to {{FALSE}} will remove the last curve segment and make the spline open.
* {{PropertyData|Make Face|Bool}}: specifies if the spline 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 {{PropertyData|Closed}} is {{TRUE}} and if the spline does not self-intersect.
* {{PropertyData|Parameterization|Float}}: affects the shape of the spline.
* {{PropertyData|Points|VectorList}}: specifies the points of the spline in its local coordinate system.

=== View ===


=== Data === <!--T:14-->
<!--T:15-->
* {{PropertyView|Arrow Size|Length}}: specifies the size of the symbol displayed at the end of the spline.
* {{PropertyData|Closed}}: specifies if the spline is closed or not. If the spline is initially open, this value is {{FALSE}}; setting it to {{TRUE}} will draw a curve segment to close the spline. If the spline is initially closed, this value is {{TRUE}}; setting it to {{FALSE}} will remove the last curve segment, and make the spline open.
* {{PropertyView|Arrow Type|Enumeration}}: specifies the type of symbol displayed at the end of the spline, which can be {{value|Dot}}, {{value|Circle}}, {{value|Arrow}}, {{value|Tick}} or {{value|Tick-2}}.
* {{PropertyData|Make Face}}: specifies if the spline 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 {{PropertyData|Closed}} is {{TRUE}}.
* {{PropertyView|End Arrow|Bool}}: specifies whether to show a symbol at the end of the spline, so it can be used as an annotation line.
:{{Emphasis|Note:}} do not set {{PropertyData|Make Face}} to {{TRUE}} if the spline intersects itself, as it won't create a proper face.
* {{PropertyView|Pattern|Enumeration}}: specifies the [[Draft_Pattern|Draft Pattern]] with which to fill the face of the closed spline. This property only works if {{PropertyData|Make Face}} is {{TRUE}} and if {{PropertyView|Display Mode}} is {{value|Flat Lines}}.
* {{PropertyData|Parameterization}}: affects the shape of the BSpline.
* {{PropertyView|Pattern Size|Float}}: specifies the size of the [[Draft_Pattern|Draft Pattern]].


==Scripting==
=== View === <!--T:15-->
* {{PropertyView|Arrow Size}}: specifies the size of the symbol displayed at the end of the spline.
* {{PropertyView|Arrow Type}}: specifies the type of symbol displayed at the end of the spline, which can be "Dot", "Circle", "Arrow", or "Tick".
* {{PropertyView|End Arrow}}: specifies whether to show a symbol at the last point of the spline, so it can be used as an annotation line.
* {{PropertyView|Pattern}}: specifies a [[Draft Pattern|Draft Pattern]] with which to fill the face of a closed spline. 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]].


==Scripting== <!--T:7-->
<!--T:7-->
{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
See also: [https://www.freecadweb.org/api Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


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


</translate>
</translate>
{{Code|code=
{{Code|code=
BSpline = make_bspline(pointslist, closed=False, placement=None, face=None, support=None)
bspline = make_bspline(pointslist, closed=False, placement=None, face=None, support=None)
BSpline = make_bspline(Part.Wire, closed=False, placement=None, face=None, support=None)
bspline = make_bspline(Part.Wire, closed=False, placement=None, face=None, support=None)
}}
}}
<translate>
<translate>


<!--T:8-->
<!--T:8-->
* Creates a {{incode|BSpline}} object from the given list of points, {{incode|pointslist}}.
* Creates a {{incode|bspline}} object from the given list of points, {{incode|pointslist}}.
** Each point in the list is defined by its {{incode|FreeCAD.Vector}}, with units in millimeters.
** Each point in the list is defined by its {{incode|FreeCAD.Vector}}, with units in millimeters.
** Alternatively, the input can be a {{incode|Part.Wire}}, from which points are extracted.
** Alternatively, the input can be a {{incode|Part.Wire}}, from which points are extracted.
* If {{incode|closed}} is {{incode|True}}, or if the first and last points are identical, the wire is closed.
* If {{incode|closed}} is {{incode|True}}, or if the first and last points are identical, the wire is closed.
* If a {{incode|placement}} is given, it is used; otherwise the shape is created at the origin.
* If {{incode|placement}} is {{incode|None}} the shape is created at the origin.
* If {{incode|face}} is {{incode|True}}, and the spline is closed, the spline will make a face, that is, it will appear filled.
* If {{incode|face}} is {{incode|True}}, and the spline is closed, the spline will make a face, that is, it will appear filled.



<!--T:9-->
<!--T:9-->
<u>Example:</u>
Example:


</translate>
</translate>
Line 122: Line 136:
spline2 = Draft.make_bspline([p1, 2*p3, 1.3*p2], closed=False)
spline2 = Draft.make_bspline([p1, 2*p3, 1.3*p2], closed=False)
spline3 = Draft.make_bspline([1.3*p3, p1, -1.7*p2], closed=False)
spline3 = Draft.make_bspline([1.3*p3, p1, -1.7*p2], closed=False)

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


<!--T:23-->
<u>Note:</u> <br>
The command {{incode|Draft.make_bspline}} has been created for the newer version 0.19, and is not backward compatible. <br>
The command {{incode|Draft.makeBSpline}} works on both version 0.18 and 0.19.


<!--T:17-->
<!--T:17-->
{{Docnav
{{Docnav
|[[Draft_Polygon|Polygon]]
|[[Draft_Dimension|Dimension]]
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_Point|Point]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft_Dimension.svg
|IconL=Draft_Polygon.svg
|IconR=Draft_Point.svg
|IconR=Draft_CubicBezCurve.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 144: Line 155:
{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 09:24, 30 March 2021

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Draft BSpline

Menu location
Drafting → B-spline
Workbenches
Draft, Arch
Default shortcut
B S
Introduced in version
0.7
See also
Draft Wire, Draft CubicBezCurve, Draft BezCurve

Description

The Draft BSpline command creates a B-spline curve from several points. It uses the Draft Linestyle set on the Draft Tray.

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

Spline defined by multiple points

Usage

  1. There are several ways to invoke the command:
    • Press the Draft BSpline button.
    • Select the Drafting → B-spline option from the menu.
    • Use the keyboard shortcut: B then S.
  2. Click the first point in the 3D view, or type coordinates and press the Enter point button in the related Line task panel.
  3. Click additional points in the 3D view, or type coordinates and press the Enter point button in the related Line task panel.
  4. Press Esc or the Close button in the related Line task panel to finish the command.

Options

  • Press A or the Finish button to finish the spline, leaving it open.
  • Press O or the Close button to close the spline, that is, a curve will be added from the last point to the first one to form a face. At least three points are required to form a face.
  • Press W or the Wipe button to remove the curve segments already placed, but keep editing the spline from the last point.
  • Press U or the Set WP button to adjust the current working plane in the orientation of the last point.
  • Press X, Y or Z after a point to constrain the next point on the given axis.
  • To enter coordinates manually, simply enter the numbers, then press Enter between each X, Y and Z component. You can press the Enter point button when you have the desired values to insert the point.
  • Press R or click the checkbox to toggle relative mode. If relative mode is on, the coordinates of the next point are relative to the last one; if not, they are absolute, taken from the origin (0,0,0).
  • Press T or click the checkbox to toggle continue mode. If continue mode is on, the BSpline command will restart after you finish the spline, allowing you to draw another one without pressing the command button again.
  • Press L or click the checkbox to toggle filled mode. If filled mode is on, a closed spline will create a filled face (DataMake Face true); if not, the closed spline will not make a face (DataMake Face false).
Note: the spline should not be filled if it intersects itself, as it won't create a proper face. If the spline is filled but no shape is visible, manually set DataMake Face to false to see the spline.
  • Hold Ctrl while drawing to force snapping your point to the nearest snap location, independently of the distance.
  • Hold Shift while drawing to constrain your next point horizontally or vertically in relation to the last one.
  • Press Ctrl+Z or press the Undo button to undo the last point.
  • Press Esc or the Close button to abort the current command; curve segments already placed will remain.

Notes

Properties

See also: Property editor.

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

Data

  • DataArea (Area): (read-only) specifies the area of the face of the spline. The value will be 0.0 if DataMake Face if false or the face cannot be created.
  • DataClosed (Bool): specifies if the spline is closed or not. If the spline is initially open this value is false, setting it to true will draw a curve segment to close the spline. If the spline is initially closed this value is true, setting it to false will remove the last curve segment and make the spline open.
  • DataMake Face (Bool): specifies if the spline 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 spline does not self-intersect.
  • DataParameterization (Float): affects the shape of the spline.
  • DataPoints (VectorList): specifies the points of the spline in its local coordinate system.

View

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

bspline = make_bspline(pointslist, closed=False, placement=None, face=None, support=None)
bspline = make_bspline(Part.Wire, closed=False, placement=None, face=None, support=None)
  • Creates a bspline object from 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 wire is closed.
  • If placement is None the shape is created at the origin.
  • If face is True, and the spline is closed, the spline 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)

spline1 = Draft.make_bspline([p1, p2, p3], closed=False)
spline2 = Draft.make_bspline([p1, 2*p3, 1.3*p2], closed=False)
spline3 = Draft.make_bspline([1.3*p3, p1, -1.7*p2], closed=False)

doc.recompute()