Skip to content

Commit 1949f78

Browse files
committed
added docstrings to new Surface methods
1 parent 3ad1af2 commit 1949f78

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

src/compas_rhino/geometry/surfaces/surface.py

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,18 @@ def is_v_periodic(self):
8181

8282
@classmethod
8383
def from_corners(cls, corners):
84-
"""
84+
"""Creates a NURBS surface using the given 4 corners.
85+
86+
The order of the given points determins the normal direction of the generated surface.
8587
8688
Parameters
8789
----------
88-
corners :
90+
corners : list(:class:`~compas.geometry.Point`)
91+
4 points in 3d space to represent the corners of the planar surface.
8992
9093
Returns
9194
-------
95+
:class:`~compas_rhino.geometry.RhinoNurbsSurface`
9296
9397
"""
9498
rhino_points = [
@@ -100,18 +104,54 @@ def from_corners(cls, corners):
100104

101105
@classmethod
102106
def from_sphere(cls, sphere):
107+
"""Creates a NURBS surface from a sphere.
108+
109+
Parameters
110+
----------
111+
sphere : :class:`~compas.geometry.Sphere`
112+
The surface's geometry.
113+
114+
Returns
115+
-------
116+
:class:`~compas_rhino.geometry.RhinoNurbsSurface`
117+
118+
"""
103119
sphere = sphere_to_rhino(sphere)
104120
surface = Rhino.Geometry.NurbsSurface.CreateFromSphere(sphere)
105121
return cls.from_rhino(surface)
106122

107123
@classmethod
108124
def from_cylinder(cls, cylinder):
125+
"""Create a NURBS surface from a cylinder.
126+
127+
Parameters
128+
----------
129+
cylinder : :class:`~compas.geometry.Cylinder`
130+
The surface's geometry.
131+
132+
Returns
133+
-------
134+
:class:`~compas_rhino.geometry.RhinoNurbsSurface`
135+
136+
"""
109137
cylinder = cylinder_to_rhino(cylinder)
110138
surface = Rhino.Geometry.NurbsSurface.CreateFromCylinder(cylinder)
111139
return cls.from_rhino(surface)
112140

113141
@classmethod
114-
def from_torus(cls, cylinder):
142+
def from_torus(cls, torus):
143+
"""Create a NURBS surface from a torus.
144+
145+
Parameters
146+
----------
147+
torus : :class:`~compas.geometry.Torus`
148+
The surface's geometry.
149+
150+
Returns
151+
-------
152+
:class:`~compas_rhino.geometry.RhinoNurbsSurface`
153+
154+
"""
115155
raise NotImplementedError
116156

117157
@classmethod

0 commit comments

Comments
 (0)