QueryNodeInfo

class cee.ug.QueryNodeInfo()

Query information about nodes for a given frame or all frames

Constructors

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

Parameters

Returns: QueryNodeInfo

Accessors

cee.ug.QueryNodeInfo.maxResultCount()
get maxResultCount(): number

Maximum number of nodes to be returned in the query. Defaults to 1000.

Returns: number

set maxResultCount(max: number): void

Parameters

max: number

Returns: void

Methods

cee.ug.QueryNodeInfo.executeQueryByIds()
executeQueryByIds(frameIndex: number, geometryIndex: number, partId: number, nodeIdArr: number[], callback: QueryNodeInfoCallback): void

Executes the query for the given node ids

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 for the node ids.

partId: number

The id of the part containing the nodes. Specify -1 to search in all parts for the node ids.

nodeIdArr: number[]

Array with ids of the nodes to get information for

callback: QueryNodeInfoCallback

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

Returns: void

cee.ug.QueryNodeInfo.executeQueryByRegion()
executeQueryByRegion(frameIndex: number, geometryIndex: number, partId: number, view: View, x: number, y: number, width: number, height: number, callback: QueryNodeInfoCallback): void

Executes the query for the given region.

The x and y coordinates must be specified in OpenGL style coordinates, which means a right handed coordinate system with the origin in the lower left corner of the window. The HTML coordinate system is with origin in top left, so if this is your input (e.g. MouseEvent.offsetY, clientY, pageY, etc.) you will have to flip the Y coordinate. The x and y are specified in native pixels, so you will have to adjust the input for the current devicePixelRatio (window.devicePixelRatio).

The width and height are specified in native pixels. So you will have to adjust the input for the current devicePixelRatio (window.devicePixelRatio).

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 nodes. Specify -1 to search in all parts.

view: View

The view which the given region applies to.

x: number

The search region’s x coordinate.

y: number

The search region’s y coordinate.

width: number

The search region’s width.

height: number

The search region’s height.

callback: QueryNodeInfoCallback

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

Returns: void