Renamed is_ready_ to is_valid_ and added region::is_valid()

Author: cschreib

include/lxgui/gui_region.hpp

@@ -305,6 +305,17 @@ class region : public utils::enable_observer_from_this<region> {
      */
     bool is_visible() const;
 
+    /**
+     * \brief Checks if this region has all its borders correctly defined.
+     * \return 'true' if this region has all its borders correctly defined
+     * \note To be valid, a region needs to have a defined position and size along
+     * both the X and Y dimensions. This means either one anchor and a set size,
+     * or two opposite anchors. For example, any anchor plus a call to set_dimensions().
+     * Or a top_left plus a bottom_right anchors. Or a left plus a right anchors plus a
+     * call to set_height().
+     */
+    bool is_valid() const;
+
     /**
      * \brief Changes this region's absolute dimensions (in pixels).
      * \param dimensions The new dimensions
@@ -794,7 +805,7 @@ class region : public utils::enable_observer_from_this<region> {
     bool is_manually_inherited_ = false;
     bool is_virtual_            = false;
     bool is_loaded_             = false;
-    bool is_ready_              = true;
+    bool is_valid_              = true;
 
     std::array<std::optional<anchor>, 9> anchor_list_;
     bounds2<bool>                        defined_borders_;

include/lxgui/gui_text.hpp

@@ -437,7 +437,6 @@ class text {
 
     renderer& renderer_;
 
-    bool        is_ready_               = false;
     float       scaling_factor_         = 1.0f;
     float       tracking_               = 0.0f;
     float       line_spacing_           = 1.0f;

src/gui_font_string.cpp

@@ -21,7 +21,7 @@ font_string::font_string(
 void font_string::render() const {
     base::render();
 
-    if (!text_ || !is_ready_ || !is_visible())
+    if (!text_ || !is_valid_ || !is_visible())
         return;
 
     text_->set_use_vertex_cache(is_vertex_cache_used_());
@@ -466,9 +466,9 @@ void font_string::update_borders_() {
 //#define DEBUG_LOG(msg) gui::out << (msg) << std::endl
 #define DEBUG_LOG(msg)
 
-    const bool old_ready       = is_ready_;
+    const bool old_valid       = is_valid_;
     const auto old_border_list = borders_;
-    is_ready_                  = true;
+    is_valid_                  = true;
 
     if (!anchor_list_.empty()) {
         float left = 0.0f, right = 0.0f, top = 0.0f, bottom = 0.0f;
@@ -501,14 +501,14 @@ void font_string::update_borders_() {
             box_width = text_->get_width();
 
         if (!make_borders_(top, bottom, y_center, box_height)) {
-            is_ready_ = false;
+            is_valid_ = false;
         }
 
         if (!make_borders_(left, right, x_center, box_width)) {
-            is_ready_ = false;
+            is_valid_ = false;
         }
 
-        if (is_ready_) {
+        if (is_valid_) {
             if (right < left) {
                 right = left + 1.0f;
             }
@@ -535,15 +535,15 @@ void font_string::update_borders_() {
         }
 
         borders_  = bounds2f(0.0, 0.0, box_width, box_height);
-        is_ready_ = false;
+        is_valid_ = false;
     }
 
     borders_.left   = round_to_pixel(borders_.left);
     borders_.right  = round_to_pixel(borders_.right);
     borders_.top    = round_to_pixel(borders_.top);
     borders_.bottom = round_to_pixel(borders_.bottom);
 
-    if (borders_ != old_border_list || is_ready_ != old_ready) {
+    if (borders_ != old_border_list || is_valid_ != old_valid) {
         DEBUG_LOG("  Fire redraw");
         notify_renderer_need_redraw();
     }

src/gui_frame.cpp

@@ -63,7 +63,7 @@ frame::~frame() {
 void frame::render() const {
     base::render();
 
-    if (!is_visible() || !is_ready_)
+    if (!is_visible() || !is_valid_)
         return;
 
     if (backdrop_) {
@@ -1500,14 +1500,14 @@ void frame::notify_mouse_in_frame(bool mouse_in_frame, const vector2f& /*positio
 }
 
 void frame::update_borders_() {
-    const bool old_ready       = is_ready_;
+    const bool old_valid       = is_valid_;
     const auto old_border_list = borders_;
 
     base::update_borders_();
 
     check_position_();
 
-    if (borders_ != old_border_list || is_ready_ != old_ready) {
+    if (borders_ != old_border_list || is_valid_ != old_valid) {
         if (borders_.width() != old_border_list.width() ||
             borders_.height() != old_border_list.height()) {
             alive_checker checker(*this);

src/gui_region.cpp

@@ -92,7 +92,7 @@ std::string region::serialize(const std::string& tab) const {
     std::ostringstream str;
 
     str << tab << "  # Name       : " << name_ << " ("
-        << std::string(is_ready_ ? "ready" : "not ready")
+        << std::string(is_valid_ ? "valid" : "not valid")
         << std::string(is_manually_inherited_ ? ", manually inherited" : "") << ")\n";
     str << tab << "  # Raw name   : " << raw_name_ << "\n";
     str << tab << "  # Type       : " << get_region_type() << "\n";
@@ -208,6 +208,10 @@ bool region::is_visible() const {
     return is_visible_;
 }
 
+bool region::is_valid() const {
+    return is_valid_;
+}
+
 void region::set_dimensions(const vector2f& dimensions) {
     if (dimensions_ == dimensions)
         return;
@@ -668,10 +672,10 @@ void region::update_borders_() {
 
     DEBUG_LOG("  Update anchors for " + lua_name_);
 
-    const bool old_is_ready    = is_ready_;
+    const bool old_is_ready    = is_valid_;
     const auto old_border_list = borders_;
 
-    is_ready_ = true;
+    is_valid_ = true;
 
     if (!anchor_list_.empty()) {
         float left = 0.0f, right = 0.0f, top = 0.0f, bottom = 0.0f;
@@ -693,14 +697,14 @@ void region::update_borders_() {
 
         DEBUG_LOG("  Make borders");
         if (!make_borders_(top, bottom, y_center, rounded_height)) {
-            is_ready_ = false;
+            is_valid_ = false;
         }
 
         if (!make_borders_(left, right, x_center, rounded_width)) {
-            is_ready_ = false;
+            is_valid_ = false;
         }
 
-        if (is_ready_) {
+        if (is_valid_) {
             if (right < left) {
                 right = left + 1;
             }
@@ -714,7 +718,7 @@ void region::update_borders_() {
         }
     } else {
         borders_  = bounds2f(0.0, 0.0, dimensions_.x, dimensions_.y);
-        is_ready_ = false;
+        is_valid_ = false;
     }
 
     DEBUG_LOG("  Final borders");
@@ -728,7 +732,7 @@ void region::update_borders_() {
     DEBUG_LOG("    top=" + utils::to_string(borders_.top));
     DEBUG_LOG("    bottom=" + utils::to_string(borders_.bottom));
 
-    if (borders_ != old_border_list || is_ready_ != old_is_ready) {
+    if (borders_ != old_border_list || is_valid_ != old_is_ready) {
         DEBUG_LOG("  Fire redraw");
         notify_renderer_need_redraw();
     }
@@ -741,12 +745,12 @@ void region::notify_borders_need_update() {
     if (is_virtual())
         return;
 
-    const bool old_ready       = is_ready_;
+    const bool old_valid       = is_valid_;
     const auto old_border_list = borders_;
 
     update_borders_();
 
-    if (borders_ != old_border_list || is_ready_ != old_ready) {
+    if (borders_ != old_border_list || is_valid_ != old_valid) {
         for (const auto& object : anchored_object_list_)
             object->notify_borders_need_update();
     }

src/gui_region_glues.cpp

@@ -261,6 +261,10 @@ void region::register_on_lua(sol::state& lua) {
      */
     type.set_function("is_visible", member_function<&region::is_visible>());
 
+    /** @function is_valid
+     */
+    type.set_function("is_valid", member_function<&region::is_valid>());
+
     /** @function set_all_anchors
      */
     type.set_function(

src/gui_text.cpp

@@ -282,13 +282,7 @@ float get_string_width(const text& txt, const std::vector<item>& content) {
 
 text::text(
     renderer& rdr, std::shared_ptr<const font> fnt, std::shared_ptr<const font> outline_font) :
-    renderer_(rdr), font_(std::move(fnt)), outline_font_(std::move(outline_font)) {
-
-    if (!font_)
-        return;
-
-    is_ready_ = true;
-}
+    renderer_(rdr), font_(std::move(fnt)), outline_font_(std::move(outline_font)) {}
 
 float text::get_line_height() const {
     if (font_)
@@ -400,7 +394,7 @@ float text::get_text_width() const {
 }
 
 float text::get_text_height() const {
-    if (!is_ready_)
+    if (!font_)
         return 0.0f;
 
     std::size_t count  = std::count(unicode_text_.begin(), unicode_text_.end(), U'\n');
@@ -419,15 +413,15 @@ float text::get_string_width(const std::string& content) const {
 }
 
 float text::get_string_width(const utils::ustring& content) const {
-    if (!is_ready_)
+    if (!font_)
         return 0.0f;
 
     return parser::get_string_width(
         *this, parser::parse_string(renderer_, content, formatting_enabled_));
 }
 
 float text::get_character_width(char32_t c) const {
-    if (!is_ready_)
+    if (!font_)
         return 0.0f;
     else if (c == U'\t')
         return 4.0f * font_->get_character_width(U' ') * scaling_factor_;
@@ -552,7 +546,7 @@ bool text::use_vertex_cache_() const {
 }
 
 void text::render(const matrix4f& transform) const {
-    if (!is_ready_ || unicode_text_.empty())
+    if (!font_ || unicode_text_.empty())
         return;
 
     update_();
@@ -624,7 +618,7 @@ float text::round_to_pixel_(float value, utils::rounding_method method) const {
 }
 
 void text::update_() const {
-    if (!is_ready_ || !update_cache_flag_)
+    if (!font_ || !update_cache_flag_)
         return;
 
     // Update the line list, read format tags, do word wrapping, ...