gglib 1.1.0

data/lib/widget.rb

@@ -0,0 +1,206 @@
+module GGLib
+
+#The Widget class is an interface between the button class and the window class which allows for user interaction with an area of the screen. This area is referred to as the widget.
+#To make a Widget, simply create a class derived from Widget and override methods as needed:
+#
+# class MyWidget < Widget      #all widgets are subclasses of Widget
+#   attr_reader :text,:font    #most widgets will have text and font attributes
+#   def initialize(window,text)
+#     super(window,Button::Image,0,400,640,480,"img/gui/mywidget image.png",name="My Widget")       #use super to initialize the button
+#     @text=text; @font=Gosu::Font.new(window, "arial", 50)          #initialize widget specific variables
+#   end
+#   def draw                        #the window will call draw every time it executes GameWindow::draw
+#     font.draw(text,0,0)           #you do not have to draw the image here, Button class does that for you
+#     if clicked?                   #here you do widget specific things like drawing text,
+#       setImage(Gosu::Image.new)   #changing the picture on mouse over or click, etc
+#     end                                     
+#   end
+#   def onDelete        #onDelete is called when the window wants to delete the widget
+#     puts "deleted"    #execute widget specific code here
+#   end                 #or leave the function alone if there is no widget specific code
+# end
+#
+#See the `Widget Programmer's Handbook` for more info.
+
+class Widget < Tile
+  attr_reader :window, :name, :sleeping, :defimage, :buttonId, :id, :zfocus
+  attr_accessor :theme
+  def initialize(name="unnamed",x1=0,y1=0,x2=1,y2=1,theme=Theme::BlankTheme,acceptsticky=true,z=0) #do not modify
+    super(x1,y1,x2,y2)
+    @id=$window.newWidget(self)
+    @theme=theme.newInstance(self)
+    @name=name
+    @sleeping=false
+    @zfocus=z
+    @acceptstickyfocus=acceptsticky
+    onInitialize
+  end
+  def hasFocus? #do not modify
+    if $window.hasFocus == self
+      return true 
+    else
+      return false
+    end
+  end
+  def hasStickyFocus? #do not modify
+    if $window.hasStickyFocus == self
+      return true 
+    else
+      return false
+    end
+  end
+  def focus #do not modify
+    #debugger
+    $window.setFocus(@id) 
+    onMouseOver #focus is triggered by the onMouseOver event, so when the window gives a widget focus, it must preform the mouseover event 
+  end  
+  def blur #do not modify
+    onMouseOut #blur is triggered by the onMouseOut event, so when the window blurs a widget, it must preform the mouseout event
+  end
+  
+  def over?(x,y)
+    return iTile(x,y)      
+  end
+  def clicked?(x,y)
+    if $window.button_down?(Gosu::Button::MsLeft)
+      return xTile(x,y)
+    else
+      return false
+    end
+  end
+    
+  def event(type) #do not modify
+    if type==WidgetEvent::MsLeft
+      if @acceptstickyfocus
+        stickFocus
+      end
+      onClick
+    elsif type==WidgetEvent::MsRight
+      onRightClick
+    else
+      onKeyPress(type)
+    end
+  end
+  
+  def feedText(char)
+  end
+  def onClick
+  end
+  def onRightClick
+  end
+  def onDrag(x1, y1, x2, y2)
+  end
+  def onRightDrag(x1, y1, x2, y2)
+  end
+  def onMouseOver
+  end
+  def onStickyFocus
+  end
+  def onMouseOut 
+  end
+  def onStickyBlur
+  end
+  def onInitialize
+  end
+  def onDelete
+  end
+  def onKeyPress(key)
+  end
+  
+  def stickFocus
+    $window.setStickyFocus(self)
+  end
+  def unstickFocus
+    $window.setStickyFocus(nil)
+  end
+  
+  def intDraw
+    if not @sleeping
+      @theme.draw
+      draw
+    end
+  end
+  
+  def draw
+  end
+  
+  def sleep
+    if not @sleeping
+      if hasStickyFocus?
+        $window.setStickyFocus(nil)
+      end
+      @theme.setSleepState
+      @sleeping=true
+    end
+  end
+  def sleeping?
+    return @sleeping
+  end
+  def wakeUp
+    if @sleeping
+      @theme.setWakeState
+      @sleeping=false
+    end
+  end
+  
+  def button
+    return Button.getButton(buttonId)
+  end
+  
+  def del
+    onDelete
+    if $window.nil?
+      raise "Window assigned to nil" #Very strange bug. Should be dead by now. (This is just in case.)
+      return
+    end
+    $window.deleteWidget(self)
+    super
+  end
+end
+
+class WidgetEvent
+  MsLeft=0
+  MsRight=1
+  KeyUp=2
+  KeyDown=3
+  KeyLeft=4
+  KeyRight=5
+  KeyEscape=6
+  KeyEnter=7      
+  KeyAlt=8
+  KeyControl=9
+  KeyShift=10      
+  KeySpace=11
+  GpEnter=12
+  GpCancel=13
+  KeyText=14
+  KeyDelete=15
+  MsLeftDrag=16
+  MsRightDrag=17
+end
+
+WidgetTextCaps = {
+ ","=>"<",
+ "."=>">",
+ "/"=>"?",
+ "'"=>"\"",
+ ";"=>":",
+ "["=>"{",
+ "]"=>"}",
+ "\\"=>"|",
+ "="=>"+",
+ "-"=>"_",
+ "0"=>")",
+ "9"=>"(",
+ "8"=>"*",
+ "7"=>"&",
+ "6"=>"^",
+ "5"=>"%",
+ "4"=>"$",
+ "3"=>"#",
+ "2"=>"@",
+ "1"=>"!",
+ "`"=>"~"
+}
+
+end #module GGLib

data/lib/window.rb

@@ -0,0 +1,324 @@
+module GGLib
+
+#The GUIWindow class is the central hub of the program. It is utimately responsible for all input and output (exept for logging output). 
+#The main game loops can be found in this class.
+class GUIWindow < Gosu::Window
+  attr_accessor :cursor, :background_image, :camera, :state
+  attr_reader :images, :mapimages
+  
+  BlankState = StateObject.new
+  
+  def initialize(w=640, h=480, fullscreen=true, u=20, stateObj=BlankState)
+    super(w, h, fullscreen, u)
+    $window=self #pre initialize global var to allow win initialization
+    @background_image = Gosu::Image.new(self, File.expand_path(File.dirname(__FILE__))+"/null.png", true)
+    @cursor = Cursor.new(File.expand_path(File.dirname(__FILE__))+"/media/cursor.bmp", false)
+    @framedrawn=false
+    @timer=0
+    @camera=Camera.new
+    @images = CArray.new
+    @mapimages = CArray.new
+    @guiWidgets = CArray.new
+    @state=stateObj
+    @focused=nil
+    @stickfocused=nil
+    @leftdrag = MouseDragEvent.new
+    @rightdrag = MouseDragEvent.new
+    @state.start
+    $window=self
+    $theme_init_hook.call
+  end
+  
+  def state=(val)
+    @state.end
+    @state = val
+    @state.start
+  end
+  
+  def widgets
+    return @widgets
+  end
+  
+  def framedrawn
+    return @framedrawn
+  end
+  
+  def button_down(id)
+    @state.button_down(id)
+    checkFocus
+    widgetDownProc(id)
+  end
+  
+  def button_up(id)
+    @state.button_up(id)
+    checkFocus                       
+    widgetUpProc(id)
+  end
+  
+  def timer
+    return @timer
+  end
+  
+  def widgets
+    return @guiWidgets
+  end
+   
+  def newImage(x,y,z,src,hardBorders=true,tracer="None")
+    img=Image.new(x,y,z,src,hardBorders,tracer,@images.size)
+    return @images << img
+  end
+  
+  def newTexture(x1,y1,x2,y2,z,src,hardBorders=true,tracer="None")
+    img=Texture.new(x1,y1,x2,y2,z,src,hardBorders,tracer,@images.size)
+    return @images << img
+  end
+  
+  def setImage(index,x,y,z,src,hardBorders=true,tracer="None")
+    img=Image.new(x,y,z,src,@images.size,hardBorders,tracer)
+    @images[index]=img
+    return index
+  end
+  
+  def setTexture(index, x1,y1,x2,y2,z,src,hardBorders=true,tracer="None")
+    img=Texture.new(x1,y1,x2,y2,z,src,hardBorders,tracer,@images.size)
+    @images[index]=img
+    return index
+  end
+  
+  def deleteImage(no)
+    if @images[no]!=nil
+      @images[no].del
+    end
+      @images.delete_at(no)
+  end
+  
+  def deleteAllImages
+    @images.clear
+  end
+  
+  def setBackground(src)
+    @background_image = Gosu::Image.new(self,src,true)    
+  end
+  
+  def setMapBackground(src)
+    @map_image = Gosu::Image.new(self,src,true)    
+  end
+  
+  def newMapImage(x,y,z,src,hardBorders=true,tracer="None")
+    img=Image.new(x,y,z,src,hardBorders,tracer,@mapimages.size)
+    return @mapimages << img
+  end
+  
+  def deleteMapImage(no)
+    if @mapimages[no]!=nil
+      @mapimages[no].del
+    end
+      @mapimages.delete_at(no)
+  end
+  
+  def deleteAllMapImages
+    @mapimages.clear
+  end  
+  
+  def newWidget(widget)
+    return @guiWidgets << widget
+  end
+  
+  def deleteWidget(widget)
+    id=widget.id
+    @guiWidgets.delete_at(id)
+  end
+  
+  def deleteAllWidgets
+    @guiWidgets.each {|widget| widget.del}
+    @guiWidgets.clear
+    @focused=nil
+    @stickfocused=nil
+    self.text_input=nil
+  end
+  
+  def createWidgets
+    self.text_input=nil
+    @focused=nil
+    @stickfocused=nil
+  end
+  
+  def setTextInput(field)
+    self.text_input=field
+  end
+  
+  def setFocus(object)
+    if @focused!=nil and not @focused.sleeping? #dont blur the object if it is the window or if it is sleeping
+      @focused.blur
+    end
+    if object==nil
+      @focused=nil
+    else
+      @focused=@guiWidgets[object]
+    end
+  end
+  
+  def setStickyFocus(object)
+    if @stickfocused!=nil
+      @stickfocused.onStickyBlur
+    end
+    @stickfocused=object
+    if @stickfocused!=nil
+      @stickfocused.onStickyFocus
+    end
+  end
+  
+  def hasFocus
+    return @focused
+  end
+  
+  def hasStickyFocus
+    return @stickfocused
+  end
+  
+  def update
+    checkFocus
+    
+    if @leftdrag.starting
+      if(Gosu::distance(@leftdrag.start_x, @leftdrag.start_y, mouse_x, mouse_y) > 5)
+        @leftdrag.confirmStart
+      end
+    elsif @rightdrag.starting
+      if(Gosu::distance(@rightdrag.start_x, @rightdrag.start_y, mouse_x, mouse_y) > 5)
+        @rightdrag.confirmStart
+      end
+    end
+    
+    if @timer>100
+      @timer=0
+    else
+      @timer+=1
+    end
+    
+    @state.update
+    @framedrawn = false
+  end
+
+  def draw
+    @cursor.draw
+    @images.each {|img| img.draw}
+    @guiWidgets.each {|widget| widget.intDraw}
+    @background_image.draw(0, 0, ZOrder::Background)
+    @state.draw
+    @framedrawn=true
+  end
+  
+  private
+  def widgetDownProc(id)
+    char=button_id_to_char(id)
+    setStickyFocus(nil) if (id==Gosu::Button::MsLeft or id==Gosu::Button::MsRight) and @stickfocused!=nil #and not @stickfocused.contains?(mouse_x, mouse_y)
+    if @stickfocused!=nil and not @stickfocused.sleeping? #only sticky focused widgets recieve text input 
+      if id==Gosu::Button::MsLeft
+        @leftdrag.start
+      elsif id==Gosu::Button::MsRight
+        @rightdrag.start
+      elsif char!=nil
+        if button_down?(Gosu::Button::KbLeftShift) or button_down?(Gosu::Button::KbRightShift)
+          if char=~/[A-Z]/i
+            char=char.upcase!
+          else
+            capschar=WidgetTextCaps[char]
+            if capschar!=nil
+              char=capschar
+            end
+          end
+        end
+        @stickfocused.feedText(char)
+      end  
+    end
+  end
+  
+  def widgetUpProc(id)
+    char=button_id_to_char(id)
+    setStickyFocus(nil) if (id==Gosu::Button::MsLeft or id==Gosu::Button::MsRight) and @stickfocused!=nil #and not @stickfocused.contains?(mouse_x, mouse_y)
+    if @stickfocused!=nil and not @stickfocused.sleeping? #only sticky focused widgets recieve text input 
+      if id==Gosu::Button::MsLeft
+        if @leftdrag.inprogress
+          @leftdrag.end
+          @stickfocused.event(WidgetEvent::MsLeftDrag)          
+        else
+          @leftdrag.terminate
+          @stickfocused.event(WidgetEvent::MsLeft)
+        end
+      elsif id==Gosu::Button::MsRight
+        if @rightdrag.inprogress
+          @rightdrag.end
+          @stickfocused.event(WidgetEvent::MsRightDrag)                  
+        else
+          @rightdrag.terminate
+          @stickfocused.event(WidgetEvent::MsRight)
+        end
+      elsif id==Gosu::Button::KbUp or id==Gosu::Button::GpUp
+        @stickfocused.event(WidgetEvent::KeyUp)
+      elsif id==Gosu::Button::KbDown or id==Gosu::Button::GpDown
+        @stickfocused.event(WidgetEvent::KeyDown)
+      elsif id==Gosu::Button::KbLeft or id==Gosu::Button::GpLeft
+        @stickfocused.event(WidgetEvent::KeyLeft)
+      elsif id==Gosu::Button::KbRight or id==Gosu::Button::GpRight
+        @stickfocused.event(WidgetEvent::KeyRight)
+      elsif id==Gosu::Button::KbRight or id==Gosu::Button::GpRight
+        @stickfocused.event(WidgetEvent::KeyRight)
+      elsif id==Gosu::Button::KbBackspace or id==Gosu::Button::KbDelete
+        @stickfocused.event(WidgetEvent::KeyDelete)   
+      elsif id==Gosu::Button::KbEscape or id==Gosu::Button::GpButton7
+        @stickfocused.event(WidgetEvent::KeyEscape)     
+      elsif id==Gosu::Button::KbEnter or id==Gosu::Button::GpButton2 or id==28 #strange Gosu bug, KbEnter!=Enter code
+        @stickfocused.event(WidgetEvent::KeyEnter)
+      elsif id==Gosu::Button::KbLeftAlt or id==Gosu::Button::KbRightAlt or id==Gosu::Button::GpButton5
+        @stickfocused.event(WidgetEvent::KeyAlt)
+      elsif id==Gosu::Button::KbLeftControl or id==Gosu::Button::KbRightControl or id==Gosu::Button::GpButton3
+        @stickfocused.event(WidgetEvent::KeyControl)
+      elsif id==Gosu::Button::KbLeftShift or id==Gosu::Button::KbRightShift or id==Gosu::Button::GpButton6
+        @stickfocused.event(WidgetEvent::KeyShift)      
+      elsif id==Gosu::Button::KbSpace or id==Gosu::Button::KbSpace or id==Gosu::Button::GpButton4
+        @stickfocused.event(WidgetEvent::KeySpace)
+      elsif id==Gosu::Button::GpButton0
+        @stickfocused.event(WidgetEvent::GpEnter)
+      elsif id==Gosu::Button::GpButton1
+        @stickfocused.event(WidgetEvent::GpCancel)        
+      end
+    end
+    if @focused!=nil and not @focused.sleeping? and (@stickfocused==nil or @focused.id != @stickfocused.id) #normally focused widgets only recieve click input 
+      if id==Gosu::Button::MsLeft
+        @focused.event(WidgetEvent::MsLeft)
+      elsif id==Gosu::Button::MsRight
+        @focused.event(WidgetEvent::MsRight)
+      elsif id==Gosu::Button::GpButton0
+        @focused.event(WidgetEvent::GpEnter)
+      end
+    end
+  end
+  
+  def checkFocus
+    if @focused==nil
+      oldfocus=nil
+    else
+      oldfocus=@focused.id      
+    end
+    newfocus=nil
+    focusFlag=false
+    @guiWidgets.each { |widget|
+      if (@cursor.visible and widget.over?(mouse_x,mouse_y)) and not widget.sleeping?
+        if not focusFlag
+          newfocus=widget.id
+          focusFlag=true
+        elsif widget.zfocus >= @guiWidgets[newfocus].zfocus #give focus to the widget with the highest focus zorder, or in the event of a tie, give focus to the new object
+          newfocus=widget.id
+        end
+      else
+      end
+    }
+    if newfocus!=nil and newfocus!=oldfocus
+      @guiWidgets[newfocus].focus
+    elsif newfocus==nil and oldfocus!=nil
+      setFocus(nil)
+    end
+  end
+end
+
+end #module GGLib