Draft BSpline: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updated default shortcuts.)
 
(110 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>

<!--T:18-->
{{Docnav
|[[Draft_Polygon|Polygon]]
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Polygon.svg
|IconR=Draft_CubicBezCurve.svg
|IconC=Workbench_Draft.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Draft BSpline|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|MenuLocation=Draft → BSpline|Shortcut=B S|SeeAlso=[[Draft Wire|Draft Wire]]}}
|Name=Draft BSpline
|MenuLocation=Drafting → B-spline
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|B}} {{KEY|S}}
|Version=0.7
|SeeAlso=[[Draft_Wire|Draft Wire]], [[Draft_CubicBezCurve|Draft CubicBezCurve]], [[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 takes the [[Draft Linestyle|linewidth and color]] previously set on the Tasks tab. The BSpline tool behaves exactly like the [[Draft Wire]] tool.


<!--T:3-->
<!--T:2-->
The [[Image:Draft_BSpline.svg|24px]] '''Draft BSpline''' command creates a [http://en.wikipedia.org/wiki/B-spline B-spline curve] from several points.

<!--T:11-->
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>
[[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 {{KEY|[[Image:Draft BSpline.png|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]]
# Click additional point on the 3D view, or type a [[Draft_Coordinates|coordinate]]
# Press {{KEY|F}} or {{KEY|C}}, or double-click the last point, or click on the first point to finish or close the spline. If the spline is closed, it will also be a face, even if it appears as wireframe.


==Options== <!--T:5-->
<!--T:24-->
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]].
* Press {{KEY|F}} or the {{KEY|[[Image:Draft FinishLine.png|12px]] '''[[Draft_FinishLine|Finish]]'''}} button to finish the spline, leaving it open

* Press {{KEY|C}} or the {{KEY|[[Image:Draft CloseLine.png|12px]] '''[[Draft_CloseLine|Close]]'''}} button or click on the first point to finish the spline, but making it closed by adding a last segment between the last point and the first one.
<!--T:4-->
* Press {{KEY|X}}, {{KEY|Y}} or {{KEY|Z}} after a point to constrain the next point on the given axis.
# There are several ways to invoke the command:
* To enter coordinates manually, simply enter the numbers, then press {{KEY|ENTER}} between each X, Y and Z component.
#* Press the {{Button|[[Image:Draft_BSpline.svg|16px]] [[Draft_BSpline|B-spline]]}} button.
* Press {{KEY|R}} or click the checkbox to check/uncheck the {{KEY|'''Relative'''}} button. 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 (0,0,0) origin point.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_BSpline.svg|16px]] B-spline}} option from the menu.
* Press {{KEY|T}} or click the checkbox to check/uncheck the {{KEY|'''Continue'''}} button. If continue mode is on, the BSpline tool will restart after you finish or close it, allowing you to draw another one without pressing the BSpline button again.
#* Use the keyboard shortcut: {{KEY|B}} then {{KEY|S}}.
* Press {{KEY|CTRL}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
# The {{MenuCommand|B-spline}} task panel opens. See [[#Options|Options]] for more information.
* Press {{KEY|SHIFT}} while drawing to [[Draft_Constrain|constrain]] your next point horizontally or vertically in relation to the last one.
# 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.
* Press {{KEY|W}} or press the {{KEY|[[Image:Draft Wipe.png|12px]] '''Wipe'''}} button to remove the existing segments and start the spline from the last point.
* Press {{KEY|CTRL}}+{{KEY|Z}} or press the {{KEY|[[Image:Draft UndoLine.png|12px]] '''[[Draft_UndoLine|Undo]]'''}} button to undo the last point.
# Pick additional points in the [[3D_view|3D view]], or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
* Press {{KEY|I}} or the {{KEY|'''Filled'''}} button to have the spline filled with a face after it has been closed.
# Press {{KEY|Esc}} or the {{Button|Close}} button to finish the command.

* Press {{KEY|ESC}} or the {{KEY|'''Cancel'''}} button to abort the current BSpline command.
==Options== <!--T:25-->
* BSplines, when in "Flat Lines" display mode, can display a hatch pattern, by setting their "Pattern" property below.

<!--T:26-->
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, 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|F}} or click the {{MenuCommand|Filled}} checkbox to toggle filled mode. If filled mode is on, the created spline 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 spline with a face will not display properly, for such a spline {{PropertyData|Make Face}} must be set to {{FALSE}}.
* 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 spline by snapping to the first point of the spline, allowing you to continue creating splines.
* 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 spline open.
* Press {{KEY|O}} or the {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}} button to finish the command and close the spline. A closed spline can also be created by snapping to the first point of the spline.
* Press {{KEY|W}} or the {{Button|[[Image:Draft Wipe.svg|16px]] Wipe}} button to delete the curve segments already placed, but keep working from the last 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|Esc}} or the {{Button|Close}} button to finish the command.

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

<!--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-->
* {{PropertyData|Closed}}: Specifies if the spline is closed or not
* {{PropertyData|Make Face}}: Fills the spline with a face
* {{PropertyView|End Arrow}}: Shows an arrow symbol at the last point of the spline, so it can be used as an annotation leader line
* {{PropertyView|Pattern}}: Specifies a hatch pattern to fill the wire with
* {{PropertyView|Pattern Size}}: Specifies the size of the hatch pattern


==Scripting== <!--T:7-->
<!--T:28-->
See also: [[Property_editor|Property editor]].
The BSpline tool can by used in [[macros]] and from the python console by using the following function:

<!--T:29-->
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:30-->

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

<!--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 === <!--T:31-->

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

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

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

<!--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 BSpline use the {{incode|make_bspline}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeBSpline}} method.


</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 spline is closed.
* Instead of a list of points, you can also pass a Part Wire.
* Returns the newly created object.
* If {{incode|placement}} is {{incode|None}} the spline 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.


<!--T:9-->
<!--T:9-->
Line 57: Line 136:
</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>
{{clear}}

<languages/>

<!--T:17-->
{{Docnav
|[[Draft_Polygon|Polygon]]
|[[Draft_CubicBezCurve|CubicBezCurve]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Polygon.svg
|IconR=Draft_CubicBezCurve.svg
|IconC=Workbench_Draft.svg
}}

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

Latest revision as of 18:27, 6 January 2024

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.

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

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

  1. There are several ways to invoke the command:
    • Press the B-spline button.
    • Select the Drafting → B-spline option from the menu.
    • Use the keyboard shortcut: B then S.
  2. The B-spline 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 spline 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 spline with a face will not display properly, for such a spline 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 spline by snapping to the first point of the spline, allowing you to continue creating splines.
  • Press / or the Undo button to undo the last point.
  • Press A or the Finish button to finish the command and leave the spline open.
  • Press O or the Close button to finish the command and close the spline. A closed spline can also be created by snapping to the first point of the spline.
  • Press W or the Wipe button to delete the curve 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

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

Draft

  • 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

Draft

  • 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 spline is closed.
  • If placement is None the spline 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()