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

   1 /*!
   2
   3 \page clipping_page Clipping
   4
   5 \b Clipping allows creating cross-section views (clipping planes)
   6 of your mesh.
   7
   8 It is available as a sub-item in the context menu of an active mesh.
   9
  10 To create a clipping plane, click on the \b New button in the dialog and choose how it is  defined: by \b Absolute or \b Relative coordinates.
  11
  12 <b>Absolute Coordinates</b>
  13
  14 \image html Clipping_Absolute.png
  15
  16 - <b>Base point</b> - allows defining the coordinates of the base
  17   point for the clipping plane.
  18
  19   - <b>Reset</b> - returns the base point to coordinate origin.
  20
  21 - <b>Direction</b> - allows defining the orientation of the
  22   clipping plane.
  23
  24         - <b>Invert</b> - allows selecting, which part of the object will be
  25     removed and which will remain after clipping.
  26
  27 <b>Relative mode</b>
  28
  29 \image html Clipping_Relative.png
  30
  31 - \b Orientation ( ||X-Y, ||X-Z or ||Y-Z).
  32
  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
  36 - \b Rotation (in angle degrees) <b>around X</b> (Y to Z) and <b>around
  37 Y</b> (X to Z) (depending on the chosen Orientation)
  38
  39 \image html before_clipping_preview.png "The preview plane and the cut object"
  40
  41 The other parameters are available in both modes :
  42
  43 - <b>OpenGL clipping</b> check-box allows choosing OpenGL native clipping, which clips the whole presentation. If it is unchecked, the clipping is done on the dataset i.e. only the visibility of separate mesh cells is changed (see the examples).
  44 - The List contains <b>Meshes, sub-meshes and groups</b> to which the cross-section will be applied.
  45 - <b>Select all</b> check-box allows to selecting and deselecting all available objects at once.
  46 - <b>Show preview</b> check-box shows the clipping plane in the <b>3D Viewer</b>.
  47 - <b>Auto Apply</b> check-box shows button is on, you can preview the
  48 cross-section in the <b>3D Viewer</b>.
  49
  50 It is also possible to interact  with the clipping plane directly in 3D
  51 view using the mouse.
  52
  53 To get a new object from \b Clipping, click \b Apply.
  54
  55 <b>Examples:</b>
  56
  57 \image html dataset_clipping.png "The cross-section using dataset"
  58
  59 \image html opengl_clipping.png "The OpenGL cross-section"
  60
  61
  62 */