Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
get_all_regions_info [2026/01/29 20:24]
admin created 		get_all_regions_info [2026/08/28 03:20] (current)
hermann Sync from local documentation review
Line 2: Line 2:
  
 ===== Description ===== ===== Description =====
-This functor retrieves information for all regions simultaneously.+ 
 +Returns a table with the boundaries of every region held by a region manager, one row per region.
  
 ===== Inputs ===== ===== Inputs =====
 +
 None. None.
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
 +
 ^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ ^ Name  ^ Type  ^ Description ​ ^ Default Value  ^
-| Region Manager ​ | [[Region Manager Type]] ​ | Manager where the coverage maps of each region ​are maintained. This port automatically associates with the innermost compatible ​container. This port is advanced.  | -  |+| Region Manager ​ | [[Region Manager Type]] ​ | The region ​manager to read. When this functor is placed inside a [[Region Manager]], [[Region]], or [[For Each Region]] container, this port connects to that container's region manager automatically.  | Provided automatically ​ | 
 + 
 +===== Outputs =====
  
-===== Output ===== 
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Regions Info  | [[Table Type]] ​ | Table containing boundary details for all regions. The table has the format "​RegionId:​real, RegionLines:​real, RegionColumns:​real, RegionTopYCoordinate:​real, RegionLeftXCoordinate:​real, RegionBottomYCoordinate:​real, RegionRightXCoordinate:​real",​ representing ​the number of lines, ​number ​of columns, upper boundary in Y, left boundary in X, lower boundary in Y, and right boundary in X.  |+| Regions Info  | [[Table Type]] ​ | Table with one row per region, with the columns Region Id (key), Region Lines, Region Columns, Region Top Y Coordinate, Region Left X Coordinate, Region Bottom Y Coordinate, and Region Right X Coordinate — the number of lines and columns of the region'​s map, and the coordinates ​of its top, left, bottom, and right boundaries.  |
  
 ===== Group ===== ===== Group =====
 +
 [[Functor List#Region | Region]] [[Functor List#Region | Region]]
  
 ===== Notes ===== ===== Notes =====
-Retrieves information for all regions simultaneously.+ 
 +None.
  
 ===== Internal Name ===== ===== Internal Name =====
 +
 GetAllRegionsInfo GetAllRegionsInfo