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

.. js:class:: wv.CuttingPlane

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.CuttingPlane.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wv.CuttingPlane.color`
   * :js:data:`~wv.CuttingPlane.instanceNodeId`
   * :js:data:`~wv.CuttingPlane.lineColor`
   * :js:data:`~wv.CuttingPlane.matrix`
   * :js:data:`~wv.CuttingPlane.meshId`
   * :js:data:`~wv.CuttingPlane.opacity`
   * :js:data:`~wv.CuttingPlane.plane`
   * :js:data:`~wv.CuttingPlane.referenceGeometry`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.CuttingPlane.createMeshData`
   * :js:meth:`~wv.CuttingPlane.fromJson`
   * :js:meth:`~wv.CuttingPlane.getMatrix`
   * :js:meth:`~wv.CuttingPlane.getReferenceGeometry`
   * :js:meth:`~wv.CuttingPlane.setMatrix`
   * :js:meth:`~wv.CuttingPlane.setReferenceGeometry`
   * :js:meth:`~wv.CuttingPlane.toJson`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: wv.CuttingPlane.constructor

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



.. rst-class:: kind-group kind-properties

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


.. js:data:: wv.CuttingPlane.color

      .. rst-class:: sig-pretty-signature
      
         | color: :js:class:`Color <wv.Color>`
      



.. js:data:: wv.CuttingPlane.instanceNodeId

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



.. js:data:: wv.CuttingPlane.lineColor

      .. rst-class:: sig-pretty-signature
      
         | lineColor: :js:class:`Color <wv.Color>`
      



.. js:data:: wv.CuttingPlane.matrix

      .. rst-class:: sig-pretty-signature
      
         | matrix: :js:class:`Matrix <wv.Matrix>`
      



.. js:data:: wv.CuttingPlane.meshId

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



.. js:data:: wv.CuttingPlane.opacity

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



.. js:data:: wv.CuttingPlane.plane

      .. rst-class:: sig-pretty-signature
      
         | plane: :js:class:`Plane <wv.Plane>`
      



.. js:data:: wv.CuttingPlane.referenceGeometry

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



.. rst-class:: kind-group kind-methods

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


.. js:method:: wv.CuttingPlane.createMeshData

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



.. js:method:: wv.CuttingPlane.fromJson

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



.. js:method:: wv.CuttingPlane.getMatrix

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



.. js:method:: wv.CuttingPlane.getReferenceGeometry

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



.. js:method:: wv.CuttingPlane.setMatrix

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



.. js:method:: wv.CuttingPlane.setReferenceGeometry

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



.. js:method:: wv.CuttingPlane.toJson

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




