.. role:: ts-api-decorator

############
CuttingPlane
############

.. js:module:: cee.cug
   :noindex:

.. container:: ts-api-section

   .. js:class:: CuttingPlane



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~cee.cug.CuttingPlane.highlight`
   * :js:attr:`~cee.cug.CuttingPlane.mapContourLinesResultId`
   * :js:attr:`~cee.cug.CuttingPlane.mapScalarResultId`
   * :js:attr:`~cee.cug.CuttingPlane.mapVectorResultId`
   * :js:attr:`~cee.cug.CuttingPlane.visible`





------------

Accessors
=========

.. container:: ts-api-section

   .. js:function:: CuttingPlane.highlight()



      Whether the cutting plane should be highlighted.


      :rtype: boolean

   .. js:function:: CuttingPlane.highlight( highlight)

      :param highlight: None
      :type highlight: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: CuttingPlane.mapContourLinesResultId()



      The result id of the scalar result shown as contour lines on the cutting plane. 

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: CuttingPlane.mapScalarResultId()



      The result id of the scalar result mapped on the cutting plane. 

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: CuttingPlane.mapVectorResultId()



      The result id of the vector result mapped on the cutting plane. 

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: CuttingPlane.visible()



      :rtype: boolean

   .. js:function:: CuttingPlane.visible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



