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

.. js:class:: ICuttingSection

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




Methods
=======

.. js:method:: ICuttingSection._getInstanceNodeIds

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



.. js:method:: ICuttingSection.activate

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



.. js:method:: ICuttingSection.addPlane

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



.. js:method:: ICuttingSection.applyPlaneOpacity

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



.. js:method:: ICuttingSection.clear

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



.. js:method:: ICuttingSection.deactivate

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



.. js:method:: ICuttingSection.fromJson

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



.. js:method:: ICuttingSection.getCount

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



.. js:method:: ICuttingSection.getCuttingPlanes

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



.. js:method:: ICuttingSection.getNodeId

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



.. js:method:: ICuttingSection.getPlane

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



.. js:method:: ICuttingSection.getPlaneColor

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



.. js:method:: ICuttingSection.getPlaneIndexByNodeId

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



.. js:method:: ICuttingSection.getPlaneLineColor

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



.. js:method:: ICuttingSection.getPlaneOpacity

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



.. js:method:: ICuttingSection.getReferenceGeometry

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



.. js:method:: ICuttingSection.isActive

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



.. js:method:: ICuttingSection.removePlane

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



.. js:method:: ICuttingSection.resetPlanesOpacity

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



.. js:method:: ICuttingSection.setColor

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



.. js:method:: ICuttingSection.setOpacity

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



.. js:method:: ICuttingSection.setPlane

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



.. js:method:: ICuttingSection.setPlaneColor

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



.. js:method:: ICuttingSection.setPlaneLineColor

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



.. js:method:: ICuttingSection.setPlaneOpacity

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



.. js:method:: ICuttingSection.toJson

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



.. js:method:: ICuttingSection.updatePlane

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





