Draft BSpline
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
- 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.
- Click the first point in the 3D view, or type coordinates and press the Enter point button.
- Click 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
- 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 Facefalse
).
- 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
- 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
Data
- DataClosed: specifies if the spline is closed or not. If the spline is initially open, this value is
false
; 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: 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 istrue
.
- 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: Autogenerated API documentation and FreeCAD Scripting Basics.
To create a Draft BSpline use the make_bspline
method of the Draft module:
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 wire is closed. - If
placement
isNone
the shape 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()
Draft
- 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
User documentation
- 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, Assembly, BIM, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub