QuerySurfaceGroup

class cee.ug.QuerySurfaceGroup()

Query for retrieving triangulated geometry of surface groups.

Each surface group is a collection of element faces that originate from the same surface. The main source of surface groups is CAD files (e.g. HOOPS Exchange plugin), so they are sometimes referred to as CAD surface groups. Use this query to obtain the surface group IDs present in the model, and to obtain an indexed triangle mesh (vertices + triangle indices) for the surface group with a given surface group ID.

Constructors

cee.ug.QuerySurfaceGroup.constructor()
QuerySurfaceGroup(model: RemoteModel): QuerySurfaceGroup

Parameters

Returns: QuerySurfaceGroup

Methods

cee.ug.QuerySurfaceGroup.executeAvailableSurfaceGroupIdsQuery()
executeAvailableSurfaceGroupIdsQuery(frameIndex: number, callback: QuerySurfaceGroupAvailableSurfaceGroupIdsCallback): void

Executes a query that returns the surface group IDs that are present in the model.

Parameters

Returns: void

cee.ug.QuerySurfaceGroup.executeSurfaceGroupIdForElementQuery()
executeSurfaceGroupIdForElementQuery(frameIndex: number, geometryIndex: number, partId: number, elementIndex: number, elementFaceIndex: number, callback: QuerySurfaceGroupIdForElementCallback): void

Executes a query that returns the surface group ID of the surface group that a given element face belongs to.

This is typically used together with picking: pass the identifiers from a ug.HitItem to find out which surface group was hit, and then use executeTriangulationQuery to retrieve and visualize the geometry of that group.

The callback receives the surface group ID of the surface group the element face belongs to, or -1 if the element face is not part of any surface group.

Parameters

frameIndex: number

geometryIndex: number

partId: number

elementIndex: number

elementFaceIndex: number

callback: QuerySurfaceGroupIdForElementCallback

Returns: void

cee.ug.QuerySurfaceGroup.executeTriangulationQuery()
executeTriangulationQuery(frameIndex: number, surfaceGroupId: number, callback: QuerySurfaceGroupTriangulationCallback): void

Executes a query that returns the triangulated geometry of the surface group with the given surface group ID.

The result is an indexed triangle mesh (deduplicated vertices + triangle indices). If no surface group with the given surface group ID exists, the callback is invoked with an error.

Vertices are returned in world coordinates using the currently active node positions of the part (i.e. including displacements when applicable). Vertices are deduplicated, so each shared mesh node appears only once in the output vertices array, and triangles reference vertices via the indices in triangleIndices (three indices per triangle).

Parameters

frameIndex: number

surfaceGroupId: number

callback: QuerySurfaceGroupTriangulationCallback

Returns: void