Skip to content

Commit

Permalink
Draft: better docstring for offset - fixes #2199
Browse files Browse the repository at this point in the history
  • Loading branch information
yorikvanhavre committed Feb 28, 2016
1 parent a59b915 commit 5bdbe2d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/Mod/Draft/Draft.py
Expand Up @@ -1451,13 +1451,15 @@ def scale(objectslist,delta=Vector(1,1,1),center=Vector(0,0,0),copy=False,legacy
return obj

def offset(obj,delta,copy=False,bind=False,sym=False,occ=False):
'''offset(object,Vector,[copymode],[bind]): offsets the given wire by
applying the given Vector to its first vertex. If copymode is
'''offset(object,delta,[copymode],[bind]): offsets the given wire by
applying the given delta Vector to its first vertex. If copymode is
True, another object is created, otherwise the same object gets
offsetted. If bind is True, and provided the wire is open, the original
and the offsetted wires will be bound by their endpoints, forming a face
if sym is True, bind must be true too, and the offset is made on both
sides, the total width being the given delta length.'''
sides, the total width being the given delta length. If offsetting a
BSpline, the delta must not be a Vector but a list of Vectors, one for
each node of the spline.'''
import Part, DraftGeomUtils
newwire = None
delete = None
Expand Down

0 comments on commit 5bdbe2d

Please sign in to comment.