(v5) Improve Layout::ignoreInvisibleChilren usability (#1567)

Made it virtual so it can be used cleanly for layout creation. Also made it return this instead of void and made the ignore param true by default. About time.

Author: Fleeym

loader/include/Geode/ui/Layout.hpp

@@ -38,7 +38,11 @@ class GEODE_DLL Layout : public cocos2d::CCObject {
      */
     virtual cocos2d::CCSize getSizeHint(cocos2d::CCNode* on) const = 0;
 
-    void ignoreInvisibleChildren(bool ignore);
+    /**
+     * If true, the layout will not take into account invisible children when creating gaps or
+     * calculating content sizes
+     */
+    Layout* ignoreInvisibleChildren(bool ignore = true);
     bool isIgnoreInvisibleChildren() const;
 
     virtual ~Layout() = default;
@@ -307,6 +311,11 @@ class GEODE_DLL AxisLayout : public Layout {
      * Set the default minimum/maximum scales for nodes in the layout
      */
     AxisLayout* setDefaultScaleLimits(float min, float max);
+    /**
+     * If true, the layout will not take into account invisible children when creating gaps or
+     * calculating content sizes
+     */
+    AxisLayout* ignoreInvisibleChildren(bool ignore = true);
 };
 
 /**

loader/include/Geode/ui/SimpleAxisLayout.hpp

@@ -183,6 +183,11 @@ class GEODE_DLL SimpleAxisLayout : public Layout {
      * The default is set to 2.0f
      */
     SimpleAxisLayout* setMaxRelativeScale(std::optional<float> scale);
+    /**
+     * If true, the layout will not take into account invisible children when creating gaps or
+     * calculating content sizes
+     */
+    SimpleAxisLayout* ignoreInvisibleChildren(bool ignore = true);
 
     Axis getAxis() const;
     AxisScaling getMainAxisScaling() const;

loader/src/cocos2d-ext/AxisLayout.cpp

@@ -930,6 +930,12 @@ AxisLayout* AxisLayout::setDefaultScaleLimits(float min, float max) {
     return this;
 }
 
+AxisLayout* AxisLayout::ignoreInvisibleChildren(bool ignore) {
+    Layout::ignoreInvisibleChildren(ignore);
+
+    return this;
+}
+
 AxisLayout::AxisLayout(Axis axis) : m_impl(std::make_unique<Impl>()) {
     m_impl->m_axis = axis;
 }

loader/src/cocos2d-ext/Layout.cpp

@@ -90,8 +90,9 @@ CCArray* Layout::getNodesToPosition(CCNode* on) const {
     return arr;
 }
 
-void Layout::ignoreInvisibleChildren(bool ignore) {
+Layout* Layout::ignoreInvisibleChildren(bool ignore) {
     m_ignoreInvisibleChildren = ignore;
+    return this;
 }
 
 bool Layout::isIgnoreInvisibleChildren() const {

loader/src/cocos2d-ext/SimpleAxisLayout.cpp

@@ -846,6 +846,11 @@ SimpleAxisLayout* SimpleAxisLayout::setMaxRelativeScale(std::optional<float> sca
     return this;
 }
 
+SimpleAxisLayout* SimpleAxisLayout::ignoreInvisibleChildren(bool ignore) {
+    Layout::ignoreInvisibleChildren(ignore);
+    return this;
+}
+
 Axis SimpleAxisLayout::getAxis() const {
     return m_impl->m_axis;
 }