Draft: better docstring for offset - fixes #2199

This commit is contained in:
Yorik van Havre 2016-02-28 19:28:35 -03:00
parent a59b915132
commit 5bdbe2db61

View File

@ -1451,13 +1451,15 @@ def scale(objectslist,delta=Vector(1,1,1),center=Vector(0,0,0),copy=False,legacy
return obj return obj
def offset(obj,delta,copy=False,bind=False,sym=False,occ=False): def offset(obj,delta,copy=False,bind=False,sym=False,occ=False):
'''offset(object,Vector,[copymode],[bind]): offsets the given wire by '''offset(object,delta,[copymode],[bind]): offsets the given wire by
applying the given Vector to its first vertex. If copymode is applying the given delta Vector to its first vertex. If copymode is
True, another object is created, otherwise the same object gets True, another object is created, otherwise the same object gets
offsetted. If bind is True, and provided the wire is open, the original 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 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 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 import Part, DraftGeomUtils
newwire = None newwire = None
delete = None delete = None