cyberarm_engine 0.25.0 → 0.30.0

data/lib/cyberarm_engine/ui/elements/text_block.rb

@@ -1,222 +1,236 @@
-module CyberarmEngine
-  class Element
-    class TextBlock < Element
-      def initialize(text, options = {}, block = nil)
-        super(options, block)
-
-        @text = Text.new(
-          text, font: @options[:font], z: @z, color: @options[:color],
-                size: @options[:text_size], shadow: @options[:text_shadow],
-                static: @options[:text_static],
-                shadow_size: @options[:text_shadow_size],
-                shadow_color: @options[:text_shadow_color],
-                border: @options[:text_border],
-                border_size: @options[:text_border_size],
-                border_color: @options[:text_border_color]
-        )
-
-        @raw_text = text
-        @text_width = @text.width
-        @text_height = @text.height
-      end
-
-      def update
-        super
-
-        if @text.textobject.name != safe_style_fetch(:font)
-          set_font
-          root.gui_state.request_recalculate
-        end
-      end
-
-      def render
-        # Gosu.clip_to is too expensive to always use so check if we actually need it.
-        if @text_width > width || @text_height > height
-          Gosu.clip_to(@x, @y, width, height) do
-            @text.draw
-          end
-        else
-          @text.draw
-        end
-      end
-
-      def layout
-        unless @enabled
-          @text.color = @style.disabled[:color]
-        else
-          @text.color = @style.color
-        end
-
-        @width  = 0
-        @height = 0
-
-        _width  = dimensional_size(@style.width,  :width)
-        _height = dimensional_size(@style.height, :height)
-
-        handle_text_wrapping(_width)
-
-        # Update cached text width and height
-        @text_width = @text.width
-        @text_height = @text.height
-
-        @width  = _width  || @text_width.floor
-        @height = _height || @text_height.floor
-
-        @text.y = @style.border_thickness_top + @style.padding_top + @y
-        @text.z = @z + 3
-
-        if (text_alignment = @options[:text_align] || @options[:text_h_align])
-          case text_alignment
-          when :left
-            @text.x = @style.border_thickness_left + @style.padding_left + @x
-          when :center
-            @text.x = if @text_width <= width
-                        @x + width / 2 - @text_width / 2
-                      else # Act as left aligned
-                        @style.border_thickness_left + @style.padding_left + @x
-                      end
-          when :right
-            @text.x = @x + outer_width - (@text_width + @style.border_thickness_right + @style.padding_right)
-          end
-        end
-
-        if (vertical_alignment = @options[:text_v_align])
-          case vertical_alignment
-          when :center
-            @text.y = if @text_height <= height
-                        @y + height / 2 - @text_height / 2
-                      else
-                        @style.border_thickness_top + @style.padding_top + @y
-                      end
-          when :bottom
-            @text.y = @y + outer_height - (@text_height + @style.border_thickness_bottom + @style.padding_bottom)
-          end
-        end
-
-        update_background
-      end
-
-      def handle_text_wrapping(max_width)
-        max_width ||= @parent&.content_width
-        max_width ||= @x - (window.width + noncontent_width)
-        wrap_behavior = style.text_wrap
-        copy = @raw_text.to_s.dup
-
-        # Only perform text wrapping: if it is enabled, is possible to wrap, and text is too long to fit on one line
-        if wrap_behavior != :none && line_width(copy[0]) <= max_width && line_width(copy) > max_width
-          breaks = [] # list of indexes to insert a line break
-          line_start = 0
-          line_end = copy.length
-
-          stalled = false
-          stalled_interations = 0
-          max_stalled_iterations = 10
-          checked_copy_length = line_width(copy[line_start..line_end])
-
-          # find length of lines
-          while line_width(copy[line_start..line_end]) > max_width && stalled_interations < max_stalled_iterations
-            search_start = line_start
-            search_end = line_end
-
-            # Perform a binary search to find length of line
-            while search_start < search_end
-              midpoint = ((search_start.to_f + search_end) / 2.0).floor
-
-              if line_width(copy[line_start..midpoint]) > max_width
-                search_end = midpoint
-              else
-                search_start = midpoint + 1
-              end
-            end
-
-            if wrap_behavior == :word_wrap
-              word_search_end = search_end
-              failed = false
-
-              until(copy[word_search_end].to_s.match(/[[:punct:]]| /))
-                word_search_end -= 1
-
-                if word_search_end <= 1 || word_search_end < line_start
-                  failed = true
-                  break
-                end
-              end
-
-              line_start = failed ? search_end : word_search_end + 1 # walk in front of punctuation
-            else
-              line_start = search_end
-            end
-
-            breaks << line_start
-
-            # Prevent locking up due to outer while loop text width < max_width check not being satisfied.
-            stalled = checked_copy_length == line_width(copy[line_start..line_end])
-            checked_copy_length = line_width(copy[line_start..line_end])
-
-            stalled_interations += 1 if stalled
-            stalled_interations = 0 unless stalled
-          end
-
-          breaks.each_with_index do |pos, index|
-            copy.insert(pos + index, "\n") if pos + index >= 0 && pos + index < copy.length
-          end
-        end
-
-        @text.text = copy
-      end
-
-      def line_width(text)
-        (@text.textobject.markup_width(text.to_s) + noncontent_width)
-      end
-
-      def value
-        @raw_text
-      end
-
-      def value=(value)
-        old_value = @raw_text
-        @raw_text = value.to_s.chomp
-
-        old_width = width
-        old_height = height
-
-        if old_width != width || old_height != height
-          root.gui_state.request_recalculate
-        else
-          recalculate
-        end
-
-        root.gui_state.request_repaint if old_value != @raw_text
-
-        publish(:changed, self.value)
-      end
-    end
-
-    class Banner < TextBlock
-    end
-
-    class Title < TextBlock
-    end
-
-    class Subtitle < TextBlock
-    end
-
-    class Tagline < TextBlock
-    end
-
-    class Caption < TextBlock
-    end
-
-    class Para < TextBlock
-    end
-
-    class Inscription < TextBlock
-    end
-
-    class ToolTip < TextBlock
-    end
-
-    class Link < TextBlock
-    end
-  end
-end
+module CyberarmEngine
+  class Element
+    class TextBlock < Element
+      def initialize(text, options = {}, block = nil)
+        super(options, block)
+
+        @text = Text.new(
+          text, font: @options[:font], z: @z, color: @options[:color],
+                size: @options[:text_size], shadow: @options[:text_shadow],
+                static: @options[:text_static],
+                alignment: @options[:text_align],
+                shadow_size: @options[:text_shadow_size],
+                shadow_color: @options[:text_shadow_color],
+                border: @options[:text_border],
+                border_size: @options[:text_border_size],
+                border_color: @options[:text_border_color]
+        )
+
+        @raw_text = text
+        @text_width = @text.width
+        @text_height = @text.height
+      end
+
+      def update
+        super
+
+        if @text.textobject.name != safe_style_fetch(:font)
+          set_font
+          root.gui_state.request_recalculate
+        end
+      end
+
+      def render
+        # Gosu.clip_to is too expensive to always use so check if we actually need it.
+        if @text_width > width || @text_height > height
+          Gosu.clip_to(@text.x, @text.y, @width, @height) do
+            @text.draw
+          end
+        else
+          @text.draw
+        end
+      end
+
+      def layout
+        @text.color = styled(:color)
+        @text.alignment = styled(:text_align)
+
+        @text.shadow = styled(:text_shadow)
+        @text.shadow_color = styled(:text_shadow_color)
+        @text.shadow_alpha = styled(:text_shadow_alpha)
+        @text.shadow_size = styled(:text_shadow_size)
+
+        @text.border = styled(:text_border)
+        @text.border_color = styled(:text_border_color)
+        @text.border_alpha = styled(:text_border_alpha)
+        @text.border_size = styled(:text_border_size)
+
+        @width  = 0
+        @height = 0
+
+        _width  = dimensional_size(@style.width,  :width)
+        _height = dimensional_size(@style.height, :height)
+
+        handle_text_wrapping(_width)
+
+        # Update cached text width and height
+        @text_width = @text.width
+        @text_height = @text.height
+
+        @width  = _width  || @text_width.floor
+        @height = _height || @text_height.floor
+
+        @text.y = styled(:margin_top) + styled(:border_thickness_top) + styled(:padding_top) + @y
+        @text.z = @z + 3
+
+        if (text_alignment = @options[:text_align] || @options[:text_h_align])
+          case text_alignment
+          when :left
+            @text.x = styled(:margin_left) + styled(:border_thickness_left) + styled(:padding_left) + @x
+          when :center
+            @text.x = if @text_width <= width
+                        @x + styled(:margin_left) + width / 2 - @text_width / 2
+                      else # Act as left aligned
+                        styled(:margin_left) + styled(:border_thickness_left) + styled(:padding_left) + @x
+                      end
+          when :right
+            @text.x = @x + styled(:margin_left) + outer_width - (@text_width + styled(:border_thickness_right) + styled(:padding_right))
+          end
+        end
+
+        if (vertical_alignment = @options[:text_v_align])
+          case vertical_alignment
+          when :center
+            @text.y = if @text_height <= height
+                        @y + styled(:margin_top) + height / 2 - @text_height / 2
+                      else
+                        styled(:margin_top) + styled(:border_thickness_top) + styled(:padding_top) + @y
+                      end
+          when :bottom
+            @text.y = @y + styled(:margin_top) + outer_height - (@text_height + styled(:border_thickness_bottom) + styled(:padding_bottom))
+          end
+        end
+
+        update_background
+      end
+
+      def handle_text_wrapping(max_width)
+        max_width ||= @parent&.content_width
+        max_width ||= @x - (window.width + noncontent_width)
+        wrap_behavior = styled(:text_wrap)
+        copy = @raw_text.to_s.dup
+
+        # Only perform text wrapping: if it is enabled, is possible to wrap, and text is too long to fit on one line
+        if wrap_behavior != :none && line_width(copy[0]) <= max_width && line_width(copy) > max_width
+          breaks = [] # list of indexes to insert a line break
+          line_start = 0
+          line_end = copy.length
+
+          stalled = false
+          stalled_interations = 0
+          max_stalled_iterations = 10
+          checked_copy_length = line_width(copy[line_start..line_end])
+
+          # find length of lines
+          while line_width(copy[line_start..line_end]) > max_width && stalled_interations < max_stalled_iterations
+            search_start = line_start
+            search_end = line_end
+
+            # Perform a binary search to find length of line
+            while search_start < search_end
+              midpoint = ((search_start.to_f + search_end) / 2.0).floor
+
+              if line_width(copy[line_start..midpoint]) > max_width
+                search_end = midpoint
+              else
+                search_start = midpoint + 1
+              end
+            end
+
+            if wrap_behavior == :word_wrap
+              word_search_end = search_end
+              failed = false
+
+              until(copy[word_search_end].to_s.match(/[[:punct:]]| /))
+                word_search_end -= 1
+
+                if word_search_end <= 1 || word_search_end < line_start
+                  failed = true
+                  break
+                end
+              end
+
+              line_start = failed ? search_end : word_search_end + 1 # walk in front of punctuation
+            else
+              line_start = search_end
+            end
+
+            breaks << line_start
+
+            # Prevent locking up due to outer while loop text width < max_width check not being satisfied.
+            stalled = checked_copy_length == line_width(copy[line_start..line_end])
+            checked_copy_length = line_width(copy[line_start..line_end])
+
+            stalled_interations += 1 if stalled
+            stalled_interations = 0 unless stalled
+          end
+
+          breaks.each_with_index do |pos, index|
+            copy.insert(pos + index, "\n") if pos + index >= 0 && pos + index < copy.length
+          end
+        end
+
+        @text.text = copy
+      end
+
+      def line_width(text)
+        (@text.textobject.markup_width(text.to_s) + noncontent_width)
+      end
+
+      def value
+        @raw_text
+      end
+
+      def value=(value)
+        old_value = @raw_text
+        @raw_text = value.to_s.chomp
+
+        old_width = width
+        old_height = height
+
+        if old_width != width || old_height != height
+          root.gui_state.request_recalculate
+        else
+          recalculate
+        end
+
+        if old_value != @raw_text
+          root.gui_state.request_repaint
+          publish(:changed, @raw_text)
+        end
+
+        value
+      end
+    end
+
+    class Banner < TextBlock
+    end
+
+    class Title < TextBlock
+    end
+
+    class Subtitle < TextBlock
+    end
+
+    class Tagline < TextBlock
+    end
+
+    class Caption < TextBlock
+    end
+
+    class Para < TextBlock
+    end
+
+    class Inscription < TextBlock
+    end
+
+    class ToolTip < TextBlock
+      def needs_repaint?
+        @needs_repaint || !value.to_s.empty?
+      end
+    end
+
+    class Link < TextBlock
+    end
+  end
+end

data/lib/cyberarm_engine/ui/elements/toggle_button.rb

@@ -1,67 +1,71 @@
-module CyberarmEngine
-  class Element
-    class ToggleButton < Button
-      attr_reader :toggled, :value
-
-      def initialize(options, block = nil)
-        if options.dig(:theme, :ToggleButton, :checkmark_image)
-          options[:theme][:ToggleButton][:image_width] ||= options[:theme][:TextBlock][:text_size]
-          super(get_image(options.dig(:theme, :ToggleButton, :checkmark_image)), options, block)
-        else
-          super(options[:checkmark], options, block)
-        end
-
-        @value = options[:checked] || false
-
-        if @value
-          @raw_text = @options[:checkmark]
-        else
-          @raw_text = ""
-        end
-      end
-
-      def clicked_left_mouse_button(_sender, _x, _y)
-        self.value = !@value
-
-        @block.call(self) if @block
-
-        :handled
-      end
-
-      def render
-        if @image
-          draw_image if @value
-        else
-          draw_text
-        end
-      end
-
-      def recalculate
-        super
-        return if @image
-
-        _width  = dimensional_size(@style.width,  :width)
-        _height = dimensional_size(@style.height, :height)
-
-        @width  = _width  || @text.textobject.text_width(@options[:checkmark])
-        @height = _height || @text.height
-
-        update_background
-      end
-
-      def value=(boolean)
-        @value = boolean
-
-        if boolean
-          @raw_text = @options[:checkmark]
-        else
-          @raw_text = ""
-        end
-
-        recalculate
-
-        publish(:changed, @value)
-      end
-    end
-  end
-end
+module CyberarmEngine
+  class Element
+    class ToggleButton < Button
+      attr_reader :toggled, :value
+
+      def initialize(options, block = nil)
+        if options.dig(:theme, :ToggleButton, :checkmark_image)
+          options[:theme][:ToggleButton][:image_width] ||= options[:theme][:TextBlock][:text_size]
+          super(get_image(options.dig(:theme, :ToggleButton, :checkmark_image)), options, block)
+        else
+          super(options[:checkmark], options, block)
+        end
+
+        @value = options[:checked] || false
+
+        if @value
+          @raw_text = @options[:checkmark]
+        else
+          @raw_text = ""
+        end
+      end
+
+      def clicked_left_mouse_button(_sender, _x, _y)
+        self.value = !@value
+
+        @block.call(self) if @block
+
+        :handled
+      end
+
+      def render
+        if @image
+          draw_image if @value
+        else
+          draw_text
+        end
+      end
+
+      def recalculate
+        super
+        return if @image
+
+        _width  = dimensional_size(@style.width,  :width)
+        _height = dimensional_size(@style.height, :height)
+
+        @width  = _width  || @text.textobject.text_width(@options[:checkmark])
+        @height = _height || @text.height
+
+        update_background
+      end
+
+      def value=(boolean)
+        old_value = self.value
+
+        @value = boolean
+
+        if boolean
+          @raw_text = @options[:checkmark]
+        else
+          @raw_text = ""
+        end
+
+        recalculate
+
+        publish(:changed, @value) if old_value != boolean
+
+        boolean
+      end
+    end
+  end
+end

data/lib/cyberarm_engine/ui/elements/widget.rb

@@ -0,0 +1,45 @@
+module CyberarmEngine
+  class Element
+    # Special container that has a layout like a Flow
+    # and makes all its children mirror its styling (i.e. hover, active, disabled...)
+    class Widget < Flow
+      def update_styles(style = :default)
+        super
+
+        @children.each do |child|
+          recursive_styles(style, self)
+        end
+      end
+
+      # Make child elements mirror the widgets styling
+      # disabled elements will not have their styling overridden
+      def recursive_styles(style, container)
+        container.children.each do |child|
+          child.update_styles(style)
+
+          recursive_styles(style, child) if child.is_a?(Container)
+        end
+      end
+
+      # Enable child elements to display their tooltips
+      # but fall back to the Widget if no hit element has a tip
+      def tip
+        parent_scroll_position = CyberarmEngine::Vector.new
+
+        element = self
+        while (parent_element = element.parent)
+          parent_scroll_position += parent_element.scroll_position
+
+          element = parent_element
+        end
+
+        elements = hit_element?(window.mouse_x - parent_scroll_position.x, window.mouse_y - parent_scroll_position.y)
+
+        return @tip unless elements
+
+        elements.delete(self) # prevent infinite recursive loop (Widget#tip)
+        elements.reverse.find { |e| !e.tip.empty? }&.tip || @tip
+      end
+    end
+  end
+end