doc/salome/gui/SMESH/input/clipping.doc

   1 /*!
   2
   3 \page clipping_page Clipping
   4
   5 \n Using this menu you can create cross-section views (clipping planes)
   6 of your mesh.
   7
   8 To start, click on the \em New button.
   9
  10 Now you must specify what mode of creating plane you want to choose:
  11 absolute or relative.
  12
  13 <b>Absolute mode</b>
  14
  15 \image html Clipping_Absolute.png
  16
  17 - <b>Base point</b> - allows to define the coordinates of the base
  18   point for the clipping plane.
  19
  20   - <b>Reset</b> - returns the base point to coordinate origin.
  21
  22 - <b>Direction</b> - allows to define the orientation of the
  23   clipping plane.
  24
  25   - <b>Invert</b> - allows to select which part of the object will be
  26     removed and which will remain after clipping.
  27
  28 <b>Relative mode</b>
  29
  30 \image html Clipping_Relative.png
  31
  32 - \b Orientation ( ||X-Y, ||X-Z or ||Y-Z).
  33 - \b Distance between the opposite extremities of the boundary box of
  34 selected objects, if it is set to 0.5 the boundary box is split in two halves.
  35 - \b Rotation (in angle degrees) <b>around X</b> (Y to Z) and <b>around
  36 Y</b> (X to Z) (depending on the chosen Orientation)
  37
  38 The parameters of cross-section:
  39
  40 List of <b>meshes, sub-meshes and groups</b> to which the cross-section will be applied.
  41
  42 <b>Select all</b> button allows to select and deselect all available
  43 objects at once.
  44
  45 If the <b>Show preview</b> button is on, you can see the clipping plane
  46 in the <b>3D Viewer</b>.
  47
  48 \image html before_clipping.png "The plane and the cut object"
  49
  50 Also there the possibility to interact directly with the clipping plane in 3D
  51 view with mouse. User can change the parameters of clipping plane by dialog data
  52 or by hand.
  53
  54 \image html before_clipping_preview.png "The preview plane and the cut object"
  55
  56 If the <b>Auto Apply</b> button is on, you can preview the
  57 cross-section in the <b>3D Viewer</b>.
  58
  59 Also, it is possible to specify the type of clipping: using dataset,
  60 i.e. it only changes the visibility of separate mesh cells or alternative
  61 clipping - an OpenGL native one, which clips overall presentation.
  62 For choosing use <b>OpenGL clipping</b> checkbox.
  63
  64 \image html dataset_clipping.png "The cross-section using dataset"
  65
  66
  67 \image html opengl_clipping.png "The OpenGL cross-section"
  68
  69 To get a new object from \b Clipping, click \b Apply.
  70
  71 */