.. role:: ts-api-decorator

####################
CuttingPlaneOperator
####################

.. js:module:: Operators
   :noindex:

.. container:: ts-api-section

   .. js:class:: CuttingPlaneOperator



.. container:: api-index-section

   .. rubric:: Constructors

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

   * :js:meth:`~Operators.CuttingPlaneOperator.constructor`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Operators.CuttingPlaneOperator.addMapping`
   * :js:meth:`~Operators.CuttingPlaneOperator.clearMapping`
   * :js:meth:`~Operators.CuttingPlaneOperator.setMapping`





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

Constructors
============

.. container:: ts-api-section

   .. js:function:: CuttingPlaneOperator.constructor( viewer, view, cuttingManager)

      :param viewer: None
      :type viewer: WebViewer
      :param view: None
      :type view: View
      :param cuttingManager: None
      :type cuttingManager: CuttingManager


      :rtype: CuttingPlaneOperator



Methods
=======

.. rst-class:: ts-api-section

addMapping
----------

.. js:method:: CuttingPlaneOperator.addMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid.
   All mappings require a mouse button, but a key modifier is optional.


   :rtype: void

.. rst-class:: ts-api-section

clearMapping
------------

.. js:method:: CuttingPlaneOperator.clearMapping()



   Clears any button and key modifier mappings for the operator.


   :rtype: void

.. rst-class:: ts-api-section

setMapping
----------

.. js:method:: CuttingPlaneOperator.setMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Sets the button and key modifier mapping for the operator.


   :rtype: void

