Doc : Add an Angle option in the cylinder primitive in order to build portion of cylinders in both constructors.

This commit is contained in:
Florian Brunet 2014-08-05 17:34:49 +02:00
parent 8f2784ea72
commit 882ffe16a5
4 changed files with 7 additions and 6 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

@ -11,18 +11,19 @@ Entity - > Primitives - > Cylinder</b>
\n Firstly, you can define a \b Cylinder by the <b>Base Point</b> (the central \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), 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 Radius and the Height.
\n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height)</em> \n <b>Angle</b> checkbox and field allow defining an angle to build a portion of cylinder.
\n <b>Arguments:</b> Name + 1 vertex + 1 vector + 2 values \n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height, Angle=2*pi)</em>
(Dimensions: radius and height). \n <b>Arguments:</b> Name + 1 vertex + 1 vector + 3 values
(Dimensions: radius, height and angle).
\image html cylinder1.png \image html cylinder1.png
\n Secondly, you can define a \b Cylinder by the given radius and the \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 height at the origin of coordinate system. The axis of the cylinder
will be collinear to the OZ axis of the coordinate system. will be collinear to the OZ axis of the coordinate system.
\n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height)</em> <b>Angle</b> checkbox and field allow defining an angle to build a portion of cylinder.
\n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and \n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height, Angle=2*pi)</em>
height). \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius, height, angle).
\image html cylinder2.png \image html cylinder2.png