cyberarm_engine 0.25.0 → 0.30.0

data/lib/cyberarm_engine/ui/gui_state.rb

@@ -1,326 +1,402 @@
-module CyberarmEngine
-  class GuiState < GameState
-    include Common
-    include DSL
-
-    def initialize(options = {})
-      @options = options
-      @game_objects = []
-      @global_pause = false
-
-      @down_keys = {}
-
-      @root_container = Element::Stack.new(gui_state: self)
-      @game_objects << @root_container
-      CyberarmEngine::Element::Container.current_container = @root_container
-
-      @active_width  = window.width
-      @active_height = window.height
-
-      @menu = nil
-      @focus = nil
-      @mouse_over = nil
-      @mouse_down_on = {}
-      @mouse_down_position = {}
-      @last_mouse_pos = nil
-      @dragging_element = nil
-      @pending_recalculate_request = false
-      @pending_element_recalculate_requests = []
-
-      @needs_repaint = false
-
-      @menu = nil
-      @min_drag_distance = 0
-      @mouse_pos = Vector.new
-    end
-
-    def post_setup
-      @tip = Element::ToolTip.new("", parent: @root_container, z: Float::INFINITY, theme: current_theme)
-    end
-
-    def menu
-      @menu
-    end
-
-    # throws :blur event to focused element and sets GuiState focused element
-    # Does NOT throw :focus event at element or set element as focused
-    def focus=(element)
-      @focus.publish(:blur) if @focus && element && @focus != element
-      @focus = element
-    end
-
-    def focused
-      @focus
-    end
-
-    def draw
-      # t = Gosu.milliseconds
-      # report_recalculate_time = @pending_recalculate_request || @pending_element_recalculate_requests.size.positive?
-
-      StackProf.start(mode: :wall) if RUBY_ENGINE != "mruby" && defined?(StackProf)
-      Stats.frame.start_timing(:gui_element_recalculate_requests)
-
-      # puts "PENDING REQUESTS: #{@pending_element_recalculate_requests.size}" if @pending_element_recalculate_requests.size.positive?
-      @pending_element_recalculate_requests.shift(&:recalculate)
-
-      Stats.frame.end_timing(:gui_element_recalculate_requests)
-
-      Stats.frame.start_timing(:gui_recalculate)
-
-      while(@pending_recalculate_request)
-        @pending_recalculate_request = false
-
-        @root_container.recalculate
-      end
-
-      StackProf.stop if RUBY_ENGINE != "mruby" && defined?(StackProf)
-      Stats.frame.end_timing(:gui_recalculate)
-      # puts "TOOK: #{Gosu.milliseconds - t}ms to recalculate #{self.class}:0x#{object_id.to_s(16)}" if report_recalculate_time && Gosu.milliseconds - t > 0
-
-      super
-
-      if @menu
-        Gosu.flush
-        @menu.draw
-      end
-
-      if @tip && @tip.value.length.positive?
-        Gosu.flush
-
-        @tip.draw
-      end
-
-      if CyberarmEngine.const_defined?("GUI_DEBUG")
-        Gosu.flush
-
-        @root_container.debug_draw
-      end
-
-      @needs_repaint = false
-    end
-
-    def needs_repaint?
-      @needs_repaint
-    end
-
-    def update
-      if @pending_focus_request
-        @pending_focus_request = false
-
-        self.focus = @pending_focus_element
-        @pending_focus_element.publish(:focus)
-      end
-
-      @menu&.update
-
-      super
-
-      if @active_width != window.width || @active_height != window.height
-        request_recalculate
-        @root_container.publish(:window_size_changed)
-      end
-
-      @active_width  = window.width
-      @active_height = window.height
-
-      return unless window.has_focus?
-      return unless window.current_state == self
-
-      new_mouse_over = @menu.hit_element?(window.mouse_x, window.mouse_y) if @menu
-      new_mouse_over ||= @root_container.hit_element?(window.mouse_x, window.mouse_y)
-
-      if new_mouse_over
-        new_mouse_over.publish(:enter) if new_mouse_over != @mouse_over
-        new_mouse_over.publish(:hover)
-        # puts "#{new_mouse_over.class}[#{new_mouse_over.value}]: #{new_mouse_over.x}:#{new_mouse_over.y} #{new_mouse_over.width}:#{new_mouse_over.height}" if new_mouse_over != @mouse_over
-      end
-      @mouse_over.publish(:leave) if @mouse_over && new_mouse_over != @mouse_over
-      @mouse_over = new_mouse_over
-
-      redirect_holding_mouse_button(:left) if @mouse_over && Gosu.button_down?(Gosu::MS_LEFT)
-      redirect_holding_mouse_button(:middle) if @mouse_over && Gosu.button_down?(Gosu::MS_MIDDLE)
-      redirect_holding_mouse_button(:right) if @mouse_over && Gosu.button_down?(Gosu::MS_RIGHT)
-
-      if Vector.new(window.mouse_x, window.mouse_y) == @last_mouse_pos
-        if @mouse_over && (Gosu.milliseconds - @mouse_moved_at) > tool_tip_delay
-          @tip.value = @mouse_over.tip if @mouse_over
-          @tip.x = window.mouse_x
-          @tip.x = 0 if @tip.x < 0
-          @tip.x = window.width - @tip.width if @tip.x + @tip.width > window.width
-          @tip.y = window.mouse_y - (@tip.height + 5)
-          @tip.y = 0 if @tip.y < 0
-          @tip.y = window.height - @tip.height if @tip.y + @tip.height > window.height
-          @tip.update
-          @tip.recalculate
-        else
-          @tip.value = ""
-        end
-      else
-        @mouse_moved_at = Gosu.milliseconds
-      end
-
-      @last_mouse_pos = Vector.new(window.mouse_x, window.mouse_y)
-      @mouse_pos = @last_mouse_pos.clone
-    end
-
-    def button_down(id)
-      super
-
-      case id
-      when Gosu::MS_LEFT
-        redirect_mouse_button(:left)
-      when Gosu::MS_MIDDLE
-        redirect_mouse_button(:middle)
-      when Gosu::MS_RIGHT
-        redirect_mouse_button(:right)
-      when Gosu::KB_F5
-        request_recalculate
-      end
-
-      @focus.button_down(id) if @focus.respond_to?(:button_down)
-    end
-
-    def button_up(id)
-      super
-
-      case id
-      when Gosu::MS_LEFT
-        redirect_released_mouse_button(:left)
-      when Gosu::MS_MIDDLE
-        redirect_released_mouse_button(:middle)
-      when Gosu::MS_RIGHT
-        redirect_released_mouse_button(:right)
-      when Gosu::MS_WHEEL_UP
-        redirect_mouse_wheel(:up)
-      when Gosu::MS_WHEEL_DOWN
-        redirect_mouse_wheel(:down)
-      when Gosu::KB_HOME
-        redirect_scroll_jump_to(:top)
-      when Gosu::KB_END
-        redirect_scroll_jump_to(:end)
-      when Gosu::KB_PAGE_UP
-        redirect_scroll_page(:up)
-      when Gosu::KB_PAGE_DOWN
-        redirect_scroll_page(:down)
-      end
-
-      @focus.button_up(id) if @focus.respond_to?(:button_up)
-
-      # Prevents menu from popping back up if the listbox is clicked to hide it.
-      @hid_menu_for = nil
-    end
-
-    def tool_tip_delay
-      @tip.style.delay || 250 # ms
-    end
-
-    def redirect_mouse_button(button)
-      hide_menu unless @menu && (@menu == @mouse_over) || (@mouse_over&.parent == @menu)
-
-      if @focus && @mouse_over != @focus
-        @focus.publish(:blur)
-        @focus = nil
-      end
-
-      if @mouse_over && @hid_menu_for != @mouse_over
-        @mouse_down_position[button] = Vector.new(window.mouse_x, window.mouse_y)
-        @mouse_down_on[button]       = @mouse_over
-
-        @mouse_over.publish(:"#{button}_mouse_button", window.mouse_x, window.mouse_y)
-      else
-        @mouse_down_position[button] = nil
-        @mouse_down_on[button]       = nil
-      end
-    end
-
-    def redirect_released_mouse_button(button)
-      hide_menu if @menu && (@menu == @mouse_over) || (@mouse_over&.parent == @menu)
-
-      if @mouse_over && @hid_menu_for != @mouse_over
-        @mouse_over.publish(:"released_#{button}_mouse_button", window.mouse_x, window.mouse_y)
-        if @mouse_over == @mouse_down_on[button]
-          @mouse_over.publish(:"clicked_#{button}_mouse_button", window.mouse_x,
-                              window.mouse_y)
-        end
-      end
-
-      if @dragging_element
-        @dragging_element.publish(:end_drag, window.mouse_x, window.mouse_y, button)
-        @dragging_element = nil
-      end
-
-      @mouse_down_position[button] = nil
-      @mouse_down_on[button]       = nil
-    end
-
-    def redirect_holding_mouse_button(button)
-      if !@dragging_element && @mouse_down_on[button] && @mouse_down_on[button].draggable?(button) && @mouse_pos.distance(@mouse_down_position[button]) > @min_drag_distance
-        @dragging_element = @mouse_down_on[button]
-        @dragging_element.publish(:begin_drag, window.mouse_x, window.mouse_y, button)
-      end
-
-      if @dragging_element
-        @dragging_element.publish(:drag_update, window.mouse_x, window.mouse_y, button) if @dragging_element
-      elsif @mouse_over
-        @mouse_over.publish(:"holding_#{button}_mouse_button", window.mouse_x, window.mouse_y)
-      end
-    end
-
-    def redirect_mouse_wheel(button)
-      @mouse_over.publish(:"mouse_wheel_#{button}", window.mouse_x, window.mouse_y) if (@mouse_over && !@menu) || (@mouse_over && @mouse_over == @menu)
-    end
-
-    def redirect_scroll_jump_to(edge)
-      @mouse_over.publish(:"scroll_jump_to_#{edge}", window.mouse_x, window.mouse_y) if (@mouse_over && !@menu) || (@mouse_over && @mouse_over == @menu)
-    end
-
-    def redirect_scroll_page(edge)
-      @mouse_over.publish(:"scroll_page_#{edge}", window.mouse_x, window.mouse_y) if (@mouse_over && !@menu) || (@mouse_over && @mouse_over == @menu)
-    end
-
-    # Schedule a full GUI recalculation on next update
-    def request_recalculate
-      @pending_recalculate_request = true
-    end
-
-    def request_recalculate_for(element)
-      # element is already queued
-      return if @pending_element_recalculate_requests.detect { |e| e == element }
-
-      @pending_element_recalculate_requests << element
-    end
-
-    def request_focus(element)
-      @pending_focus_request = true
-      @pending_focus_element = element
-    end
-
-    def request_repaint
-      # puts caller[0..4]
-      # puts
-      @needs_repaint = true
-    end
-
-    def show_menu(list_box)
-      @menu = list_box
-    end
-
-    def hide_menu
-      return unless @menu
-
-      request_repaint
-
-      @hid_menu_for = @menu.parent
-      @menu = nil
-    end
-
-    def to_s
-      # "#{self.class} children=#{@children.map { |c| c.to_s }}"
-      @root_container.to_s
-    end
-
-    def inspect
-      to_s
-    end
-  end
-end
+module CyberarmEngine
+  class GuiState < GameState
+    include Common
+    include DSL
+
+    def initialize(options = {})
+      @options = options
+      @game_objects = []
+      @timers = []
+      @global_pause = false
+
+      @down_keys = {}
+
+      @root_container = Element::Stack.new(gui_state: self)
+      @game_objects << @root_container
+      CyberarmEngine::Element::Container.current_container = @root_container
+
+      @active_width  = window.width
+      @active_height = window.height
+
+      @pages = {}
+      @page_host = nil
+      @page = nil
+
+      @menu = nil
+      @focus = nil
+      @mouse_over = nil
+      @mouse_down_on = {}
+      @mouse_down_position = {}
+      @last_mouse_pos = nil
+      @dragging_element = nil
+      @pending_recalculate_request = false
+      @pending_element_recalculate_requests = []
+      @hit_elements = []
+
+      @needs_repaint = false
+
+      @menu = nil
+      @min_drag_distance = 0
+      @mouse_pos = Vector.new
+    end
+
+    def post_setup
+      @tip = Element::ToolTip.new("", parent: @root_container, z: Float::INFINITY, theme: current_theme)
+    end
+
+    def active_menu
+      @menu
+    end
+
+    def page(klass, options = {})
+      @page&.blur
+
+      @pages[klass] = klass.new(parent: options[:parent] || self) unless @pages[klass]
+      @page = @pages[klass]
+
+      @page.options = options
+      page_host.clear do
+        @page.setup
+      end
+      @page.focus
+    end
+
+    def current_page
+      @page
+    end
+
+    def page_host
+      return @page.parent if @page.parent.is_a?(CyberarmEngine::Element::Container)
+      return @page_host if @page_host && @page_host.is_a?(CyberarmEngine::Element::Container)
+
+      @root_container
+    end
+
+    def page_host=(container)
+      raise "page host must be a CyberarmEngine::Element::Container" unless container.is_a?(Container)
+
+      @page_host = container
+    end
+
+    # throws :blur event to focused element and sets GuiState focused element
+    # Does NOT throw :focus event at element or set element as focused
+    def focus=(element)
+      @focus.publish(:blur) if @focus && element && @focus != element
+      @hit_elements.delete(@focus)
+      @focus = element
+    end
+
+    def focused
+      @focus
+    end
+
+    def draw
+      # t = Gosu.milliseconds
+      # report_recalculate_time = @pending_recalculate_request || @pending_element_recalculate_requests.size.positive?
+
+      StackProf.start(mode: :wall) if RUBY_ENGINE != "mruby" && defined?(StackProf)
+      Stats.frame.start_timing(:gui_element_recalculate_requests)
+
+      # puts "PENDING REQUESTS: #{@pending_element_recalculate_requests.size}" if @pending_element_recalculate_requests.size.positive?
+      while (e = @pending_element_recalculate_requests.shift)
+        # its pointless to recalculate individual elements when we've been asked to recalculate the whole gui
+        if @pending_recalculate_request
+          @pending_element_recalculate_requests.clear
+          break
+        end
+
+        e.recalculate
+      end
+
+      Stats.frame.end_timing(:gui_element_recalculate_requests)
+
+      Stats.frame.start_timing(:gui_recalculate)
+
+      while(@pending_recalculate_request)
+        @pending_recalculate_request = false
+
+        @root_container.recalculate
+      end
+
+      StackProf.stop if RUBY_ENGINE != "mruby" && defined?(StackProf)
+      Stats.frame.end_timing(:gui_recalculate)
+      # puts "TOOK: #{Gosu.milliseconds - t}ms to recalculate #{self.class}:0x#{object_id.to_s(16)}" if report_recalculate_time && Gosu.milliseconds - t > 0
+
+      super
+
+      if @menu
+        Gosu.flush
+        @menu.draw
+      end
+
+      if @tip && @tip.value.length.positive?
+        Gosu.flush
+
+        @tip.draw
+      end
+
+      if CyberarmEngine.const_defined?("GUI_DEBUG")
+        Gosu.flush
+
+        @root_container.debug_draw
+      end
+
+      @needs_repaint = false
+
+      @page&.draw
+    end
+
+    def needs_repaint?
+      @needs_repaint
+    end
+
+    def update
+      if @pending_focus_request
+        @pending_focus_request = false
+
+        self.focus = @pending_focus_element
+        @pending_focus_element.publish(:focus)
+      end
+
+      @menu&.update
+
+      super
+
+      if @active_width != window.width || @active_height != window.height
+        request_recalculate
+        @root_container.publish(:window_size_changed)
+      end
+
+      @active_width  = window.width
+      @active_height = window.height
+
+      return unless window.has_focus?
+      return unless window.current_state == self
+
+      # list of containers decending down to hit element
+      new_hit_elements = (@menu || @root_container).hit_element?(window.mouse_x, window.mouse_y)
+      # element the mouse is over, if any.
+      new_mouse_over = new_hit_elements&.find { |c| c.is_a?(CyberarmEngine::Element::Widget) } || new_hit_elements&.last
+
+      # is the currently hit element the same as last hit element?
+      same_element = @mouse_over && new_mouse_over == @mouse_over
+
+      unless @hit_elements == new_hit_elements
+        added_hit_elements = (new_hit_elements || []) - @hit_elements
+        removed_hit_elements = @hit_elements - (new_hit_elements || [])
+
+        added_hit_elements.each do |e|
+          e.publish(:enter)
+          e.publish(:hover)
+        end
+
+        removed_hit_elements.each do |e|
+          e.publish(:leave)
+        end
+      end
+
+      @mouse_over = new_mouse_over
+      @hit_elements = new_hit_elements || []
+
+      redirect_holding_mouse_button(:left) if @mouse_over && Gosu.button_down?(Gosu::MS_LEFT)
+      redirect_holding_mouse_button(:middle) if @mouse_over && Gosu.button_down?(Gosu::MS_MIDDLE)
+      redirect_holding_mouse_button(:right) if @mouse_over && Gosu.button_down?(Gosu::MS_RIGHT)
+
+      # handle tooltip
+      if same_element
+        if @mouse_over && (Gosu.milliseconds - @mouse_moved_at) > tool_tip_delay
+          @tip.value = @mouse_over.tip if @mouse_over
+          @tip.x = window.mouse_x
+          @tip.x = 0 if @tip.x < 0
+          @tip.x = window.width - @tip.width if @tip.x + @tip.width > window.width
+          @tip.y = window.mouse_y - (@tip.height + 5)
+          @tip.y = 0 if @tip.y < 0
+          @tip.y = window.height - @tip.height if @tip.y + @tip.height > window.height
+          @tip.update
+          @tip.recalculate
+        else
+          @tip.value = ""
+        end
+      else
+        @mouse_moved_at = Gosu.milliseconds
+      end
+
+      @last_mouse_pos = Vector.new(window.mouse_x, window.mouse_y)
+      @mouse_pos = @last_mouse_pos.clone
+
+      @page&.update
+    end
+
+    def button_down(id)
+      super
+
+      case id
+      when Gosu::MS_LEFT
+        redirect_mouse_button(:left)
+      when Gosu::MS_MIDDLE
+        redirect_mouse_button(:middle)
+      when Gosu::MS_RIGHT
+        redirect_mouse_button(:right)
+      when Gosu::KB_F5
+        request_recalculate
+      when Gosu::KB_F12
+        CyberarmEngine.const_set(:GUI_DEBUG, !CyberarmEngine::GUI_DEBUG)
+        request_repaint
+      end
+
+      @focus.button_down(id) if @focus.respond_to?(:button_down)
+
+      @page&.button_down(id)
+    end
+
+    def button_up(id)
+      super
+
+      case id
+      when Gosu::MS_LEFT
+        redirect_released_mouse_button(:left)
+      when Gosu::MS_MIDDLE
+        redirect_released_mouse_button(:middle)
+      when Gosu::MS_RIGHT
+        redirect_released_mouse_button(:right)
+      when Gosu::MS_WHEEL_UP
+        redirect_mouse_wheel(:up)
+      when Gosu::MS_WHEEL_DOWN
+        redirect_mouse_wheel(:down)
+      when Gosu::KB_HOME
+        redirect_scroll_jump_to(:top)
+      when Gosu::KB_END
+        redirect_scroll_jump_to(:end)
+      when Gosu::KB_PAGE_UP
+        redirect_scroll_page(:up)
+      when Gosu::KB_PAGE_DOWN
+        redirect_scroll_page(:down)
+      end
+
+      @focus.button_up(id) if @focus.respond_to?(:button_up)
+
+      # Prevents menu from popping back up if the listbox is clicked to hide it.
+      @hid_menu_for = nil
+
+      @page&.button_up(id)
+    end
+
+    def tool_tip_delay
+      @tip.style.delay || 250 # ms
+    end
+
+    def redirect_mouse_button(button)
+      hide_menu unless @menu && (@menu == @mouse_over) || (@mouse_over&.parent == @menu)
+
+      if @focus && @mouse_over != @focus
+        @hit_elements.delete(@focus)
+        @focus.publish(:blur)
+        @focus = nil
+      end
+
+      if @mouse_over && @hid_menu_for != @mouse_over
+        @mouse_down_position[button] = Vector.new(window.mouse_x, window.mouse_y)
+        @mouse_down_on[button]       = @mouse_over
+
+        @mouse_over.publish(:"#{button}_mouse_button", window.mouse_x, window.mouse_y)
+      else
+        @mouse_down_position[button] = nil
+        @mouse_down_on[button]       = nil
+      end
+    end
+
+    def redirect_released_mouse_button(button)
+      hide_menu if @menu && (@menu == @mouse_over) || (@mouse_over&.parent == @menu)
+
+      if @mouse_over && @hid_menu_for != @mouse_over
+        @mouse_over.publish(:"released_#{button}_mouse_button", window.mouse_x, window.mouse_y)
+        if @mouse_over == @mouse_down_on[button]
+          @mouse_over.publish(:"clicked_#{button}_mouse_button", window.mouse_x,
+                              window.mouse_y)
+        end
+      end
+
+      if @dragging_element
+        @dragging_element.publish(:end_drag, window.mouse_x, window.mouse_y, button)
+        @dragging_element = nil
+      end
+
+      @mouse_down_position[button] = nil
+      @mouse_down_on[button]       = nil
+    end
+
+    def redirect_holding_mouse_button(button)
+      if !@dragging_element && @mouse_down_on[button] && @mouse_down_on[button].draggable?(button) && @mouse_pos.distance(@mouse_down_position[button]) > @min_drag_distance
+        @dragging_element = @mouse_down_on[button]
+        @dragging_element.publish(:begin_drag, window.mouse_x, window.mouse_y, button)
+      end
+
+      if @dragging_element
+        @dragging_element.publish(:drag_update, window.mouse_x, window.mouse_y, button) if @dragging_element
+      elsif @mouse_over
+        @mouse_over.publish(:"holding_#{button}_mouse_button", window.mouse_x, window.mouse_y)
+      end
+    end
+
+    def redirect_mouse_wheel(button)
+      @mouse_over.publish(:"mouse_wheel_#{button}", window.mouse_x, window.mouse_y) if (@mouse_over && !@menu) || (@mouse_over && @mouse_over == @menu)
+    end
+
+    def redirect_scroll_jump_to(edge)
+      return if window.text_input
+
+      @mouse_over.publish(:"scroll_jump_to_#{edge}", window.mouse_x, window.mouse_y) if (@mouse_over && !@menu) || (@mouse_over && @mouse_over == @menu)
+    end
+
+    def redirect_scroll_page(edge)
+      return if window.text_input
+
+      @mouse_over.publish(:"scroll_page_#{edge}", window.mouse_x, window.mouse_y) if (@mouse_over && !@menu) || (@mouse_over && @mouse_over == @menu)
+    end
+
+    # Schedule a full GUI recalculation on next update
+    def request_recalculate
+      @pending_recalculate_request = true
+    end
+
+    def request_recalculate_for(element)
+      # element is already queued
+      return if @pending_element_recalculate_requests.detect { |e| e == element }
+
+      @pending_element_recalculate_requests << element
+    end
+
+    def request_focus(element)
+      @pending_focus_request = true
+      @pending_focus_element = element
+    end
+
+    def request_repaint
+      # puts caller[0..4]
+      # puts
+      @needs_repaint = true
+    end
+
+    def show_menu(list_box)
+      @menu = list_box
+    end
+
+    def hide_menu
+      return unless @menu
+
+      request_repaint
+
+      @hid_menu_for = @menu.parent
+      @menu = nil
+    end
+
+    def to_s
+      # "#{self.class} children=#{@children.map { |c| c.to_s }}"
+      @root_container.to_s
+    end
+
+    def inspect
+      to_s
+    end
+  end
+end