Salome HOME
Merge changes for HYDRO project : hydro/imps_2017_salome_83 branch.
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_cylinder.doc
index 1e1cbc16d289a88770d0ca89d19e1243ce93eaed..8b81f79820a668899917dff9f87463d122a8e199 100644 (file)
@@ -10,20 +10,33 @@ Entity - > Primitives - > Cylinder</b>
 
 \n Firstly, you can define a \b Cylinder by the <b>Base Point</b> (the central
 point of the cylinder base), the \b Vector (the axis of the cylinder),
-and its dimensions: the Radius and the Height.
+and its dimensions: the \b Radius and the \b Height. You can optionally specify
+the \b Angle to create a portion of cylinder.
+
 \n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height)</em>
 \n <b>Arguments:</b>  Name + 1 vertex + 1 vector + 2 values
 (Dimensions: radius and height).
 
+\n <b>TUI Command:</b> <em>geompy.MakeCylinderA(Point, Axis, Radius, Height, Angle)</em>
+\n <b>Arguments:</b>  Name + 1 vertex + 1 vector + 3 values
+(Dimensions: radius, height and angle).
+
 \image html cylinder1.png
 
-\n Secondly, you can define a \b Cylinder by the given radius and the
-height at  the origin of coordinate system. The axis of the cylinder
-will be collinear to the OZ axis of the coordinate system.
+\n Secondly, you can define a \b Cylinder by the given \b Radius and
+\b Height at the origin of coordinate system. The axis of the cylinder
+will be collinear to the OZ axis of the coordinate system. 
+Similarly to the first constructor, you can optionally specify the \b Angle
+to create a portion of cylinder.
+
 \n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height)</em>
 \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and
 height).
 
+\n <b>TUI Command:</b> <em>geompy.MakeCylinderRHA(Radius, Height, Angle)</em>
+\n <b>Arguments:</b>  Name + 3 values
+(Dimensions at origin: radius, height and angle).
+
 \image html cylinder2.png
 
 <b>Example:</b>