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

.. js:class:: cee.cug.CuttingPlane

   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.cug.CuttingPlane.highlight`
   * :js:func:`~cee.cug.CuttingPlane.mapContourLinesResultId`
   * :js:func:`~cee.cug.CuttingPlane.mapScalarResultId`
   * :js:func:`~cee.cug.CuttingPlane.mapVectorResultId`
   * :js:func:`~cee.cug.CuttingPlane.visible`
   
   



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


.. js:method:: cee.cug.CuttingPlane.highlight

      .. rst-class:: sig-pretty-signature
      
         | *get* highlight(): *boolean*
      
      Whether the cutting plane should be highlighted.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* highlight(**highlight**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **highlight**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.cug.CuttingPlane.mapContourLinesResultId

      .. rst-class:: sig-pretty-signature
      
         | *get* mapContourLinesResultId(): *number*
      
      The result id of the scalar result shown as contour lines on the cutting plane.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.CuttingPlane.mapScalarResultId

      .. rst-class:: sig-pretty-signature
      
         | *get* mapScalarResultId(): *number*
      
      The result id of the scalar result mapped on the cutting plane.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.CuttingPlane.mapVectorResultId

      .. rst-class:: sig-pretty-signature
      
         | *get* mapVectorResultId(): *number*
      
      The result id of the vector result mapped on the cutting plane.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.CuttingPlane.visible

      .. rst-class:: sig-pretty-signature
      
         | *get* visible(): *boolean*
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* visible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      




