Queries a point to the closest of a list of one or more objects, and returns the deviation and object queried to.
Input Arguments
0 |
Point Name |
Point Name |
The name of the point to query. |
1 |
Collection Object Name Ref List |
Objects |
The list of objects to query to. |
2 |
Boolean |
Ignore Target Offset |
Indicates whether offsets should be ignored (zero) or if the stored offsets should be used. |
Return Arguments
3 |
Double |
dX |
The x-component of the deviation between the point and object. |
4 |
Double |
dY |
The y-component of the deviation between the point and object. |
5 |
Double |
dZ |
The z-component of the deviation between the point and object. |
6 |
Double |
dMag |
The (signed) magnitude of the deviation between the point and object. |
7 |
Collection Object Name |
Resultant Object |
The object to which the point was ultimately queried. |
Returned Status
SUCCESS |
The query was performed successfully. |
FAILURE |
The point was not found, or none of the objects was found. |
Remarks
This command will return the deviation between the point and the closest object to that point, just as the manual Query commands do.
This command can be used to easily determine the closest object to a specific point in space.