
###############
ICuttingSection
###############

.. js:class:: wv.ICuttingSection

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.ICuttingSection._getInstanceNodeIds`
   * :js:meth:`~wv.ICuttingSection.activate`
   * :js:meth:`~wv.ICuttingSection.addPlane`
   * :js:meth:`~wv.ICuttingSection.applyPlaneOpacity`
   * :js:meth:`~wv.ICuttingSection.clear`
   * :js:meth:`~wv.ICuttingSection.deactivate`
   * :js:meth:`~wv.ICuttingSection.fromJson`
   * :js:meth:`~wv.ICuttingSection.getCount`
   * :js:meth:`~wv.ICuttingSection.getCuttingPlanes`
   * :js:meth:`~wv.ICuttingSection.getNodeId`
   * :js:meth:`~wv.ICuttingSection.getPlane`
   * :js:meth:`~wv.ICuttingSection.getPlaneColor`
   * :js:meth:`~wv.ICuttingSection.getPlaneIndexByNodeId`
   * :js:meth:`~wv.ICuttingSection.getPlaneLineColor`
   * :js:meth:`~wv.ICuttingSection.getPlaneOpacity`
   * :js:meth:`~wv.ICuttingSection.getReferenceGeometry`
   * :js:meth:`~wv.ICuttingSection.isActive`
   * :js:meth:`~wv.ICuttingSection.removePlane`
   * :js:meth:`~wv.ICuttingSection.resetPlanesOpacity`
   * :js:meth:`~wv.ICuttingSection.setColor`
   * :js:meth:`~wv.ICuttingSection.setOpacity`
   * :js:meth:`~wv.ICuttingSection.setPlane`
   * :js:meth:`~wv.ICuttingSection.setPlaneColor`
   * :js:meth:`~wv.ICuttingSection.setPlaneLineColor`
   * :js:meth:`~wv.ICuttingSection.setPlaneOpacity`
   * :js:meth:`~wv.ICuttingSection.toJson`
   * :js:meth:`~wv.ICuttingSection.updatePlane`
   
   



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

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


.. js:method:: wv.ICuttingSection._getInstanceNodeIds

      .. rst-class:: sig-pretty-signature
      
         | _getInstanceNodeIds(): *number*\ []
      
      **Returns**\ : *number*\ []
      



.. js:method:: wv.ICuttingSection.activate

      .. rst-class:: sig-pretty-signature
      
         | activate(): *Promise*
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.addPlane

      .. rst-class:: sig-pretty-signature
      
         | addPlane(**plane**\ : :js:class:`Plane <wv.Plane>`\ , **referenceGeometry**\ : (*None* | :js:class:`Point3 <wv.Point3>`\ []), **options**\ : { color: :js:class:`IColor <wv.IColor>`\ , lineColor: :js:class:`IColor <wv.IColor>`\ , opacity: *number* }): *Promise*
      
      **Parameters**
      
      
         **plane**\ : :js:class:`Plane <wv.Plane>`
      
         **referenceGeometry**\ : (*None* \| :js:class:`Point3 <wv.Point3>`\ [])
      
         **options**\ : { color: :js:class:`IColor <wv.IColor>`\ , lineColor: :js:class:`IColor <wv.IColor>`\ , opacity: *number* }
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.applyPlaneOpacity

      .. rst-class:: sig-pretty-signature
      
         | applyPlaneOpacity(**index**\ : *number*\ , **opacity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **index**\ : *number*
      
         **opacity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.ICuttingSection.clear

      .. rst-class:: sig-pretty-signature
      
         | clear(): *Promise*
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.deactivate

      .. rst-class:: sig-pretty-signature
      
         | deactivate(): *Promise*
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.fromJson

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



.. js:method:: wv.ICuttingSection.getCount

      .. rst-class:: sig-pretty-signature
      
         | getCount(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wv.ICuttingSection.getCuttingPlanes

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



.. js:method:: wv.ICuttingSection.getNodeId

      .. rst-class:: sig-pretty-signature
      
         | getNodeId(**index**\ : *number*\ ): (*None* | *number*\ )
      
      **Parameters**
      
      
         **index**\ : *number*
      
      
      **Returns**\ : (*None* \| *number*\ )
      



.. js:method:: wv.ICuttingSection.getPlane

      .. rst-class:: sig-pretty-signature
      
         | getPlane(**index**\ : *number*\ ): (*None* | :js:class:`Plane <wv.Plane>`\ )
      
      **Parameters**
      
      
         **index**\ : *number*
      
      
      **Returns**\ : (*None* \| :js:class:`Plane <wv.Plane>`\ )
      



.. js:method:: wv.ICuttingSection.getPlaneColor

      .. rst-class:: sig-pretty-signature
      
         | getPlaneColor(**index**\ : *number*\ ): (*undefined* | :js:class:`Color <wv.Color>`\ )
      
      **Parameters**
      
      
         **index**\ : *number*
      
      
      **Returns**\ : (*undefined* \| :js:class:`Color <wv.Color>`\ )
      



.. js:method:: wv.ICuttingSection.getPlaneIndexByNodeId

      .. rst-class:: sig-pretty-signature
      
         | getPlaneIndexByNodeId(**id**\ : *number*\ ): (*None* | *number*\ )
      
      **Parameters**
      
      
         **id**\ : *number*
      
      
      **Returns**\ : (*None* \| *number*\ )
      



.. js:method:: wv.ICuttingSection.getPlaneLineColor

      .. rst-class:: sig-pretty-signature
      
         | getPlaneLineColor(**index**\ : *number*\ ): (*undefined* | :js:class:`Color <wv.Color>`\ )
      
      **Parameters**
      
      
         **index**\ : *number*
      
      
      **Returns**\ : (*undefined* \| :js:class:`Color <wv.Color>`\ )
      



.. js:method:: wv.ICuttingSection.getPlaneOpacity

      .. rst-class:: sig-pretty-signature
      
         | getPlaneOpacity(**index**\ : *number*\ ): (*undefined* | *number*\ )
      
      **Parameters**
      
      
         **index**\ : *number*
      
      
      **Returns**\ : (*undefined* \| *number*\ )
      



.. js:method:: wv.ICuttingSection.getReferenceGeometry

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



.. js:method:: wv.ICuttingSection.isActive

      .. rst-class:: sig-pretty-signature
      
         | isActive(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.ICuttingSection.removePlane

      .. rst-class:: sig-pretty-signature
      
         | removePlane(**index**\ : *number*\ ): *Promise*
      
      **Parameters**
      
      
         **index**\ : *number*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.resetPlanesOpacity

      .. rst-class:: sig-pretty-signature
      
         | resetPlanesOpacity(): *void*
      
      **Returns**\ : *void*
      



.. js:method:: wv.ICuttingSection.setColor

      .. rst-class:: sig-pretty-signature
      
         | setColor(**color**\ : :js:class:`Color <wv.Color>`\ ): *Promise*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color <wv.Color>`
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.setOpacity

      .. rst-class:: sig-pretty-signature
      
         | setOpacity(**opacity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **opacity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.ICuttingSection.setPlane

      .. rst-class:: sig-pretty-signature
      
         | setPlane(**index**\ : *number*\ , **plane**\ : :js:class:`Plane <wv.Plane>`\ , **referenceGeometry**\ : (*None* | :js:class:`Point3 <wv.Point3>`\ []), **options**\ : { color: :js:class:`IColor <wv.IColor>`\ , lineColor: :js:class:`IColor <wv.IColor>`\ , opacity: *number* }): *Promise*
      
      **Parameters**
      
      
         **index**\ : *number*
      
         **plane**\ : :js:class:`Plane <wv.Plane>`
      
         **referenceGeometry**\ : (*None* \| :js:class:`Point3 <wv.Point3>`\ [])
      
         **options**\ : { color: :js:class:`IColor <wv.IColor>`\ , lineColor: :js:class:`IColor <wv.IColor>`\ , opacity: *number* }
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wv.ICuttingSection.setPlaneColor

      .. rst-class:: sig-pretty-signature
      
         | setPlaneColor(**index**\ : *number*\ , **color**\ : :js:class:`Color <wv.Color>`\ ): *void*
      
      **Parameters**
      
      
         **index**\ : *number*
      
         **color**\ : :js:class:`Color <wv.Color>`
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.ICuttingSection.setPlaneLineColor

      .. rst-class:: sig-pretty-signature
      
         | setPlaneLineColor(**index**\ : *number*\ , **color**\ : :js:class:`Color <wv.Color>`\ ): *void*
      
      **Parameters**
      
      
         **index**\ : *number*
      
         **color**\ : :js:class:`Color <wv.Color>`
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.ICuttingSection.setPlaneOpacity

      .. rst-class:: sig-pretty-signature
      
         | setPlaneOpacity(**index**\ : *number*\ , **opacity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **index**\ : *number*
      
         **opacity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.ICuttingSection.toJson

      .. rst-class:: sig-pretty-signature
      
         | toJson(): *object*
      
      **Returns**\ : *object*
      



.. js:method:: wv.ICuttingSection.updatePlane

      .. rst-class:: sig-pretty-signature
      
         | updatePlane(**index**\ : *number*\ , **plane**\ : :js:class:`Plane <wv.Plane>`\ , **geometryMatrix**\ : :js:class:`Matrix <wv.Matrix>`\ , **finalizePosition**\ : *boolean*\ , **resetTranslation**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **index**\ : *number*
      
         **plane**\ : :js:class:`Plane <wv.Plane>`
      
         **geometryMatrix**\ : :js:class:`Matrix <wv.Matrix>`
      
         **finalizePosition**\ : *boolean*
      
         **resetTranslation**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      




