.. role:: ts-api-decorator

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

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: 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.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~cee.ug.QuerySurfacePath.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~cee.ug.QuerySurfacePath.enableSampling`
   * :js:meth:`~cee.ug.QuerySurfacePath.executeQuery`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: QuerySurfacePath.constructor( model)

      :param model: None
      :type model: RemoteModel


      :rtype: QuerySurfacePath



Methods
=======

.. rst-class:: ts-api-section

enableSampling
--------------

.. js:method:: QuerySurfacePath.enableSampling( numSamples)

   :param numSamples: None
   :type numSamples: number


   Enable regular sampling along the path. Default off (0)


   :rtype: void

.. rst-class:: ts-api-section

executeQuery
------------

.. js:method:: QuerySurfacePath.executeQuery( frameIndex, pointType, surfacePathItemArr, callback)

   :param frameIndex: The zero based index of the frame to query the path from
   :type frameIndex: number
   :param pointType: Type of points in the
   :type pointType: SurfacePathPointType
   :param surfacePathItemArr: Array with SurfacePathItem describing the points defining the path
   :type surfacePathItemArr: [SurfacePathItem]
   :param callback: None
   :type callback: QuerySurfacePathCallback


   Gets the surface path between the specified path items.


   :rtype: void

