|
3 | 3 | :platform: Unix, Windows |
4 | 4 | :synopsis: Provides shortcut functions for creating new instances of the geomdl classes |
5 | 5 |
|
6 | | -.. moduleauthor:: Onur Rauf Bingol <orbingol@gmail.com> |
| 6 | +.. moduleauthor:: Onur R. Bingol <contact@onurbingol.net> |
7 | 7 |
|
8 | 8 | """ |
9 | 9 |
|
10 | | -from . import BSpline |
11 | | -from . import NURBS |
12 | | -from . import multi |
13 | | -from . import freeform |
| 10 | +from . import BSpline, NURBS, multi, freeform |
14 | 11 |
|
15 | 12 |
|
16 | 13 | # Initialize an empty __all__ for controlling imports |
17 | 14 | __all__ = [] |
18 | 15 |
|
19 | 16 |
|
20 | 17 | def generate_curve(rational=False): |
| 18 | + """ Returns a curve instance |
| 19 | +
|
| 20 | + :param rational: if True, returns a rational curve instance |
| 21 | + :type rational: bool |
| 22 | + """ |
21 | 23 | if rational: |
22 | 24 | return NURBS.Curve() |
23 | 25 | return BSpline.Curve() |
24 | 26 |
|
25 | 27 |
|
26 | 28 | def generate_surface(rational=False): |
| 29 | + """ Returns a surface instance |
| 30 | +
|
| 31 | + :param rational: if True, returns a rational surface instance |
| 32 | + :type rational: bool |
| 33 | + """ |
27 | 34 | if rational: |
28 | 35 | return NURBS.Surface() |
29 | 36 | return BSpline.Surface() |
30 | 37 |
|
31 | 38 |
|
32 | 39 | def generate_volume(rational=False): |
| 40 | + """ Returns a volume instance |
| 41 | +
|
| 42 | + :param rational: if True, returns a rational volume instance |
| 43 | + :type rational: bool |
| 44 | + """ |
33 | 45 | if rational: |
34 | 46 | return NURBS.Volume() |
35 | 47 | return BSpline.Volume() |
36 | 48 |
|
37 | 49 |
|
38 | 50 | def generate_freeform(): |
| 51 | + """ Returns a freeform instance """ |
39 | 52 | return freeform.Freeform() |
40 | 53 |
|
41 | 54 |
|
42 | 55 | def generate_container_curve(): |
| 56 | + """ Returns a curve container instance """ |
43 | 57 | return multi.CurveContainer() |
44 | 58 |
|
45 | 59 |
|
46 | 60 | def generate_container_surface(): |
| 61 | + """ Returns a surface container instance """ |
47 | 62 | return multi.SurfaceContainer() |
48 | 63 |
|
49 | 64 |
|
50 | 65 | def generate_container_volume(): |
| 66 | + """ Returns a volume container instance """ |
51 | 67 | return multi.VolumeContainer() |
0 commit comments