X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fprojection_on_cylinder_operation.doc;fp=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fprojection_on_cylinder_operation.doc;h=be0c5aa279bde7f24c43a9bbb0b4a0b1520108e1;hb=87533ec02b1e1d85e797013ee7c377b2b25801be;hp=0000000000000000000000000000000000000000;hpb=900bf17d4b306071068cd3f031b3b5ff11552ba6;p=modules%2Fgeom.git

diff --git a/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc b/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc
new file mode 100644
index 000000000..be0c5aa27
--- /dev/null
+++ b/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc
@@ -0,0 +1,40 @@
+/*!
+
+\page projection_on_cylinder_operation_page Projection on Cylinder
+
+\n To produce a <b>Projection on Cylinder</b> in the <b>Main Menu</b> select
+<b>Operations - > Transformation - > Projection on Cylinder</b>
+
+\n This operation makes a projection of a <b>Source planar wire or face</b> on
+a cylinder defined by its radius. The cylinder's coordinate system is
+the same as the global coordinate system. The result represents a wire or
+a face that represents a projection of the source shape onto a cylinder.
+
+To make a projection it is necessary to define:
+- \b Object to be projected. It can be either a planar wire or a face;
+- \b Radius of the cylinder;
+- <b>Starting angle</b> from the cylinder's X axis around Z axis. This is
+the angle of the projection starting.
+- <b>Length angle</b> in which to project the total length of
+the wire. If it is unchecked the projection is not scaled and natural
+wire length is kept for the projection.
+
+\ref restore_presentation_parameters_page "Advanced options".
+
+\image html proj_on_cyl_dlg.png
+
+\n <b>Example:</b>
+
+\image html proj_on_cyl_preview.png "The curve (in red) and its projection on the cylinder"
+
+\n <b>TUI Command:</b> <em>geompy.MakeProjectionOnCylinder(theObject, theRadius,
+theStartAngle=0.0, theAngleLength=-1.0),</em>
+where \em theObject is a shape which has to be projected, \em theRadius
+is a cylinder radius, \em theStartAngle the starting angle of projection in
+radians, \em theAngleLength the projection length angle in radians.
+The \em Result will be a \em GEOM_Object.
+
+Our <b>TUI Scripts</b> provide you with useful examples of the use of
+\ref tui_projection "Transformation Operations".
+
+*/