::hwp::getClosestNode
Finds the closest node for the specified point coordinates.
Syntax
::hwp::getClosestNode
Application
Tcl Query
Description
This procedure implements minus options.
Mandatory Arguments
- -xPos "x coordinate"
- The x coordinate.
- -yPos "y coordinate"
- The y coordinate.
- -zPos "z coordinate"
- The z coordinate.
Optional Arguments
- -componentId "component id"
- The component ID.
- -displayMode "all / displayed"
- The display mode of the node to be searched (all or only displayed). Default is "displayed".
- -radius "real number"
- The sphere radius that is used to search the closest node (default = 10).
Returns
The node ID of the closest node to this position.
Examples
set noteId [::hwp::getClosestNode -xPos -750 -yPos 400 -zPos 220]
set noteId [::hwp::getClosestNode -xPos -750 -yPos 400 -zPos 220 -componentId 2000591 -displayMode displayed -radius 100]