# QuerySurfacePath

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.

Constructors

- `constructor`

Methods

- `enableSampling`
- `executeQuery`

## Constructors

`QuerySurfacePath.``constructor`(model)

  Arguments: | model (`RemoteModel`) – None
  Return type: | QuerySurfacePath

## Methods

### enableSampling

`QuerySurfacePath.``enableSampling`(numSamples)

  Arguments: | numSamples (`number`) – None

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

  Return type: | void

### executeQuery

`QuerySurfacePath.``executeQuery`(frameIndex, pointType, surfacePathItemArr, callback)

  Arguments: | frameIndex (`number`) – The zero based index of the frame to query the path from pointType (`SurfacePathPointType`) – Type of points in the surfacePathItemArr (`[SurfacePathItem]`) – Array with SurfacePathItem describing the points defining the path callback (`QuerySurfacePathCallback`) – None

  Gets the surface path between the specified path items.

  Return type: | void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Web or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...