.. role:: ts-api-decorator

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

.. container:: ts-api-section

   .. js:class:: CuttingPlane



.. container:: api-index-section

   .. rubric:: Constructors

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

   * :js:meth:`~CuttingPlane.constructor`



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~CuttingPlane.color`
   * :js:attr:`~CuttingPlane.instanceNodeId`
   * :js:attr:`~CuttingPlane.lineColor`
   * :js:attr:`~CuttingPlane.matrix`
   * :js:attr:`~CuttingPlane.meshId`
   * :js:attr:`~CuttingPlane.opacity`
   * :js:attr:`~CuttingPlane.plane`
   * :js:attr:`~CuttingPlane.referenceGeometry`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~CuttingPlane.createMeshData`
   * :js:meth:`~CuttingPlane.fromJson`
   * :js:meth:`~CuttingPlane.getMatrix`
   * :js:meth:`~CuttingPlane.getReferenceGeometry`
   * :js:meth:`~CuttingPlane.setMatrix`
   * :js:meth:`~CuttingPlane.setReferenceGeometry`
   * :js:meth:`~CuttingPlane.toJson`





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

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

.. container:: ts-api-section

   .. js:function:: CuttingPlane.constructor()



      :rtype: CuttingPlane



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.color

      :type: Color





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.instanceNodeId

      :type: null | number





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.lineColor

      :type: Color





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.matrix

      :type: Matrix





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.meshId

      :type: null | MeshId





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.opacity

      :type: number





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.plane

      :type: Plane





.. container:: ts-api-section

   .. js:attribute:: CuttingPlane.referenceGeometry

      :type: null | [Point3]





Methods
=======

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

createMeshData
--------------

.. js:method:: CuttingPlane.createMeshData()



   :rtype: null | MeshData

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

fromJson
--------

.. js:method:: CuttingPlane.fromJson( json)

   :param json: None
   :type json: object


   :rtype: void

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

getMatrix
---------

.. js:method:: CuttingPlane.getMatrix()



   :rtype: Matrix

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

getReferenceGeometry
--------------------

.. js:method:: CuttingPlane.getReferenceGeometry()



   :rtype: null | [Point3]

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

setMatrix
---------

.. js:method:: CuttingPlane.setMatrix( matrix)

   :param matrix: None
   :type matrix: Matrix


   :rtype: void

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

setReferenceGeometry
--------------------

.. js:method:: CuttingPlane.setReferenceGeometry( referenceGeometry)

   :param referenceGeometry: None
   :type referenceGeometry: null | [Point3]


   :rtype: void

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

toJson
------

.. js:method:: CuttingPlane.toJson()



   Creates an object ready for JSON serialization.

   :returns: The prepared object.


   :rtype: CuttingPlaneData

