Draft BSpline: Difference between revisions
m (clarifying the location of buttons to finish operations) |
(Updated default shortcuts.) |
||
(36 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Page_in_progress}} |
|||
<languages/> |
<languages/> |
||
<translate> |
<translate> |
||
Line 7: | Line 6: | ||
|[[Draft_Polygon|Polygon]] |
|[[Draft_Polygon|Polygon]] |
||
|[[Draft_CubicBezCurve|CubicBezCurve]] |
|[[Draft_CubicBezCurve|CubicBezCurve]] |
||
|[[ |
|[[Draft_Workbench|Draft]] |
||
|IconL=Draft_Polygon.svg |
|IconL=Draft_Polygon.svg |
||
|IconR=Draft_CubicBezCurve.svg |
|IconR=Draft_CubicBezCurve.svg |
||
Line 17: | Line 16: | ||
|Name=Draft BSpline |
|Name=Draft BSpline |
||
|MenuLocation=Drafting → B-spline |
|MenuLocation=Drafting → B-spline |
||
|Workbenches=[[ |
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]] |
||
|Shortcut={{KEY|B}} {{KEY|S}} |
|Shortcut={{KEY|B}} {{KEY|S}} |
||
|Version=0.7 |
|Version=0.7 |
||
Line 26: | Line 25: | ||
<!--T:2--> |
<!--T:2--> |
||
The [[Image:Draft_BSpline.svg|24px]] |
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--> |
<!--T:11--> |
||
Line 37: | Line 36: | ||
{{Caption|Spline defined by multiple points}} |
{{Caption|Spline defined by multiple points}} |
||
==Usage== <!--T:22--> |
==Usage== <!--T:22--> |
||
<!--T:24--> |
|||
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]]. |
|||
<!--T:4--> |
<!--T:4--> |
||
# There are several ways to invoke the command: |
# There are several ways to invoke the command: |
||
#* Press the {{Button|[[Image:Draft_BSpline.svg|16px]] [[Draft_BSpline| |
#* Press the {{Button|[[Image:Draft_BSpline.svg|16px]] [[Draft_BSpline|B-spline]]}} button. |
||
#* Select the {{MenuCommand|Drafting → [[Image:Draft_BSpline.svg|16px]] B-spline}} option from the menu. |
#* Select the {{MenuCommand|Drafting → [[Image:Draft_BSpline.svg|16px]] B-spline}} option from the menu. |
||
#* Use the keyboard shortcut: {{KEY|B}} then {{KEY|S}}. |
#* Use the keyboard shortcut: {{KEY|B}} then {{KEY|S}}. |
||
# The {{MenuCommand|B-spline}} 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. |
||
⚫ | |||
# Press {{KEY|Esc}} or the {{Button|Close}} button |
# Press {{KEY|Esc}} or the {{Button|Close}} button to finish the command. |
||
==Options== |
==Options== <!--T:25--> |
||
<!--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--> |
<!--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| |
* 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|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|X}}, {{KEY|Y}} or {{KEY|Z}} after a point to constrain the next point on the given axis. |
|||
* |
* 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| |
* 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. |
||
⚫ | |||
⚫ | |||
⚫ | |||
:{{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|S}} to switch [[Draft_Snap|Draft snapping]] on or off. |
||
⚫ | |||
* Hold {{KEY|Shift}} while drawing to [[Draft_Constrain|constrain]] your next point horizontally or vertically in relation to the last one. |
|||
⚫ | |||
⚫ | |||
==Notes== |
==Notes== <!--T:27--> |
||
<!--T:10--> |
<!--T:10--> |
||
Line 74: | Line 78: | ||
==Properties== <!--T:6--> |
==Properties== <!--T:6--> |
||
<!--T:28--> |
|||
⚫ | |||
See also: [[Property_editor|Property editor]]. |
|||
<!--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: |
|||
⚫ | |||
<!--T:36--> |
|||
{{TitleProperty|Draft}} |
|||
<!--T:14--> |
<!--T:14--> |
||
* {{PropertyData| |
* {{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| |
* {{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. |
|||
:{{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 |
* {{PropertyData|Parameterization|Float}}: affects the shape of the spline. |
||
* {{PropertyData|Points|VectorList}}: specifies the points of the spline in its local coordinate system. |
|||
⚫ | |||
<!--T:37--> |
|||
⚫ | |||
{{TitleProperty|Draft}} |
|||
<!--T:15--> |
<!--T:15--> |
||
* {{PropertyView|Arrow Size}}: specifies the size of the symbol displayed at the end of the spline. |
* {{PropertyView|Arrow Size|Length}}: 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 |
* {{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}}: specifies whether to show a symbol at the |
* {{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}}: specifies |
* {{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}}: specifies the size of the [[ |
* {{PropertyView|Pattern Size|Float}}: specifies the size of the [[Draft_Pattern|Draft Pattern]]. |
||
==Scripting== |
==Scripting== <!--T:32--> |
||
<!--T:7--> |
<!--T:7--> |
||
See also: [https:// |
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
||
<!--T:16--> |
<!--T:16--> |
||
Line 110: | Line 127: | ||
** 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 |
* If {{incode|closed}} is {{incode|True}}, or if the first and last points are identical, the spline is closed. |
||
* If {{incode|placement}} is {{incode|None}} the |
* 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. |
* If {{incode|face}} is {{incode|True}}, and the spline is closed, the spline will make a face, that is, it will appear filled. |
||
Line 141: | Line 158: | ||
|[[Draft_Polygon|Polygon]] |
|[[Draft_Polygon|Polygon]] |
||
|[[Draft_CubicBezCurve|CubicBezCurve]] |
|[[Draft_CubicBezCurve|CubicBezCurve]] |
||
|[[ |
|[[Draft_Workbench|Draft]] |
||
|IconL=Draft_Polygon.svg |
|IconL=Draft_Polygon.svg |
||
|IconR=Draft_CubicBezCurve.svg |
|IconR=Draft_CubicBezCurve.svg |
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.
- 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.
- The B-spline task panel opens. See Options for more information.
- Pick the first point in the 3D view, or type coordinates and press the Enter point button.
- Pick additional points in the 3D view, or type coordinates and press the Enter point button.
- 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 tofalse
. - 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
- A Draft BSpline can be edited with the Draft Edit command.
- A Draft BSpline can be converted to a Draft Wire with the Draft WireToBSpline command.
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 be0.0
if DataMake Face iffalse
or the face cannot be created. - DataClosed (
Bool
): specifies if the spline is closed or not. If the spline is initially open this value isfalse
, setting it totrue
will draw a curve segment to close the spline. If the spline is initially closed this value istrue
, setting it tofalse
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 istrue
a face is created, otherwise only the perimeter is considered part of the object. This property only works if DataClosed istrue
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 beDot
,Circle
,Arrow
,Tick
orTick-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 istrue
and if ViewDisplay Mode isFlat 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.
- Each point in the list is defined by its
- If
closed
isTrue
, or if the first and last points are identical, the spline is closed. - If
placement
isNone
the spline is created at the origin. - If
face
isTrue
, 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()
- Drafting: Line, Polyline, Fillet, Arc, Arc by 3 points, Circle, Ellipse, Rectangle, Polygon, B-spline, Cubic Bézier curve, Bézier curve, Point, Facebinder, ShapeString, Hatch
- Annotation: Text, Dimension, Label, Annotation styles, Annotation scale
- Modification: Move, Rotate, Scale, Mirror, Offset, Trimex, Stretch, Clone, Array, Polar array, Circular array, Path array, Path link array, Point array, Point link array, Edit, Subelement highlight, Join, Split, Upgrade, Downgrade, Wire to B-spline, Draft to sketch, Set slope, Flip dimension, Shape 2D view
- Draft Tray: Select plane, Set style, Toggle construction mode, AutoGroup
- Snapping: Snap lock, Snap endpoint, Snap midpoint, Snap center, Snap angle, Snap intersection, Snap perpendicular, Snap extension, Snap parallel, Snap special, Snap near, Snap ortho, Snap grid, Snap working plane, Snap dimensions, Toggle grid
- Miscellaneous: Apply current style, Layer, Manage layers, Add a new named group, Move to group, Select group, Add to construction group, Toggle normal/wireframe display, Create working plane proxy, Heal, Show snap toolbar
- Additional: Constraining, Pattern, Preferences, Import Export Preferences, DXF/DWG, SVG, OCA, DAT
- Context menu:
- Layer container: Merge layer duplicates, Add new layer
- Layer: Activate this layer, Select layer contents
- Text: Open hyperlinks
- Wire: Flatten
- Working plane proxy: Write camera position, Write objects state
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub