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

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