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

geSelectArea

geSelectArea( 
[ w_windowId ] 
[ l_points ] 
[ t_areaShapeType ] 
)
=> t / nil 

Description

Adds the objects within the area defined by t_areaShapeType to the selection.

You can use the left mouse button to select the area in enclosed mode and the middle mouse button to select the area in enclosed and crossed mode.

Arguments

w_windowId

Window ID of the window containing the objects. If not specified, the current window is used.

l_points

List of points that define the area for selection.

t_areaShapeType

The shape of the area to use for selection.
Valid Values: rectangle, polygon.
The default shape is rectangle.

Value Returned

t

The objects within the specified area are added to the selection.

nil

The objects within the specified area are not added to the selection.

Examples

Adds the objects within the specified polygon to the selection.

geSelectArea(hiGetCurrentWindow() list(list(0 0) list(100 100) list(0 100)) "polygon")

Interactive Function

geSelectArea( 
[ w_windowId ] 
[ l_points ] 
[ g_areaShapeType ] 
) 
=> t / nil 

Enter this function with only the window ID argument; the system prompts you to point to the area to select and returns t. Press Shift and draw a box to add objects to the selected set. Press Ctrl and draw a box to remove objects from the selected set. If w_windowId is not specified, the current window is used.

When the system prompts you to select the area, you can press F3 to display the Select Area Shape Type form to select a polygon.

Related Topics

Select Area Shape Type Form

Selection Functions


Return to top
 ⠀
X