Merge pull request #113 from cschreib/special

Clean up `region` class

Author: cschreib

README.md

@@ -587,13 +587,13 @@ gui::root& root = manager->get_root();
 // NB: observer_ptr is a lightweight, non-owning smart pointer (vaguely similar to std::weak_ptr).
 utils::observer_ptr<gui::frame> frame =
     root.create_root_frame<gui::frame>("FPSCounter");
-frame->set_point(gui::point::TOP_LEFT);
-frame->set_point(gui::point::BOTTOM_RIGHT);
+frame->set_anchor(gui::point::TOP_LEFT);
+frame->set_anchor(gui::point::BOTTOM_RIGHT);
 
 // Create the FontString as a child region of the frame.
 utils::observer_ptr<gui::font_string> text =
     frame->create_layered_region<gui::font_string>(gui::layer::ARTWORK, "$parentText");
-text->set_point(gui::point::BOTTOM_RIGHT, gui::vector2f{-5, -5});
+text->set_anchor(gui::point::BOTTOM_RIGHT, gui::vector2f{-5, -5});
 text->set_font("interface/fonts/main.ttf", 12);
 text->set_alignment_x(gui::alignment_x::RIGHT);
 text->set_alignment_y(gui::alignment_y::BOTTOM);

bin/interface/scroll_test/addon.lua

@@ -29,8 +29,8 @@ function ScrollTest:init_root_folder()
     rootFolder.folderNum = 0
 
     rootFolder:set_text("/")
-    rootFolder:set_point("RIGHT", self.Splitter.FolderFrame.Scroll, "RIGHT", -5, 0)
-    rootFolder:set_point("TOP_LEFT", self.Splitter.FolderFrame.Scroll, "TOP_LEFT", 5, 5)
+    rootFolder:set_anchor("RIGHT", self.Splitter.FolderFrame.Scroll, "RIGHT", -5, 0)
+    rootFolder:set_anchor("TOP_LEFT", self.Splitter.FolderFrame.Scroll, "TOP_LEFT", 5, 5)
 
     rootFolder.Develop.Plus:hide()
 
@@ -68,9 +68,9 @@ function ScrollTest:init_root_folder()
 
         if rootFolder.lastFolder then
             rootFolder.lastFolder.nextFolder = folderButton
-            folderButton:set_point("TOP_LEFT", rootFolder.lastFolder, "BOTTOM_LEFT")
+            folderButton:set_anchor("TOP_LEFT", rootFolder.lastFolder, "BOTTOM_LEFT")
         else
-            folderButton:set_point("TOP_LEFT", rootFolder, "BOTTOM_LEFT", 16, 0)
+            folderButton:set_anchor("TOP_LEFT", rootFolder, "BOTTOM_LEFT", 16, 0)
         end
 
         self.folders[self.lastID] = folderButton
@@ -137,9 +137,9 @@ function ScrollTest:develop_folder(id, toggle)
 
             if parentFolder.lastFolder then
                 parentFolder.lastFolder.nextFolder = folderButton
-                folderButton:set_point("TOP_LEFT", parentFolder.lastFolder, "BOTTOM_LEFT")
+                folderButton:set_anchor("TOP_LEFT", parentFolder.lastFolder, "BOTTOM_LEFT")
             else
-                folderButton:set_point("TOP_LEFT", parentFolder, "BOTTOM_LEFT", 16, 0)
+                folderButton:set_anchor("TOP_LEFT", parentFolder, "BOTTOM_LEFT", 16, 0)
             end
 
             self.folders[self.lastID] = folderButton
@@ -163,7 +163,7 @@ function ScrollTest:develop_folder(id, toggle)
         end
 
         if parentFolder.nextFolder then
-            parentFolder.nextFolder:set_point(
+            parentFolder.nextFolder:set_anchor(
                 "TOP_LEFT", parentFolder.lastFolder, "BOTTOM_LEFT",
                 -16*(parentFolder.lastFolder.level - parentFolder.nextFolder.level), 0
             )
@@ -176,7 +176,7 @@ function ScrollTest:develop_folder(id, toggle)
         parentFolder.developed = false
 
         if (parentFolder.lastFolder.nextFolder) then
-            parentFolder.lastFolder.nextFolder:set_point("TOP_LEFT", parentFolder, "BOTTOM_LEFT")
+            parentFolder.lastFolder.nextFolder:set_anchor("TOP_LEFT", parentFolder, "BOTTOM_LEFT")
             parentFolder.nextFolder = parentFolder.lastFolder.nextFolder
         end
 
@@ -292,9 +292,9 @@ function ScrollTest:set_folder(id)
         fileButton:get_normal_font_object():set_word_wrap(false)
 
         if self.lastFile then
-            fileButton:set_point("TOP_LEFT", self.lastFile, "BOTTOM_LEFT")
+            fileButton:set_anchor("TOP_LEFT", self.lastFile, "BOTTOM_LEFT")
         else
-            fileButton:set_point("TOP_LEFT", self.Splitter.FileFrame.Scroll, "TOP_LEFT", 5, 5)
+            fileButton:set_anchor("TOP_LEFT", self.Splitter.FileFrame.Scroll, "TOP_LEFT", 5, 5)
         end
 
         fileButton.IconFrame.Icon:set_texture("|icons.png")

bin/interface/scroll_test/addon.xml

@@ -99,8 +99,8 @@
                 </Anchors>
                 <Scripts>
                     <OnLoad>
-                        self.ThumbTexture:set_point("TOP", self, "TOP");
-                        self.ThumbTexture:set_point("BOTTOM", self, "BOTTOM");
+                        self.ThumbTexture:set_anchor("TOP", self, "TOP");
+                        self.ThumbTexture:set_anchor("BOTTOM", self, "BOTTOM");
                     </OnLoad>
                 </Scripts>
                 <Frames>

bin/interface/scroll_test/templates.xml

@@ -10,7 +10,7 @@
                 </Offset>
             </Anchor>
         </Anchors>
-        <NormalText font="interface/fonts/main.ttf" fontHeight="11" setAllPoints="false" alignX="LEFT">
+        <NormalText font="interface/fonts/main.ttf" fontHeight="11" setAllAnchors="false" alignX="LEFT">
             <Anchors>
                 <Anchor point="LEFT" relativeTo="$parentIconFrame" relativePoint="RIGHT">
                     <Offset>
@@ -36,7 +36,7 @@
                 </Anchors>
                 <Layers>
                     <Layer>
-                        <Texture name="$parentIcon" setAllPoints="true"/>
+                        <Texture name="$parentIcon" setAllAnchors="true"/>
                     </Layer>
                 </Layers>
             </Frame>
@@ -50,7 +50,7 @@
         <Anchors>
             <Anchor point="RIGHT"/>
         </Anchors>
-        <NormalText font="interface/fonts/main.ttf" fontHeight="11" setAllPoints="false" alignX="LEFT">
+        <NormalText font="interface/fonts/main.ttf" fontHeight="11" setAllAnchors="false" alignX="LEFT">
             <Anchors>
                 <Anchor point="LEFT" relativeTo="$parentIconFrame" relativePoint="RIGHT">
                     <Offset>
@@ -77,10 +77,10 @@
                 </Anchors>
                 <Layers>
                     <Layer>
-                        <Texture name="$parentPlus" file="|icons.png" setAllPoints="true">
+                        <Texture name="$parentPlus" file="|icons.png" setAllAnchors="true">
                             <TexCoords left="0" right="0.125" top="0.0" bottom="1.0"/>
                         </Texture>
-                        <Texture name="$parentMinus" file="|icons.png" hidden="true" setAllPoints="true">
+                        <Texture name="$parentMinus" file="|icons.png" hidden="true" setAllAnchors="true">
                             <TexCoords left="0.125" right="0.25" top="0.0" bottom="1.0"/>
                         </Texture>
                     </Layer>
@@ -100,7 +100,7 @@
                 </Anchors>
                 <Layers>
                     <Layer>
-                        <Texture name="$parentFolder" file="|icons.png" setAllPoints="true">
+                        <Texture name="$parentFolder" file="|icons.png" setAllAnchors="true">
                             <TexCoords left="0.25" right="0.375" top="0.0" bottom="1.0"/>
                         </Texture>
                     </Layer>

bin/interface/slider_test/addon.xml

@@ -38,7 +38,7 @@
                     </Anchor>
                 </Anchors>
                 <Frames>
-                    <Frame name="$parentColorZone" setAllPoints="true">
+                    <Frame name="$parentColorZone" setAllAnchors="true">
                         <Backdrop edgeFile="|border_2px.png">
                             <BackgroundInsets>
                                 <AbsInset left="2" right="2" top="2" bottom="2"/>

bin/interface/slider_test/templates.xml

@@ -89,7 +89,7 @@
                                 </Offset>
                             </Anchor>
                         </Anchors>
-                        <NormalText font="interface/fonts/main.ttf" fontHeight="11" setAllPoints="false">
+                        <NormalText font="interface/fonts/main.ttf" fontHeight="11" setAllAnchors="false">
                             <Anchors>
                                 <Anchor point="CENTER"/>
                             </Anchors>

bin/interface/statusbar_test/addon.xml

@@ -37,7 +37,7 @@
         </Scripts>
         <Layers>
             <Layer level="HIGHLIGHT">
-                <FontString name="$parentText" font="interface/fonts/main.ttf" fontHeight="11" outline="NORMAL" text="Zoom x1.0" setAllPoints="true"/>
+                <FontString name="$parentText" font="interface/fonts/main.ttf" fontHeight="11" outline="NORMAL" text="Zoom x1.0" setAllAnchors="true"/>
             </Layer>
         </Layers>
     </StatusBar>
@@ -59,7 +59,7 @@
                 self.timer = self.update_time;
                 self.total_fps = 0;
                 self.frames = 0;
-                FontstringTestFrameText:set_point("BOTTOM_RIGHT", self, "TOP_RIGHT", -2, -5);
+                FontstringTestFrameText:set_anchor("BOTTOM_RIGHT", self, "TOP_RIGHT", -2, -5);
             </OnLoad>
             <OnUpdate>
                 if (arg1 == 0) then arg1 = 0.1; end
@@ -85,7 +85,7 @@
         </Scripts>
         <Layers>
             <Layer level="HIGHLIGHT">
-                <Texture name="$parentBorder" file="|bar_outline.png" setAllPoints="true"/>
+                <Texture name="$parentBorder" file="|bar_outline.png" setAllAnchors="true"/>
             </Layer>
         </Layers>
     </StatusBar>

changelog.txt

@@ -119,6 +119,11 @@ Other changes:
  - gui: renamed justifyH to alignX, justifyV to alignY
  - gui: renamed anchor_point to point
  - gui: renamed register_for_drag to enable_drag
+ - gui: renamed get_object_type to get_region_type
+ - gui: renamed clear_all_points to clear_all_anchors
+ - gui: renamed [get/set/modify]_point to [get/set/modify]_anchor
+ - gui: renamed any function of the form "get_num_[...]()" into "get_[...]_count()"
+ - gui: renamed set_all_points/clear_all_points to set_all_anchors/clear_all_anchors
  - gui: removed Frame:on from Lua API (instead, call scripts directly, e.g.: frame:on_update())
  - gui: removed the sprite class
  - gui: removed region::get_base()
@@ -138,6 +143,7 @@ Other changes:
  - gui: removed frame::is_in_frame; use is_in_region instead
  - gui: removed frame::register_all_events and unregister_all_events
  - gui: removed event class; generic events are now only using event_data
+ - gui: removed get_frame_type, use get_region_type instead
  - gui: edit_box::set_text_insets now takes a single bounds2f argument
  - gui: frame::on_script now takes the full script name ("OnUpdate" vs "Update")
  - gui: frame::on_script now takes a 'const event_data&' instead of an 'event*' argument

examples/common/examples_common.cpp

@@ -111,15 +111,15 @@ void examples_setup_gui(gui::manager& manager) {
     // Create a root frame.
     utils::observer_ptr<gui::frame> fps_frame;
     fps_frame = root.create_root_frame<gui::frame>("FPSCounter");
-    fps_frame->set_point(gui::point::top_left);
-    fps_frame->set_point(
+    fps_frame->set_anchor(gui::point::top_left);
+    fps_frame->set_anchor(
         gui::point::bottom_right, "FontstringTestFrameText", gui::point::top_right);
 
     // Create a font_string in the frame.
     utils::observer_ptr<gui::font_string> fps_text;
     fps_text =
         fps_frame->create_layered_region<gui::font_string>(gui::layer::artwork, "$parentText");
-    fps_text->set_point(gui::point::bottom_right, gui::vector2f(0, -5));
+    fps_text->set_anchor(gui::point::bottom_right, gui::vector2f(0, -5));
     fps_text->set_font("interface/fonts/main.ttf", 15);
     fps_text->set_alignment_y(gui::alignment_y::bottom);
     fps_text->set_alignment_x(gui::alignment_x::right);

examples/opengl-sdl-emscripten/main.cpp

@@ -56,6 +56,9 @@ void main_loop(void* type_erased_data) try {
         return;
     }
 
+    // Reset batch count (for analytics only, optional)
+    context.manager->get_renderer().reset_counters();
+
     // Update the gui
     SDL_GL_MakeCurrent(context.window, context.gl_context);
     context.manager->update_ui(context.delta);

examples/opengl-sdl/main.cpp

@@ -145,6 +145,9 @@ int main(int argc, char* argv[]) {
                 continue;
             }
 
+            // Reset batch count (for analytics only, optional)
+            manager->get_renderer().reset_counters();
+
             // Update the gui
             SDL_GL_MakeCurrent(window.get(), gl_context.context);
             manager->update_ui(delta);

examples/opengl-sfml/main.cpp

@@ -101,6 +101,9 @@ int main(int argc, char* argv[]) {
                 continue;
             }
 
+            // Reset batch count (for analytics only, optional)
+            manager->get_renderer().reset_counters();
+
             // Update the gui
             manager->update_ui(delta);
 

examples/sdl-emscripten/main.cpp

@@ -54,6 +54,9 @@ void main_loop(void* type_erased_data) try {
         return;
     }
 
+    // Reset batch count (for analytics only, optional)
+    context.manager->get_renderer().reset_counters();
+
     // Update the gui
     context.manager->update_ui(context.delta);
 

examples/sdl/main.cpp

@@ -116,6 +116,9 @@ int main(int argc, char* argv[]) {
                 continue;
             }
 
+            // Reset batch count (for analytics only, optional)
+            manager->get_renderer().reset_counters();
+
             // Update the gui
             manager->update_ui(delta);
 

examples/sfml/main.cpp

@@ -85,6 +85,9 @@ int main(int argc, char* argv[]) {
                 continue;
             }
 
+            // Reset batch count (for analytics only, optional)
+            manager->get_renderer().reset_counters();
+
             // Update the gui
             manager->update_ui(delta);
 

impl/gui/gl/src/gui_gl_vertex_cache.cpp

@@ -87,6 +87,7 @@ void vertex_cache::update_indices(const std::uint32_t* vertex_indices, std::size
     }
 
     current_size_index_ = num_indices;
+    num_vertex_         = current_size_index_;
 }
 
 void vertex_cache::update_indices_if_grow(
@@ -96,6 +97,7 @@ void vertex_cache::update_indices_if_grow(
     } else {
         // Cheap resize, do not update indices
         current_size_index_ = num_indices;
+        num_vertex_         = current_size_index_;
     }
 }
 

impl/gui/sfml/src/gui_sfml_renderer.cpp

@@ -142,7 +142,7 @@ void renderer::render_cache_(
     if (sf_mat)
         state.texture = sf_mat->get_texture();
     state.transform = to_sfml(model_transform);
-    current_sfml_target_->draw(sf_cache.get_impl(), 0, sf_cache.get_num_vertex(), state);
+    current_sfml_target_->draw(sf_cache.get_impl(), 0, sf_cache.get_vertex_count(), state);
 #else
     throw gui::exception("gui::sfml::renderer", "SFML does not support vertex caches.");
 #endif

impl/gui/sfml/src/gui_sfml_vertex_cache.cpp

@@ -55,10 +55,6 @@ void vertex_cache::update(const vertex* vertex_data, std::size_t num_vertex) {
     }
 }
 
-std::size_t vertex_cache::get_num_vertex() const {
-    return num_vertex_;
-}
-
 const sf::VertexBuffer& vertex_cache::get_impl() const {
     return buffer_;
 }

include/lxgui/gui_animated_texture.hpp

@@ -15,9 +15,9 @@ class renderer;
  * \details This object contains an animated texture taken from a file.
  */
 class animated_texture : public layered_region {
+public:
     using base = layered_region;
 
-public:
     /// Constructor.
     explicit animated_texture(
         utils::control_block& block, manager& mgr, const region_core_attributes& attr);
@@ -134,6 +134,8 @@ class animated_texture : public layered_region {
     void update_tex_coords_();
     void update_borders_() override;
 
+    const std::vector<std::string>& get_type_list_() const override;
+
     std::string file_;
 
     float speed_     = 1.0f;

include/lxgui/gui_atlas.hpp

@@ -181,7 +181,7 @@ class atlas {
      * \brief Return the number of pages in this atlas.
      * \return The number of pages in this atlas
      */
-    std::size_t get_num_pages() const;
+    std::size_t get_page_count() const;
 
 protected:
     /**

include/lxgui/gui_button.hpp

@@ -41,9 +41,9 @@ class font_string;
  * - `OnDisable`: Triggered by button::disable.
  */
 class button : public frame {
+public:
     using base = frame;
 
-public:
     enum class state { up, down, disabled };
 
     /// Constructor.
@@ -342,6 +342,8 @@ class button : public frame {
     void parse_attributes_(const layout_node& node) override;
     void parse_all_nodes_before_children_(const layout_node& node) override;
 
+    const std::vector<std::string>& get_type_list_() const override;
+
     state state_               = state::up;
     bool  is_highlighted_      = false;
     bool  is_highlight_locked_ = false;

include/lxgui/gui_check_button.hpp

@@ -13,9 +13,9 @@ namespace lxgui::gui {
  * additional special textures for the check sign.
  */
 class check_button : public button {
+public:
     using base = button;
 
-public:
     /// Constructor.
     explicit check_button(
         utils::control_block& block, manager& mgr, const frame_core_attributes& attr);
@@ -113,6 +113,8 @@ class check_button : public button {
 protected:
     void parse_all_nodes_before_children_(const layout_node& node) override;
 
+    const std::vector<std::string>& get_type_list_() const override;
+
     bool is_checked_ = false;
 
     utils::observer_ptr<texture> checked_texture_          = nullptr;