Profouzors
/
boxespy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc strings for Parts methods

This commit is contained in:
Florian Festi 2018-08-23 23:23:12 +02:00
parent 897fc23029
commit ec77d6aa22
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
boxes/parts.py
View File

@ -26,6 +26,13 @@ class Parts:
return getattr(self.boxes, name) return getattr(self.boxes, name)
def disc(self, diameter, hole=0, callback=None, move=""): def disc(self, diameter, hole=0, callback=None, move=""):
"""Simple disc
:param diameter: diameter of the disc
:param hole: (Default value = 0)
:param callback: (Default value = None) called in the center
:param move: (Defaultvalue = None)
"""
size = diameter size = diameter
r = diameter / 2.0 r = diameter / 2.0
@ -43,6 +50,15 @@ class Parts:
self.move(size, size, move) self.move(size, size, move)
def waivyKnob(self, diameter, n=20, angle=45, hole=0, callback=None, move=""): def waivyKnob(self, diameter, n=20, angle=45, hole=0, callback=None, move=""):
"""Disc with a waivy edge to be easier to be gripped
:param diameter: diameter of the knob
:param n: (Default value = 20) number of waves
:param angle: (Default value = 45) maximum angle of the wave
:param hole: (Default value = 0)
:param callback: (Default value = None) called in the center
:param move: (Defaultvalue = None)
"""
if n < 2: if n < 2:
return return
@ -70,6 +86,16 @@ class Parts:
def concaveKnob(self, diameter, n=3, rounded=0.2, angle=70, hole=0, def concaveKnob(self, diameter, n=3, rounded=0.2, angle=70, hole=0,
callback=None, move=""): callback=None, move=""):
"""Knob with dents to be easier to be gripped
:param diameter: diameter of the knob
:param n: (Default value = 3) number of dents
:param rounded: (Default value = 0.2) proportion of circumferen remaining
:param angle: (Default value = 70) angle the dentsmeet the circumference
:param hole: (Default value = 0)
:param callback: (Default value = None) called in the center
:param move: (Defaultvalue = None)
"""
size = diameter size = diameter
if n < 2: if n < 2:
@ -99,6 +125,14 @@ class Parts:
self.move(size, size, move) self.move(size, size, move)
def ringSegment(self, r_outside, r_inside, angle, n=1, move=None): def ringSegment(self, r_outside, r_inside, angle, n=1, move=None):
"""Ring Segment
:param r_outside: outer radius
:param r_inside: inner radius
:param angle: anlge the segment is spanning
:param n: (Default value = 1) number of segments
:param move: (Defaultvalue = None)
"""
space = 360 * r_inside / self.spacing space = 360 * r_inside / self.spacing
n = min(n, 360 / (angle+space)) n = min(n, 360 / (angle+space))