Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

gePointToFig

gePointToFig( 
[ w_windowId ] 
[ g_ignoreSelect ] 
[ l_list ] 
)
=> d_figure / nil 

Description

Returns the ID of the object located at the coordinates given in l_list.

This function is like geSingleSelectPoint, except the object indicated is returned rather than added to the selection. If no figure satisfies the selection criteria, nil is returned. If set, the Boolean g_ignoreSelect tells the function to ignore whether objects are currently selected when searching the database.

Arguments

w_windowId

Database ID of the window containing the objects.

g_ignoreSelect

Specifies whether to ignore objects currently selected when searching for the object.
Valid Values: t, nil

l_list

List of X and Y coordinates in user units to specify locations to look for objects.

Value Returned

d_figure

Database ID of the first object satisfying the selection criteria.

nil

No objects satisfy the selection criteria.

Examples

Returns the object IDs of the objects located at the given coordinates.

gePointToFig( win2 list(0:0 10:10) )

Related Topics

Selection Functions

geSingleSelectPoint


Return to top
 ⠀
X