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

.. js:class:: CuttingPlane

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~CuttingPlane.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~CuttingPlane.color`
   * :js:data:`~CuttingPlane.instanceNodeId`
   * :js:data:`~CuttingPlane.lineColor`
   * :js:data:`~CuttingPlane.matrix`
   * :js:data:`~CuttingPlane.meshId`
   * :js:data:`~CuttingPlane.opacity`
   * :js:data:`~CuttingPlane.plane`
   * :js:data:`~CuttingPlane.referenceGeometry`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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
============

.. js:method:: CuttingPlane.constructor

   .. rst-class:: sig-pretty-signature
   
      | CuttingPlane(): :js:class:`~CuttingPlane`
   
   **Returns**\ : :js:class:`~CuttingPlane`
   





Properties
==========

.. js:data:: CuttingPlane.color

   .. rst-class:: sig-pretty-signature
   
      | color: :js:class:`~Color`
   



.. js:data:: CuttingPlane.instanceNodeId

   .. rst-class:: sig-pretty-signature
   
      | instanceNodeId: (*None* \| *number*\ )
   



.. js:data:: CuttingPlane.lineColor

   .. rst-class:: sig-pretty-signature
   
      | lineColor: :js:class:`~Color`
   



.. js:data:: CuttingPlane.matrix

   .. rst-class:: sig-pretty-signature
   
      | matrix: :js:class:`~Matrix`
   



.. js:data:: CuttingPlane.meshId

   .. rst-class:: sig-pretty-signature
   
      | meshId: (*None* \| :js:data:`MeshId <Sc.MeshId>`\ )
   



.. js:data:: CuttingPlane.opacity

   .. rst-class:: sig-pretty-signature
   
      | opacity: *number*
   



.. js:data:: CuttingPlane.plane

   .. rst-class:: sig-pretty-signature
   
      | plane: :js:class:`~Plane`
   



.. js:data:: CuttingPlane.referenceGeometry

   .. rst-class:: sig-pretty-signature
   
      | referenceGeometry: (*None* \| :js:class:`~Point3`\ [])
   





Methods
=======

.. js:method:: CuttingPlane.createMeshData

   .. rst-class:: sig-pretty-signature
   
      | createMeshData(): (*None* \| :js:class:`~MeshData`\ )
   
   **Returns**\ : (*None* \| :js:class:`~MeshData`\ )
   



.. js:method:: CuttingPlane.fromJson

   .. rst-class:: sig-pretty-signature
   
      | fromJson(**json**\ : *object*\ ): *void*
   
   **Parameters**
   
      **json**\ : *object*
   
   
   **Returns**\ : *void*
   



.. js:method:: CuttingPlane.getMatrix

   .. rst-class:: sig-pretty-signature
   
      | getMatrix(): :js:class:`~Matrix`
   
   **Returns**\ : :js:class:`~Matrix`
   



.. js:method:: CuttingPlane.getReferenceGeometry

   .. rst-class:: sig-pretty-signature
   
      | getReferenceGeometry(): (*None* \| :js:class:`~Point3`\ [])
   
   **Returns**\ : (*None* \| :js:class:`~Point3`\ [])
   



.. js:method:: CuttingPlane.setMatrix

   .. rst-class:: sig-pretty-signature
   
      | setMatrix(**matrix**\ : :js:class:`~Matrix`\ ): *void*
   
   **Parameters**
   
      **matrix**\ : :js:class:`~Matrix`
   
   
   **Returns**\ : *void*
   



.. js:method:: CuttingPlane.setReferenceGeometry

   .. rst-class:: sig-pretty-signature
   
      | setReferenceGeometry(**referenceGeometry**\ : (*None* \| :js:class:`~Point3`\ [])): *void*
   
   **Parameters**
   
      **referenceGeometry**\ : (*None* \| :js:class:`~Point3`\ [])
   
   
   **Returns**\ : *void*
   



.. js:method:: CuttingPlane.toJson

   .. rst-class:: sig-pretty-signature
   
      | toJson(): :js:class:`~CuttingPlaneData`
   
   Creates an object ready for JSON serialization.
   
   **Returns**\ : :js:class:`~CuttingPlaneData`
   
      The prepared object.
   
   





