
################
QuerySurfacePath
################

.. js:class:: cee.ug.QuerySurfacePath

   Query to get the path on the surface between the given points optionally with a sampled scalar result
   
   SurfacePathQuery will also produce a surface path for points on a cutting plane. All points need to be one the same cutting plane.
   
   Mixing hits on parts AND cutting plane in the same query is not supported.
   
   This is useful for creating length plot of a scalar vs. length on the surface of the model.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ug.QuerySurfacePath.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.ug.QuerySurfacePath.enableSampling`
   * :js:meth:`~cee.ug.QuerySurfacePath.executeQuery`
   
   



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

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


.. js:method:: cee.ug.QuerySurfacePath.constructor

      .. rst-class:: sig-pretty-signature
      
         | QuerySurfacePath(**model**\ : :js:class:`RemoteModel <cee.ug.RemoteModel>`\ ): :js:class:`QuerySurfacePath <cee.ug.QuerySurfacePath>`
      
      **Parameters**
      
      
         **model**\ : :js:class:`RemoteModel <cee.ug.RemoteModel>`
      
      
      **Returns**\ : :js:class:`QuerySurfacePath <cee.ug.QuerySurfacePath>`
      



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

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


.. js:method:: cee.ug.QuerySurfacePath.enableSampling

      .. rst-class:: sig-pretty-signature
      
         | enableSampling(**numSamples**\ : *number*\ ?): *void*
      
      Enable regular sampling along the path. Default off (0)
      
      **Parameters**
      
      
         **numSamples**\ : *number* = 100
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.QuerySurfacePath.executeQuery

      .. rst-class:: sig-pretty-signature
      
         | executeQuery(**frameIndex**\ : *number*\ , **pointType**\ : :js:data:`SurfacePathPointType <cee.ug.SurfacePathPointType>`\ , **surfacePathItemArr**\ : :js:class:`SurfacePathItem <cee.ug.SurfacePathItem>`\ [], **callback**\ : :js:class:`QuerySurfacePathCallback <cee.ug.QuerySurfacePathCallback>`\ ): *void*
      
      Gets the surface path between the specified path items.
      
      **Parameters**
      
      
         **frameIndex**\ : *number*
      
      
            The zero based index of the frame to query the path from
      
      
         **pointType**\ : :js:data:`SurfacePathPointType <cee.ug.SurfacePathPointType>`
      
      
            Type of points in the
      
      
         **surfacePathItemArr**\ : :js:class:`SurfacePathItem <cee.ug.SurfacePathItem>`\ []
      
      
            Array with SurfacePathItem describing the points defining the path
      
      
         **callback**\ : :js:class:`QuerySurfacePathCallback <cee.ug.QuerySurfacePathCallback>`
      
      
      **Returns**\ : *void*
      




