Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryElementInfo

Query information about elements for a given frame or all frames

Hierarchy

Index

Constructors

constructor

Accessors

elementIdentType

elementIdentType: RemoteQueryInputIdentType

Specify whether the [[elementIdentArr]] parameter in executeQuery is to be interpreted as an array of IDs or indices. Defaults to IDs.

Methods

executeQuery

  • executeQuery(frameIndex: number, geometryIndex: number, partId: number, elementIdentArr: number[], scalarResultId: number, vectorResultId: number, callback: QueryElementInfoCallback): void
  • Executes the query for the given elements.

    Parameters

    • frameIndex: number

      The index of the frame to get info for. Specify -1 for all frames

    • geometryIndex: number

      The index of the geometry the part belongs to. In most cases there is only one geometry and this parameter should be 0. Specify -1 to search in all geometries.

    • partId: number

      The id of the part containing the elements. Specify -1 to search in all parts.

    • elementIdentArr: number[]

      Array with ids or indices of the elements to get information for. Use elementIdentType to specify what this array contains.

    • scalarResultId: number

      The id of the scalar to use for scalarResult. If -1 then the result currently shown as scalar fringes on the part will be used.

    • vectorResultId: number

      The id of the vector to use for vectorResults. If -1 then the vector results currently set in the modelSpec will be used.

    • callback: QueryElementInfoCallback

      Function getting called when the result is received from the server.

    Returns void

executeQueryByClientSideHitItems

  • Executes the query for the given ClientSideHitItem array.

    Parameters

    • hitItems: ClientSideHitItem[]

      The client-side hit items to execute the query over. Use RemoteModel.clientSideRayIntersect or RemoteModelTrianglePicker to create client-side hit items.

    • scalarResultId: number

      The id of the scalar to use for scalarResult. If -1 then the result currently shown as scalar fringes on the part will be used.

    • vectorResultId: number

      The id of the vector to use for vectorResults. If -1 then the vector results currently set in the modelSpec will be used.

    • callback: QueryElementInfoCallback

      Function getting called when the result is received from the server.

    Returns void

Generated using TypeDoc