QueryNodeInfo

class cee.ug.QueryNodeInfo(): Query information about nodes for a given frame or all frames

Constructors

constructor

Accessors

maxResultCount

Methods

executeQuery
executeQueryByIds
executeQueryByRegion

Constructors

constructor

cee.ug.QueryNodeInfo.constructor(model)

Arguments

model (cee.ug.RemoteModel) –

Return type

cee.ug.QueryNodeInfo

Accessors

cee.ug.QueryNodeInfo.maxResultCount: Maximum number of nodes to be returned in the query. Defaults to 1000.

Methods

executeQuery

cee.ug.QueryNodeInfo.executeQuery(frameIndex, geometryIndex, partId, nodeIdArr, callback)

Note

executeQuery is deprecated: This method is deprecated and will be removed in a future version. Use QueryNodeInfo.executeQueryByIds instead.

Arguments

frameIndex (number) –
geometryIndex (number) –
partId (number) –
nodeIdArr ([number]) –
callback (cee.ug.QueryNodeInfoCallback) –

Return type

void

executeQueryByIds

cee.ug.QueryNodeInfo.executeQueryByIds(frameIndex, geometryIndex, partId, nodeIdArr, callback)

Executes the query for the given node ids

Arguments

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 (cee.ug.QueryNodeInfoCallback) – Function getting called when the result is received from the server.

Return type

void

executeQueryByRegion

cee.ug.QueryNodeInfo.executeQueryByRegion(frameIndex, geometryIndex, partId, view, x, y, width, height, callback)

Executes the query for the given region.

Arguments

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 (cee.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 (cee.ug.QueryNodeInfoCallback) – Function getting called when the result is received from the server.

Return type

void

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).