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 in 3D Viewer.
   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
  11 * **Absolute Coordinates**
  12
  13   .. image:: ../images/Clipping_Absolute.png
  14         :align: center
  15
  16   * **Base point** - allows defining the coordinates of the base point for the clipping plane.
  17      * **Reset** - returns the base point to the coordinate origin.
  18   * **Direction** - allows defining the orientation of the clipping plane.
  19      * **Invert** - allows selecting, which part of the object will be removed and which will remain after clipping.
  20
  21 * **Relative mode**
  22
  23   .. image:: ../images/Clipping_Relative.png
  24         :align: center
  25
  26   * **Orientation** ( ||X-Y, ||X-Z or ||Y-Z).
  27   * **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.
  28   * **Rotation** (in angle degrees) **around X** (Y to Z) and **around Y** (X to Z) (depending on the chosen Orientation)
  29
  30         .. image:: ../images/before_clipping_preview.png
  31                 :align: center
  32
  33         .. centered::
  34            The preview plane and the cut object
  35
  36 The other parameters are available in both modes :
  37
  38 * **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).
  39 * The List contains **Meshes, sub-meshes and groups** to which the cross-section will be applied.
  40 * **Select all** check-box allows to selecting and deselecting all available objects at once.
  41 * **Show preview** check-box shows the clipping plane in the **3D Viewer**.
  42 * **Auto Apply** check-box shows button is on, you can preview the cross-section in the **3D Viewer**.
  43
  44 It is also possible to interact with the clipping plane directly in 3D view using the mouse.
  45
  46 To get an object clipped, click **Apply**.
  47
  48 **Examples:**
  49
  50         .. image:: ../images/dataset_clipping.png
  51                 :align: center
  52
  53         .. centered::
  54            The cross-section using dataset
  55
  56         .. image:: ../images/opengl_clipping.png
  57                 :align: center
  58
  59         .. centered::
  60            The OpenGL cross-section