Merge pull request #110 from cschreib/strata

Strata improvement and fixes

Author: cschreib

changelog.txt

@@ -211,6 +211,7 @@ Other changes:
  - gui: fixed frame not marked as "user placed" when moved or resized
  - gui: fixed missing 'const' for slider::are_clicks_outside_thumb_allowed()
  - gui: fixed missing 'const' for region::render()
+ - gui: fixed status_bar not firing OnValueChanged
 
 v1.2.0:
  - added support for MSVC 2010

include/lxgui/gui_frame.hpp

@@ -6,6 +6,7 @@
 #include "lxgui/gui_frame_core_attributes.hpp"
 #include "lxgui/gui_layered_region.hpp"
 #include "lxgui/gui_region.hpp"
+#include "lxgui/gui_strata.hpp"
 #include "lxgui/input_keys.hpp"
 #include "lxgui/lxgui.hpp"
 #include "lxgui/utils.hpp"
@@ -17,6 +18,8 @@
 #include <limits>
 #include <list>
 #include <lxgui/extern_sol2_protected_function.hpp>
+#include <magic_enum.hpp>
+#include <optional>
 #include <set>
 #include <unordered_map>
 #include <vector>
@@ -105,7 +108,7 @@ using script_list_view = script_signal::slot_list_view;
  * explicit key capture (@ref frame::enable_key_capture).
  * - Events related to mouse click input (`OnDragStart`, `OnDragStop`,
  * `OnMouseUp`, `OnMouseDown`) require frame::enable_mouse_click.
- * - Events related to mouse move input (`OnEnter`, `OnLeave`)
+ * - Events related to mouse move input (`OnEnter`, `OnLeave`, `OnMouseMove`)
  * require frame::enable_mouse_move.
  * - Events related to mouse wheel input (`OnMouseWheel`) require
  * frame::enable_mouse_wheel.
@@ -188,6 +191,11 @@ using script_list_view = script_signal::slot_list_view;
  * the registered callback: a number identifying the mouse button, a string
  * containing the human-readable name of this button (`"LeftButton"`,
  * `"RightButton"`, or `"MiddleButton"`), and the mouse X and Y position.
+ * - `OnMouseMove`: Triggered when the mouse moves over this frame, after
+ * `OnEnter` and until `OnLeave`. This event provides four argument to
+ * the registered callback: the amount of mouse movement in X and Y since the
+ * last call to `OnMouseMove` (or since the last position before the mouse
+ * entered this frame), and the mouse X and Y position.
  * - `OnMouseUp`: Similar to `OnMouseDown`, but triggered when the mouse button
  * is released.
  * - `OnMouseWheel`: Triggered when the mouse wheel is moved and this frame is
@@ -726,12 +734,6 @@ class frame : public region {
         return down_cast<RegionType>(get_region(name));
     }
 
-    /**
-     * \brief Calculates effective alpha.
-     * \return Effective alpha (alpha*parent->alpha)
-     */
-    float get_effective_alpha() const;
-
     /**
      * \brief Calculates effective scale.
      * \return Effective scale (scale*parent->scale)
@@ -746,9 +748,16 @@ class frame : public region {
 
     /**
      * \brief Returns this frame's strata.
-     * \return This frame's strata
+     * \return This frame's strata, or nullopt if the strata is inherited from the parent.
+     * \note See get_effective_frame_strata() to obtain the actual strata of this frame.
      */
-    frame_strata get_frame_strata() const;
+    std::optional<frame_strata> get_frame_strata() const;
+
+    /**
+     * \brief Returns this frame's effective strata.
+     * \return This frame's strata, or its parent's effective strata if frame_strata::parent.
+     */
+    frame_strata get_effective_frame_strata() const;
 
     /**
      * \brief Returns this frame's top-level parent.
@@ -1257,15 +1266,9 @@ class frame : public region {
 
     /**
      * \brief Sets this frame's strata.
-     * \param strata_id The new strata
-     */
-    void set_frame_strata(frame_strata strata_id);
-
-    /**
-     * \brief Sets this frame's strata.
-     * \param strata_name The new strata
+     * \param strata_id The new strata, or nullopt to inherit strata from parent
      */
-    void set_frame_strata(const std::string& strata_name);
+    void set_frame_strata(std::optional<frame_strata> strata_id);
 
     /**
      * \brief Sets this frames' backdrop.
@@ -1465,16 +1468,16 @@ class frame : public region {
      * \return The renderer of this object or its parents, nullptr if none
      * \note For more information, see @ref set_frame_renderer().
      */
-    utils::observer_ptr<const frame_renderer> get_top_level_frame_renderer() const final;
+    utils::observer_ptr<const frame_renderer> get_effective_frame_renderer() const final;
 
     /**
      * \brief Returns the renderer of this object or its parents, nullptr if none.
      * \return The renderer of this object or its parents, nullptr if none
      * \note For more information, see @ref set_frame_renderer().
      */
-    utils::observer_ptr<frame_renderer> get_top_level_frame_renderer() {
+    utils::observer_ptr<frame_renderer> get_effective_frame_renderer() {
         return utils::const_pointer_cast<frame_renderer>(
-            const_cast<const frame*>(this)->get_top_level_frame_renderer());
+            const_cast<const frame*>(this)->get_effective_frame_renderer());
     }
 
     /**
@@ -1580,10 +1583,28 @@ class frame : public region {
 
     void add_level_(int amount);
 
-    void propagate_renderer_(bool rendered);
+    utils::observer_ptr<const frame_renderer> compute_top_level_frame_renderer_() const;
+
+    utils::observer_ptr<frame_renderer> compute_top_level_frame_renderer_() {
+        return utils::const_pointer_cast<frame_renderer>(
+            const_cast<const frame*>(this)->compute_top_level_frame_renderer_());
+    }
+
+    frame_strata compute_effective_frame_strata_() const;
+
+    void notify_frame_strata_changed_(frame_strata new_strata_id);
+
+    void notify_frame_renderer_changed_(const utils::observer_ptr<frame_renderer>& new_renderer);
 
     void update_borders_() override;
 
+    /**
+     * \brief Changes this region's parent.
+     * \param parent The new parent
+     * \note Default is nullptr.
+     */
+    void set_parent_(utils::observer_ptr<frame> parent) override;
+
     utils::connection define_script_(
         const std::string& script_name,
         const std::string& content,
@@ -1607,7 +1628,7 @@ class frame : public region {
     child_list  child_list_;
     region_list region_list_;
 
-    static constexpr std::size_t num_layers = static_cast<std::size_t>(layer::enum_size);
+    static constexpr std::size_t num_layers = magic_enum::enum_count<layer>();
 
     std::array<layer_container, num_layers> layer_list_;
 
@@ -1617,11 +1638,13 @@ class frame : public region {
     std::set<std::string> reg_drag_list_;
     std::set<std::string> reg_key_list_;
 
-    int          level_        = 0;
-    frame_strata strata_       = frame_strata::medium;
-    bool         is_top_level_ = false;
+    int                         level_ = 0;
+    std::optional<frame_strata> strata_;
+    frame_strata                effective_strata_ = frame_strata::medium;
+    bool                        is_top_level_     = false;
 
-    utils::observer_ptr<frame_renderer> frame_renderer_ = nullptr;
+    utils::observer_ptr<frame_renderer> frame_renderer_           = nullptr;
+    utils::observer_ptr<frame_renderer> effective_frame_renderer_ = nullptr;
 
     std::unique_ptr<backdrop> backdrop_;
 
@@ -1644,8 +1667,6 @@ class frame : public region {
     float min_height_ = 0.0f;
     float max_height_ = std::numeric_limits<float>::infinity();
 
-    vector2f old_size_;
-
     float scale_ = 1.0f;
 
     bool is_mouse_in_frame_ = false;

include/lxgui/gui_frame_renderer.hpp

@@ -5,8 +5,10 @@
 #include "lxgui/lxgui.hpp"
 #include "lxgui/utils.hpp"
 #include "lxgui/utils_observer.hpp"
+#include "lxgui/utils_sorted_vector.hpp"
 
 #include <functional>
+#include <magic_enum.hpp>
 
 namespace lxgui::gui {
 
@@ -18,7 +20,7 @@ class color;
 class frame_renderer {
 public:
     /// Default constructor
-    frame_renderer() = default;
+    frame_renderer();
 
     /// Destructor
     virtual ~frame_renderer() = default;
@@ -92,19 +94,27 @@ class frame_renderer {
     int get_highest_level(frame_strata strata_id) const;
 
 protected:
-    void add_to_strata_list_(strata& strata_obj, const utils::observer_ptr<frame>& obj);
-    void remove_from_strata_list_(strata& strata_obj, const utils::observer_ptr<frame>& obj);
-    void add_to_level_list_(level& level_obj, const utils::observer_ptr<frame>& obj);
-    void remove_from_level_list_(level& level_obj, const utils::observer_ptr<frame>& obj);
     void clear_strata_list_();
     bool has_strata_list_changed_() const;
     void reset_strata_list_changed_flag_();
     void notify_strata_needs_redraw_(strata& strata_obj);
 
     void render_strata_(const strata& strata_obj) const;
 
-    std::array<strata, 8> strata_list_;
-    bool                  strata_list_updated_ = false;
+    struct frame_comparator {
+        bool operator()(const frame* f1, const frame* f2) const;
+    };
+
+    using frame_list_type     = utils::sorted_vector<frame*, frame_comparator>;
+    using frame_list_iterator = frame_list_type::iterator;
+
+    std::pair<std::size_t, std::size_t> get_strata_range_(frame_strata strata_id) const;
+
+    static constexpr std::size_t num_strata = magic_enum::enum_count<frame_strata>();
+
+    std::array<strata, num_strata> strata_list_;
+    frame_list_type                sorted_frame_list_;
+    bool                           frame_list_updated_ = false;
 };
 
 } // namespace lxgui::gui

include/lxgui/gui_layered_region.hpp

@@ -8,15 +8,7 @@
 namespace lxgui::gui {
 
 /// ID of a layer for rendering inside a frame.
-enum class layer {
-    background  = 0,
-    border      = 1,
-    artwork     = 2,
-    overlay     = 3,
-    highlight   = 4,
-    specialhigh = 5,
-    enum_size
-};
+enum class layer { background, border, artwork, overlay, highlight, special_high };
 
 /**
  * \brief A #region that can be rendered in a layer.

include/lxgui/gui_region.hpp

@@ -6,7 +6,6 @@
 #include "lxgui/gui_color.hpp"
 #include "lxgui/gui_exception.hpp"
 #include "lxgui/gui_region_core_attributes.hpp"
-#include "lxgui/gui_strata.hpp"
 #include "lxgui/gui_vector2.hpp"
 #include "lxgui/lxgui.hpp"
 #include "lxgui/utils.hpp"
@@ -594,16 +593,16 @@ class region : public utils::enable_observer_from_this<region> {
      * \return The renderer of this object or its parents
      * \note For more information, see frame::set_frame_renderer().
      */
-    virtual utils::observer_ptr<const frame_renderer> get_top_level_frame_renderer() const;
+    virtual utils::observer_ptr<const frame_renderer> get_effective_frame_renderer() const;
 
     /**
      * \brief Returns the renderer of this object or its parents, nullptr if none.
      * \return The renderer of this object or its parents, nullptr if none
      * \note For more information, see frame::set_frame_renderer().
      */
-    utils::observer_ptr<frame_renderer> get_top_level_frame_renderer() {
+    utils::observer_ptr<frame_renderer> get_effective_frame_renderer() {
         return utils::const_pointer_cast<frame_renderer>(
-            const_cast<const region*>(this)->get_top_level_frame_renderer());
+            const_cast<const region*>(this)->get_effective_frame_renderer());
     }
 
     /**
@@ -767,16 +766,7 @@ class region : public utils::enable_observer_from_this<region> {
      * \param parent The new parent
      * \note Default is nullptr.
      */
-    void set_parent_(utils::observer_ptr<frame> parent);
-
-    /**
-     * \brief Sets this region's name and parent at once.
-     * \param name This region's name
-     * \param parent The new parent
-     * \note The name can only be set once. If you need to just change the
-     * parent, call set_parent_().
-     */
-    void set_name_and_parent_(const std::string& name, utils::observer_ptr<frame> parent);
+    virtual void set_parent_(utils::observer_ptr<frame> parent);
 
     /**
      * \brief Set up function to call in all derived class constructors.

include/lxgui/gui_scroll_frame.hpp

@@ -187,7 +187,6 @@ class scroll_frame : public frame, public frame_renderer {
 
     bool                           rebuild_scroll_render_target_flag_ = false;
     bool                           redraw_scroll_render_target_flag_  = false;
-    bool                           update_scroll_range_flag_          = false;
     std::shared_ptr<render_target> scroll_render_target_;
 
     utils::observer_ptr<texture> scroll_texture_ = nullptr;

include/lxgui/gui_status_bar.hpp

@@ -174,15 +174,6 @@ class status_bar : public frame {
      */
     bool is_reversed() const;
 
-    /**
-     * \brief Updates this region's logic.
-     * \param delta Time spent since last update
-     * \note Triggered callbacks could destroy the frame. If you need
-     * to use the frame again after calling this function, use
-     * the helper class alive_checker.
-     */
-    void update(float delta) override;
-
     /// Registers this region class to the provided Lua state
     static void register_on_lua(sol::state& lua);
 
@@ -195,8 +186,6 @@ class status_bar : public frame {
     void parse_attributes_(const layout_node& node) override;
     void parse_all_nodes_before_children_(const layout_node& node) override;
 
-    bool update_bar_texture_flag_ = false;
-
     orientation orientation_ = orientation::horizontal;
     bool        is_reversed_ = false;
 

include/lxgui/gui_strata.hpp

@@ -16,8 +16,7 @@ namespace lxgui::gui {
 class frame;
 
 enum class frame_strata {
-    parent     = -1,
-    background = 0,
+    background,
     low,
     medium,
     high,
@@ -27,19 +26,13 @@ enum class frame_strata {
     tooltip
 };
 
-struct strata;
-
-/// Contains gui::frame
-struct level {
-    std::vector<utils::observer_ptr<frame>> frame_list;
-};
-
-/// Contains gui::level
+/// Contains frames sorted by level
 struct strata {
-    std::map<int, level>           level_list;
-    bool                           redraw_flag = true;
-    std::shared_ptr<render_target> target;
-    quad                           target_quad;
+    frame_strata                        id;
+    std::pair<std::size_t, std::size_t> range;
+    bool                                redraw_flag = true;
+    std::shared_ptr<render_target>      target;
+    quad                                target_quad;
 };
 
 } // namespace lxgui::gui

include/lxgui/gui_texture.hpp

@@ -13,6 +13,7 @@
 namespace lxgui::gui {
 
 class renderer;
+class render_target;
 
 /**
  * \brief A layered_region that can draw images and colored rectangles.