Draft BSpline: Difference between revisions

From FreeCAD Documentation
(Data and View sections)
No edit summary
(47 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>
<!--T:18-->
{{Docnav
|[[Draft_Dimension|Dimension]]
|[[Draft_Point|Point]]
|[[Draft_Module|Draft]]
|IconL=Draft_Dimension.svg
|IconR=Draft_Point.svg
|IconC=Workbench_Draft.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Draft BSpline
|Name=Draft BSpline
|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]
|MenuLocation=Draft → BSpline
|MenuLocation=Draft → BSpline
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Shortcut=B S
|Shortcut={{KEY|B}} {{KEY|S}}
|SeeAlso=[[Draft Wire|Draft Wire]], [[Draft Line]]}}
|Version=0.7
|SeeAlso=[[Draft_Wire|Draft Wire]], [[Draft_BezCurve|Draft BezCurve]]
}}


==Description== <!--T:2-->
==Description== <!--T:21-->
The BSpline tool creates a [http://en.wikipedia.org/wiki/B-spline B-Spline curve] from several points in the current [[Draft SelectPlane|work plane]]. It uses the [[Draft Linestyle]] set on the [[Draft Tray]]. The BSpline tool behaves like the [[Draft Wire]] tool, but is curved.


<!--T:3-->
<!--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]].

<!--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-->
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]]}}.

</translate>
[[Image:Draft_bspline_example.jpg|400px]]
[[Image:Draft_bspline_example.jpg|400px]]
<translate>
<!--T:3-->
{{Caption|Spline defined by multiple points}}


==How to use== <!--T:4-->
==Usage== <!--T:22-->

# Press the {{Button|[[Image:Draft BSpline.png|16px]] [[Draft BSpline]]}} button, or press {{KEY|B}} then {{KEY|S}} keys
<!--T:4-->
# Click a first point on the 3D view, or type a [[Draft_Coordinates|coordinate]]
# Press the {{Button|[[Image:Draft_BSpline.svg|16px]] [[Draft BSpline]]}} button, or press {{KEY|B}} then {{KEY|S}} keys
# Click additional point on the 3D view, or type a [[Draft_Coordinates|coordinate]]
# 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.
# 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.
# Press {{KEY|Esc}} or the {{Button|Close}} button to complete the edition.

<!--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-->
==Options== <!--T:5-->
* Press {{KEY|A}} or the {{Button|[[Image:Draft FinishLine.png|12px]] [[Draft_FinishLine|Finish]]}} button to finish the spline, leaving it open.
* Press {{KEY|A}} or the {{Button|[[Image:Draft_FinishLine.svg|12px]] [[Draft_FinishLine|Finish]]}} button to finish the spline, leaving it open.
* Press {{KEY|O}} or the {{Button|[[Image:Draft CloseLine.png|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]] [[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|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]] [[Draft_Wipe|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.
* 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 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 tool will restart after you finish the spline, allowing you to draw another one without pressing the tool 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.
* 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 next point horizontally or vertically in relation to the last one.
* 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.
* Press {{KEY|Ctrl}}+{{KEY|Z}} or press the {{Button|[[Image:Draft UndoLine.png|12px]] [[Draft_UndoLine|Undo]]}} button to undo the last point.
* Press {{KEY|Esc}} or the {{button|Cancel}} button to abort the current command; curve segments already placed will remain.
* 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|Esc}} or the {{Button|Close}} button to abort the current command; curve segments already placed will remain.


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

=== Data ===
<!--T:13-->
A BSpline object shares most properties from a [[Draft Wire|Draft Wire]], however, most properties only make sense for a Wire.

=== Data === <!--T:14-->
* {{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.
* {{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.
* {{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}}.
* {{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}}.
:{{Emphasis|Note:}} do not set {{PropertyData|Make Face}} to {{TRUE}} if the spline intersects itself, as it won't create a proper face.
* {{PropertyData|Parameterization}}: affects the shape of the BSpline.


=== View ===
=== View === <!--T:15-->
* {{PropertyView|Arrow Size}}: specifies the size of the symbol displayed at the end of the spline.
* {{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, and tick.
* {{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|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]] 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}}: 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]].
* {{PropertyView|Pattern Size}}: specifies the size of the [[Draft Pattern|Draft Pattern]].


==Scripting== <!--T:7-->
==Scripting== <!--T:7-->
{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
The BSpline tool can by used in [[macros]] and from the python console by using the following function:

<!--T:16-->
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=
makeBSpline (pointslist,[closed],[placement])
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)
}}
}}
<translate>
<translate>

<!--T:8-->
<!--T:8-->
* Creates a B-Spline object from the given list of vectors.
* 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.
* If closed is True or first and last points are identical, the wire is closed.
** Alternatively, the input can be a {{incode|Part.Wire}}, from which points are extracted.
* If face is true (and the bspline is closed), the bspline will appear filled.
* If {{incode|closed}} is {{incode|True}}, or if the first and last points are identical, the wire is closed.
* Instead of a list of points, you can also pass a Part Wire.
* If a {{incode|placement}} is given, it is used; otherwise the shape is created at the origin.
* Returns the newly created object.
* 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-->
Line 67: Line 109:
</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD,Draft
import FreeCAD as App
import Draft
p1 = FreeCAD.Vector(0,0,0)
p2 = FreeCAD.Vector(1,1,0)
p3 = FreeCAD.Vector(2,0,0)
Draft.makeBSpline([p1,p2,p3],closed=True)


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()
}}
}}
<translate>

<!--T:17-->
{{Docnav
|[[Draft_Dimension|Dimension]]
|[[Draft_Point|Point]]
|[[Draft_Module|Draft]]
|IconL=Draft_Dimension.svg
|IconR=Draft_Point.svg
|IconC=Workbench_Draft.svg
}}

</translate>
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

Revision as of 15:51, 29 November 2020

Draft BSpline

Menu location
Draft → BSpline
Workbenches
Draft, Arch
Default shortcut
B S
Introduced in version
0.7
See also
Draft Wire, Draft BezCurve

Description

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

The BSpline tool behaves like the Wire tool, except that each of its segments is curved instead of being a straight line. Use Wire to B-spline to convert one to the other.

The BSpline tool specifies the exact points through which the curve will go; on the other hand the Bezier curve tool uses control points to define the direction of the curve. To create exact circular or elliptical curves, use Arc and Ellipse.

Spline defined by multiple points

Usage

  1. Press the Draft BSpline button, or press B then S keys
  2. Click a first point on the 3D view, or type a coordinate and press the add point button.
  3. Click additional points on the 3D view, or type a coordinate and press the add point button.
  4. Press Esc or the Close button to complete the edition.

The spline can be edited by double clicking on the element in the tree view, or by pressing the Draft Edit button. Then you can move the points to a new position, or click add point or remove point and then click on the wire to add or remove points.

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 add 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 tool will restart after you finish the spline, allowing you to draw another one without pressing the tool 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.

Properties

A BSpline object shares most properties from a Draft Wire, however, most properties only make sense for a Wire.

Data

  • DataClosed: 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: 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.
Note: do not set DataMake Face to true if the spline intersects itself, as it won't create a proper face.
  • DataParameterization: affects the shape of the BSpline.

View

  • ViewArrow Size: specifies the size of the symbol displayed at the end of the spline.
  • ViewArrow Type: specifies the type of symbol displayed at the end of the spline, which can be "Dot", "Circle", "Arrow", or "Tick".
  • ViewEnd Arrow: specifies whether to show a symbol at the last point of the spline, so it can be used as an annotation line.
  • ViewPattern: specifies a Draft Pattern with which to fill the face of a closed spline. This property only works if DataMake Face is true, and if ViewDisplay Mode is "Flat Lines".
  • ViewPattern Size: specifies the size of the Draft Pattern.

Scripting

See also: Draft API and FreeCAD Scripting Basics.

The BSpline tool can be used in macros and from the Python console by using the following function:

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 a placement is given, it is used; otherwise 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()