{"id":14389,"date":"2026-06-17T11:41:02","date_gmt":"2026-06-17T09:41:02","guid":{"rendered":"https:\/\/store.algosyntax.com\/?post_type=documentation&p=14389"},"modified":"2026-06-17T11:45:43","modified_gmt":"2026-06-17T09:45:43","slug":"linegridcanvaspanel-2-3-child-widget-pools","status":"publish","type":"documentation","link":"https:\/\/store.algosyntax.com\/documentation\/linegridcanvaspanel-2-3-child-widget-pools\/","title":{"rendered":"LineGridCanvasPanel 2.3 | Child Widget Pools"},"content":{"rendered":"\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

LineGridCanvasPanel 2.3: The Widget Pool System<\/h1>\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

The pool sytem is exposed through API endpoints. It does not<\/strong> automatically rewrite every child workflow by itself. The base class gives future SpawnInViewWidgets()<\/code> \/ RemoveOutOfViewWidgets()<\/code> implementations a clean way to opt into pooling.<\/p>

With bUseWidgetPool = true<\/code>:<\/p>

AcquireChildWidgetFromPool(Class, DataObject)<\/code> does this:<\/p>

  1. Checks ObjectToSmartChildWidgetMap<\/code> first.<\/li>
  2. If that DataObject<\/code> already has an active widget, returns it.<\/li>
  3. Otherwise checks the pool bucket for the exact widget class.<\/li>
  4. If a pooled widget exists, reuses it.<\/li>
  5. If not, calls CreateWidget<\/code>.<\/li>
  6. Calls SetDataObject(DataObject)<\/code> before registration.<\/li>
  7. Calls the child acquire hook.<\/li>
  8. Calls AddAndRegisterSmartWidget<\/code>.<\/li>
  9. Requests child layout refresh.<\/li><\/ol>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t

    ReleaseChildWidgetToPool(Child)<\/code> does this:<\/p>

    1. Verifies the child is actively registered under its current GetDataObject()<\/code>.<\/li>
    2. Calls DeRegisterSmartChild<\/code>, removing it from the canvas and ObjectToSmartChildWidgetMap<\/code>.<\/li>
    3. Calls the child release hook.<\/li>
    4. Clears the data object with SetDataObject(nullptr)<\/code>.<\/li>
    5. Stores it in the exact class bucket only if that bucket is below its max.<\/li>
    6. If the bucket is full, the widget is dropped and can be garbage collected.<\/li><\/ol>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
      \n\t\t\t\t\t\t\t\t\t

      With bUseWidgetPool = false<\/code>:<\/p>

      You can still call the same API, but it behaves like a non-retaining lifecycle.<\/p>

      AcquireChildWidgetFromPool(...)<\/code> still:<\/p>

      • checks the active map first,<\/li>
      • then creates a widget if needed.<\/li><\/ul>

        But it does not<\/strong> reuse inactive pooled widgets.<\/p>

        ReleaseChildWidgetToPool(...)<\/code> still:<\/p>

        • deregisters safely,<\/li>
        • clears the data object,<\/li>
        • calls the child release hook,<\/li><\/ul>

          but it does not<\/strong> store the widget for reuse.<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t

          \n\t\t\t\t\t\t\t\t\t

          So if someone does not want pooling, they can either:<\/p>

          • set bUseWidgetPool = false<\/code> and still use the same acquire\/release API, or<\/li>
          • ignore the pool API completely and use CreateWidget<\/code>, AddAndRegisterSmartWidget<\/code>, and DeRegisterSmartChild<\/code> manually.<\/li><\/ul>

            The intended pooled virtualization pattern is:<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t

            \n\t\t\t\t\t\t\t
            \n\t\t\t
            \n\t\t\t\t\n\t\t\t\t\tRemoveOutOfViewWidgets(...)\r\n{\r\n    \/\/ For active children no longer in view:\r\n    ReleaseChildWidgetToPool(Child);\r\n}\r\n\r\nSpawnInViewWidgets(...)\r\n{\r\n    \/\/ For data objects now in view:\r\n    if (!GetActiveLineGridChildWidgetForDataObject(DataObject))\r\n    {\r\n        Child = AcquireChildWidgetFromPool(WidgetClass, DataObject);\r\n        \/\/ configure logical spans \/ visuals\r\n    }\r\n}<\/xmp>\n\t\t\t\t<\/code>\n\t\t\t<\/pre>\n\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t","protected":false},"featured_media":0,"template":"elementor_header_footer","categories":[132,129],"tags":[133,136],"class_list":["post-14389","documentation","type-documentation","status-publish","hentry","category-enhanced-ui","category-unreal-engine","tag-user-interface","tag-userinterface","entry"],"acf":[],"_links":{"self":[{"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/documentation\/14389","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/documentation"}],"about":[{"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/types\/documentation"}],"version-history":[{"count":2,"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/documentation\/14389\/revisions"}],"predecessor-version":[{"id":14394,"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/documentation\/14389\/revisions\/14394"}],"wp:attachment":[{"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/media?parent=14389"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/categories?post=14389"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/store.algosyntax.com\/asx-rest\/wp\/v2\/tags?post=14389"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}