fromShapes - sliptonic/FreeCAD GitHub Wiki

Returns a Path object from a list of shapes

fromShapes(shapes, start=Vector(), arc_plane=1, sort_mode=1, min_dist=0.0, abscissa=3.0, nearest_k=3, orientation=0, direction=0, threshold=0.0, retraction=0.0, retract_axis=2, clearance=0.0, segmentation=0.0, feedrate=0.0, feedrate_v=0.0, verbose=true, abs_center=false, deflection=0.01)

Returns a Path object from a list of shapes

  • shapes: input list of shapes.

  • start (Vector()): optional start position. feed start position, and also serves as a hint of path entry.

  • return_end (False): if True, returns tuple (path, endPosition).

  • arc_plane(1): 0=None,1=Auto,2=XY,3=ZX,4=YZ,5=Variable. Arc drawing plane, corresponding to G17, G18, and G19. If not 'None', the output wires will be transformed to align with the selected plane, and the corresponding GCode will be inserted. 'Auto' means the plane is determined by the first encountered arc plane. If the found plane does not align to any GCode plane, XY plane is used. 'Variable' means the arc plane can be changed during operation to align to the the arc encountered.

  • sort_mode(1): 0=None,1=2D5,2=3D. Wire sorting mode to optimize travel distance. '2D5' explode shapes into wires, and groups the shapes by its plane. The 'start' position chooses the first plane to start. The algorithm will then sort within the plane and then move on to the next nearest plane. '3D' makes no assumption of planarity. The sorting is done across 3D space

  • min_dist(0.0): minimum distance for the generated new wires. Wires maybe broken if the algorithm see fits. Set to zero to disable wire breaking.

  • abscissa(3.0): Controls vertex sampling on wire for nearest point searching The sampling is dong using OCC GCPnts_UniformAbscissa

  • nearest_k(3): Nearest k sampling vertices are considered during sorting

  • orientation(0): 0=None,1=CW,2=CCW. Enforce loop orientation Note the CW/CCW here specifies the outer wire orientation. For inner wires (holes), the enforced orientation is reversed

  • direction(0): 0=None,1=XPositive,2=XNegative,3=YPositive,4=YNegative,5=ZPositive,6=ZNegative. Enforce open path direction

  • threshold(0.0): If two wire's end points are separated within this threshold, they are consider as connected. You may want to set this to the tool diameter to keep the tool down.

  • retraction(0.0): Tool retraction absolute coordinate along retraction axis

  • retract_axis(2): 0=X,1=Y,2=Z. Tool retraction axis

  • clearance(0.0): When return from last retraction, this gives the pause height relative to the Z value of the next move

  • segmentation(0.0): Break long curves into segments of this length. One use case is for PCB autolevel, so that more correction points can be inserted

  • feedrate(0.0): Normal move feed rate

  • feedrate_v(0.0): Vertical only (step down) move feed rate

  • verbose(true): If true, each motion GCode will contain full coordinate and feedrate

  • abs_center(false): Use absolute arc center mode (G90.1)

  • deflection(0.01): Deflection for non circular curve discretization. It also also used for discretizing circular wires when you 'Explode' the shape for wire operations