Index: 09_appendix/action_details.html =================================================================== --- 09_appendix/action_details.html (revision 9168) +++ 09_appendix/action_details.html (revision 9169) @@ -24,6 +24,25 @@

If you have unsaved changes, you will be prompted to confirm (or save) before quitting. + +

RtreeList

+
+

+ +
Syntax summary: +RtreeList[rtree_name, [x1, y1, x2, y2]) +
Help text: +Return a list of idpaths for objects overlapping with the box specified (empty list if no object is found). Error is indicated by returning nil. If coordinates are not specified the whole tree is searched. +
Registered by: +act_read +
+

+Search all objects of the selected layer's named rtree on the current sheet and return a list of idpaths. +

+ The first argument is a layer name with an optional suffix. A layer name is the same as layer names printed by the GUI, e.g. "wire" or "hub & terminal". Suffix may be "-stroke" or "-fill"; when no suffix is appended, "-stroke" is assumed. All normal objects are in the stroke rtree; polygons with fill enabled are also in the fill rtree. +

+ If coordinates of a box is give, smaller coords first, the search is performed only within that box and any object that has overlapping bounding box (on the given layer) is returned. Otherwise the search is performed on the whole rtree, returning all objects on the layer. +

librnd actions (common to Ringdove)

@@ -201,13 +220,19 @@ -board +design The values are percentages of the board size. Thus, a move of 50,50 - moves you halfway across the board. + moves you halfway across the board. + + + +board + + Same as design (for backward compatibility) Index: 09_appendix/action_src/rtreelist.html =================================================================== --- 09_appendix/action_src/rtreelist.html (nonexistent) +++ 09_appendix/action_src/rtreelist.html (revision 9169) @@ -0,0 +1,13 @@ +Search all objects of the selected layer's named rtree on the current sheet +and return a list of idpaths. +

+The first argument is a layer name with an optional suffix. A layer name +is the same as layer names printed by the GUI, e.g. "wire" or +"hub & terminal". Suffix may be "-stroke" or "-fill"; when no +suffix is appended, "-stroke" is assumed. All normal objects are in +the stroke rtree; polygons with fill enabled are also in the fill rtree. +

+If coordinates of a box is give, smaller coords first, the search +is performed only within that box and any object that has overlapping +bounding box (on the given layer) is returned. Otherwise the search +is performed on the whole rtree, returning all objects on the layer.