.. _cutting-plane-page:

##############
Cutting Planes 
##############

Cutting planes are slices through the structure onto which scalar and vector fields can be 
visualized. By dynamically changing the position and orientation of the cutting plane, you can 
quickly analyze the results inside the system.

Cutting planes are available for unstructured grid models.

.. image:: ../../images/cuttingplane.png
    :align: right
    :height: 400

Any number of cutting planes can be defined and displayed, and various display attributes can 
be set separately for each one. Cutting planes are defined one at a time, specifying which 
position and normal to use for defining the plane.

Several cutting plane display attributes are available, for instance: 

-   **Cutting plane point** |br|
    Point in the cutting plane. Along with a normal, this defines a cutting plane.
-   **Cutting plane normal** |br|
    Normal to the cutting plane. Along with a position, this defines a cutting plane.
-   **Visibility** |br|
    Specify if the cutting plane should be drawn or not.
-   **Mapped scalar** |br|
    Scalar result to be shown mapped as fringes on the cutting plane surface.
-   **Mapped vector** |br|
    Vector result to be shown mapped on the cutting plane. The vectors will be positioned in a 
    regular grid
-   **Clipping** |br|
    Cutting planes can also be used to clip the model in the same plane as the cutting plane.
    Only the part of the model on the correct side of the cutting planes will be visible. Vectors and the 
    cutting plane itself are clipped accordingly.

See the class documentation (:class:`CuttingPlane <cee::ug::CuttingPlane>`) for a full list of display attributes.

Cutting planes are created and accessed from :class:`UnstructGridModel <cee::ug::UnstructGridModel>`.

********
Tutorial
********

.. |img_cp| image:: ../../images/tut_cuttingplane.png
   :width: 150
   :target: ../../tutorials/cutting-plane.html

+-----------------------+------------------------------------------------------------------------------------+
| |img_cp|              | :ref:`cutting-plane-tutorial`     |br|                                             |
|                       | Shows how to create a cutting plane and show a scalar result mapped as |br|        |
|                       | fringes to the surface.                                                            |
+-----------------------+------------------------------------------------------------------------------------+


.. seealso::

    -   :class:`UnstructGridModel <cee::ug::UnstructGridModel>`
    -   :class:`CuttingPlane <cee::ug::CuttingPlane>`
