doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc

   1 /*!
   2
   3 \page projection_on_cylinder_operation_page Projection on Cylinder
   4
   5 \n To produce a <b>Projection on Cylinder</b> in the <b>Main Menu</b> select
   6 <b>Operations - > Transformation - > Projection on Cylinder</b>
   7
   8 \n This operation makes a projection of a <b>Source planar wire or face</b> on
   9 a cylinder defined by its radius. The cylinder's coordinate system is
  10 the same as the global coordinate system. The result represents a wire or
  11 a face that represents a projection of the source shape onto a cylinder.
  12
  13 To make a projection it is necessary to define:
  14 - \b Object to be projected. It can be either a planar wire or a face;
  15 - \b Radius of the cylinder;
  16 - <b>Starting angle</b> from the cylinder's X axis around Z axis. This is
  17 the angle of the projection starting.
  18 - <b>Length angle</b> in which to project the total length of
  19 the wire. If it is unchecked the projection is not scaled and natural
  20 wire length is kept for the projection.
  21
  22 \ref restore_presentation_parameters_page "Advanced options".
  23
  24 \image html proj_on_cyl_dlg.png
  25
  26 \n <b>Example:</b>
  27
  28 \image html proj_on_cyl_preview.png "The curve (in red) and its projection on the cylinder"
  29
  30 \n <b>TUI Command:</b> <em>geompy.MakeProjectionOnCylinder(theObject, theRadius,
  31 theStartAngle=0.0, theAngleLength=-1.0),</em>
  32 where \em theObject is a shape which has to be projected, \em theRadius
  33 is a cylinder radius, \em theStartAngle the starting angle of projection in
  34 radians, \em theAngleLength the projection length angle in radians.
  35 The \em Result will be a \em GEOM_Object.
  36
  37 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  38 \ref tui_projection "Transformation Operations".
  39
  40 */