Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
regional_map [2016/05/02 18:30] hermann |
regional_map [2026/08/28 03:31] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Regional Map ====== | + | ====== Regional Map ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor stores all of the regional maps produced within the [[Region Manager]] container. | + | Registers a map as the piece belonging to one region of a larger map, under a name that [[Merge Regional Maps]] later reads to rebuild the whole map. This functor produces no output — it is used purely for the side effect of storing the map in the region manager. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Global Map Name | [[Name Type]] | Name for the regional maps. | | + | | Global Map Name | [[Name Type]] | Name under which the regional maps are kept by the region manager. Use the same name in the matching [[Merge Regional Maps]]. | |
| - | | Regional Map | [[Map Type]] | Any map passed as input. | | + | | Regional Map | [[Map Type]] | The map for this region. | |
| - | | Region Id | [[Integer Value Type]] | Region identifier.((Since Dinamica EGO 2.0, this input is no longer optional)) | | + | |
| - | | Region Manager | [[Region Manager Type]] | This is internally linked by the [[Region Manager]] container.((Since Dinamica EGO 2.0, this input is no longer optional)) | | + | ===== Optional Inputs ===== |
| + | |||
| + | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| + | | Region Id | [[Integer Value Type]] | Identifier of the region that Regional Map belongs to. When this functor is placed inside a [[For Each Region]] or [[Region]] container, this port connects to the current region automatically. | Provided automatically | | ||
| + | | Region Manager | [[Region Manager Type]] | The region manager to register the map with. When this functor is placed inside a [[Region Manager]] or [[Region]] container, this port connects to that container's region manager automatically. | Provided automatically | | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| Line 21: | Line 25: | ||
| [[Functor List#Region | Region]] | [[Functor List#Region | Region]] | ||
| - | ===== Notes ===== | + | ===== Notes ===== |
| + | |||
| + | Region Id can be set to a fixed constant instead of being left to auto-bind, but doing so triggers a warning recommending that it be supplied by an enclosing loop's current iteration instead. | ||
| + | |||
| + | Registering a map under a Global Map Name that no [[Merge Regional Maps]] reads back is reported with a warning. Registering two maps under the same Global Map Name for the same region manager is also reported with a warning. | ||
| - | This structure stores all regional maps created or modified during the execution of the [[Region Manager]] and its enveloped containers. These maps can be merged afterwards by the [[Merge Regional Maps]] functor. | + | Placing this functor inside a [[For Each Region]] container has no effect, since the region manager that container exposes does not store regional maps. Use a [[Region Manager]] (or [[Region]]) instead. |
| - | ===== Internal Name ===== | + | ===== Internal Name ===== |
| RegionalMap | RegionalMap | ||