Storing User Input In Global Types

[kevin]

 Storing User Input In Global Types

 
  For things like gathering user input, I tend to avoid polling the mouse() and keystates through out the program.  As not only can they be surprisingly  time consuming, but it solves a common logic problem where the user can select multiple things during one refresh. Which occurs because the mouse may have moved between calls.  

 Preferring to grab the key & mouse states (X,Y,BUTTONS) into a type at the start of each refresh.

PlayBASIC Code: [Select]

 // declaration code
 Type tMouseState
      x,y         ; current position
      oldx,oldy         ; current position
      button
      oldbutton
 EndType

 Type tKeyBoardState
      somekey
 EndType

 Type tInputDevices
      Mouse as tMouseState
      KeyBoard as tKeyBoardState
 EndType

 // Store in a global type, protecting us from typos
 Dim Input as tInputDevices
 

   Build_Random_Rects()

  // main loop
  do
  
        cls 
    
       // Collect the state of the input devices 
       
       // Get the mouse state
       Input.Mouse.oldx         =Input.Mouse.x
       Input.Mouse.oldy         =Input.Mouse.y
       Input.Mouse.oldbutton   =Input.Mouse.Button
       Input.Mouse.x            =MouseX()
       Input.Mouse.y            =MouseY()
       Input.Mouse.button      =MouseButton()

    // Call the game stuff
      DoGameStuff()
    
    sync
  loop



   


function DoGameStuff()

  if Input.mouse.button
     print "Fire"
    // flush the state
    Input.mouse.button=0
  endif

endfunction

Demo of the moving mouse logical problem.

PlayBASIC Code: [Select]

   setfps 61.7

   Do
      cls 
   
       Draw_Grid_With_Selection()
   
      Sync
   loop


Function Draw_Grid_With_Selection()


   blockwidth=64
   blockheight=64

   Dim COlours(1)
   COlours(0)=$223344
   COlours(1)=$443321


   For ylp=0 to 600 step blockheight

      ThisColour=RowColour
      For xlp=0 to 800 step blockwidth
   
         x1=xlp
         y1=ylp
         x2=xlp+BlockWidth-1
         y2=ylp+BlockHeight-1
         boxc x1,y1,x2,y2,true,COlours(ThisCOlour)
         
         mx=mousex()
         my=mousey()

         if PointInBox(mx,my,x1,y1,x2,y2)
            MouseOverBlock++         
            boxc x1,y1,x2,y2,false,$ffffff

         endif         

         ThisColour=(ThisColour+1) and 1
      next
      RowColour=(RowColour+1) and 1

   next

   text 10,10,   MouseOverBlock         

   if MouseOverBlock>1
      text 10,30,"Possible logic error - Mouse over more than 1 block"
      Sync
      waitkey
   endif



EndFunction

 You'll have to waggle the mouse around a bit to trip the situation, but it does occur.

 The solution is easy, we just don't poll the mouses current position constantly within the selection routine.  

 eg.

PlayBASIC Code: [Select]

   setfps 61.7

   Do
      cls 

         mx=mousex()
         my=mousey()

   
       Draw_Grid_With_Selection(mx,my)
   
      Sync
   loop


Function Draw_Grid_With_Selection(mx,my)


   blockwidth=64
   blockheight=64

   Dim COlours(1)
   COlours(0)=$223344
   COlours(1)=$443321


   For ylp=0 to 600 step blockheight

      ThisColour=RowColour
      For xlp=0 to 800 step blockwidth
   
         x1=xlp
         y1=ylp
         x2=xlp+BlockWidth-1
         y2=ylp+BlockHeight-1
         boxc x1,y1,x2,y2,true,COlours(ThisCOlour)
         

         if PointInBox(mx,my,x1,y1,x2,y2)
            MouseOverBlock++         

            boxc x1,y1,x2,y2,false,$ffffff
            
         endif         

         ThisColour=(ThisColour+1) and 1
      next
      RowColour=(RowColour+1) and 1

   next

   text 10,10,   MouseOverBlock         

   if MouseOverBlock>1
      text 10,30,"Possible logic error - Mouse over more than 1 block"
      Sync
      waitkey
   endif

EndFunction

Related Examples:

   * Toggle The  Mouse Pointer Off When It's Not Moving
   * Check If a point is inside a box/rect region (Manual PointInBox)
   * Drag Rectangles/ GUI Selection
   * Action GUI
   *    Infinite Mouse Control

 

[kevin]

  Buffer Mouse Button with Auto Repeat

      This little function buffers the mouse button state with auto repeat.  So the function only returns the button state once, rather than it's actual up/down state.   If the user holds the button down for a long periods it'll fire pulses until it's released.  

PlayBASIC Code: [Select]

   Setfps 60

   Do
      Cls 0
      
         if ReadMouseButton()
            print "Pressed Button"
         endif

      Sync
   loop


psub ReadMouseButton()

      CurrentTime=Timer()

         Button=0

         MB=MouseButton()
      
         if RawButtonState<>MB
         
            RawButtonState=MB
            
            if RawButtonState and 1
               Button|=1
               RawButtonNextRepeatTime=CurrentTime+800
            endif

         else
         
            if RawButtonState and 1
               if CurrentTime=>RawButtonNextRepeatTime
                  Button|=1
                  RawButtonNextRepeatTime=CurrentTime+250   
               endif
            else
               RawButtonNextRepeatTime=0
            endif
               
         endif      


EndPsub Button

[kevin]

   Get Mouse Moved Function


  This function reads the amount of the movement of the mouse across both the X / Y axis.   The routine wraps the real mouses coordinate within the PB window.  So when in the demo the user can move a circle around without it being attached to the mouse.   Which is handy for making mouse controlled games in a window, since the default behavior is to ignore mouse input when the mouse leaves the apps window

PlayBASIC Code: [Select]

   x#=400
   y#=300


   Do
      Cls 
      
      
         mmx#,mmy#=GetMouseMoved()
   
         x#+=mmx#
         y#+=mmy#

         x#=cliprange(X#,0,800)
         y#=cliprange(y#,0,600)

         circle x#,y#,50,false
         
         
   
   
      Sync
   loop




Psub GetMouseMoved()

         W=GetScreenWidth()
         H=GetScreenHeight()
         
         x1=GetScreenXpos()         
         Y1=GetScreenYpos()         
         x2=x1+w
         y2=y1+h         
            
         MMX#=MouseMoveX()
         MMY#=MouseMoveY()
         
         x#=x1+MouseX()         
         y#=y1+MouseY()         
         
         flag=0                  
         If x#=<(x1+75) Then x#=x1+(w/2): flag=1
         If x#=>(x2-75) And flag=0 Then x#=x1+(w/2): flag=1

         If y#=<(y1+75) Then y#=y1+(h/2): flag=1
         If y#=>(y2-75) Then y#=y1+(h/2): flag=1
         
         
         If flag=1 
                SetMouse x#,y# 
                 MMX2#=MouseMoveX()
                MMY2#=MouseMoveY()
               SetMouse x#,y#      
         EndIf
EndPsub mmx#,mmy#