Changeset 7928 for code/branches/usability

Timestamp:

Feb 20, 2011, 12:42:28 PM (13 years ago)

Author:

landauf

Message:

more improvements for keyboard control of menus:

• added setSelectionNear(r, c) function which tries to select the button closest to the given row/column
• no initialization required anymore, the button-table grows dynamically if new buttons are inserted

Location:

code/branches/usability/data/gui/scripts

Files:

• AudioMenu.lua (modified) (1 diff)
• ControlsMenu.lua (modified) (1 diff)
• CreditsMenu.lua (modified) (1 diff)
• DecisionPopup.lua (modified) (1 diff)
• GUISheet.lua (modified) (9 diffs)
• GraphicsMenu.lua (modified) (1 diff)
• HostMenu.lua (modified) (1 diff)
• InGameMenu.lua (modified) (1 diff)
• KeyBindMenu.lua (modified) (1 diff)
• MainMenu.lua (modified) (1 diff)
• MiscConfigMenu.lua (modified) (1 diff)
• MouseControlsMenu.lua (modified) (1 diff)
• MultiplayerMenu.lua (modified) (1 diff)
• SettingsMenu.lua (modified) (1 diff)
• SheetManager.lua (modified) (1 diff)
• SingleplayerMenu.lua (modified) (1 diff)

code/branches/usability/data/gui/scripts/AudioMenu.lua

@@ -43 +43 @@
     end
 
-    P:initButtons(1, 1)
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/AudioBackButton"),

code/branches/usability/data/gui/scripts/ControlsMenu.lua

@@ -8 +8 @@
 
     --buttons are arranged in a 3x1 matrix:
-    P:initButtons(3, 1)
-
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/MouseControlsButton"),

code/branches/usability/data/gui/scripts/CreditsMenu.lua

@@ -6 +6 @@
 
 function P.onLoad()
-    P:initButtons(1, 1)
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/CreditsBackButton"),

code/branches/usability/data/gui/scripts/DecisionPopup.lua

@@ -6 +6 @@
 
     --button are arranged in a 1x2 matrix
-    P:initButtons(1, 2)
-
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/DecisionPopup_button_yes"),

code/branches/usability/data/gui/scripts/GUISheet.lua

@@ -34 +34 @@
 
     -- set the selected button's state
-    if self.buttons and self:hasSelection() then
-        self:setButtonStateSelected()
-    end
+    self:setSelectedButtonsStateToSelected()
 
     self:onShow()
@@ -107 +105 @@
 
 -- Initializes the buttons table, used to control the menu with the keyboard
--- ratio: the button's with divided by the button's height (used to calculate distance between buttons - adjust this until you get the desired behavior)
-function P:initButtons(rows, columns, ratio)
+function P:initButtons(rows, columns)
     self.rows = rows
     self.columns = columns
@@ -114 +111 @@
     self.selectedRow = 0
     self.selectedColumn = 0
-
-    if ratio then
-        self.ratio = ratio
-    else
-        self.ratio = 1
-    end
+    self.ratio = 1
+end
+
+-- ratio: the button's with divided by the button's height (used to calculate distance between buttons - adjust this until you get the desired behavior)
+function P:setRatio(ratio)
+    self.ratio = ratio
 end
 
 -- Defines the button for a given position in the table. The upper-left button is at position (1, 1)
 function P:setButton(row, column, button)
-    assert(self.rows ~= nil and self.columns ~= nil and self.buttons ~= nil, "You have to call initButtons() before using setButton()")
-    assert(row > 0 and column > 0 and row <= self.rows and column <= self.columns, "(" .. row .. "/" .. column .. ") is not in the valid bounds of the table (1/1)-(" .. self.rows .. "/" .. self.columns .. ")")
+    if not self.buttons then
+        -- init the table
+        self:initButtons(row, column)
+    elseif row > self.rows or column > self.columns then
+        -- rearrange the table
+        local maxRows = math.max(self.rows, row)
+        local maxColumns = math.max(self.columns, column)
+
+        for r = self.rows, 1, -1 do
+            for c = self.columns, 1, -1 do
+                local b = self:getButton(r, c)
+                if b then
+                    self.buttons[(r - 1) * self.columns + (c - 1)] = nil
+                    self.buttons[(r - 1) * maxColumns + (c - 1)] = b
+                end
+            end
+        end
+
+        self.rows = maxRows
+        self.columns = maxColumns
+    end
 
     self.buttons[(row - 1) * self.columns + (column - 1)] = button
@@ -132 +148 @@
 -- Returns the button at a given position in the table. The upper-left button is at position (1, 1)
 function P:getButton(row, column)
-    return self.buttons[(row - 1) * self.columns + (column - 1)]
+    if self.buttons then
+        return self.buttons[(row - 1) * self.columns + (column - 1)]
+    else
+        return nil
+    end
 end
 
 -- Returns the selected button
 function P:getSelectedButton()
-    return self:getButton(self.selectedRow, self.selectedColumn)
+    if self:hasSelection() then
+        return self:getButton(self.selectedRow, self.selectedColumn)
+    else
+        return nil
+    end
 end
 
 -- Presses the selected button if any
 function P:pressSelectedButton()
-    if self:hasSelection() then
+    if self:getSelectedButton() then
         self.pressedEnter = true
         self:getSelectedButton().callback()
@@ -151 +175 @@
 -- Sets the selection to a given row and column. The upper-left button is at position (1, 1)
 function P:setSelection(row, column)
+    if not self.buttons then
+        return
+    end
+
     assert(row > 0 and column > 0 and row <= self.rows and column <= self.columns, "(" .. row .. "/" .. column .. ") is not in the valid bounds of the table (1/1)-(" .. self.rows .. "/" .. self.columns .. ")")
 
-    if self:hasSelection() then
-        self:setButtonStateNormal()
-    end
+    self:setSelectedButtonsStateToNormal()
 
     self.selectedRow = row
     self.selectedColumn = column
 
-    self:setButtonStateSelected()
+    self:setSelectedButtonsStateToSelected()
+end
+
+-- Sets the selection to the button closest to the given row and column. The upper-left button is at position (1, 1)
+function P:setSelectionNear(row, column)
+    if not self.buttons then
+        return
+    end
+
+    assert(row > 0 and column > 0 and row <= self.rows and column <= self.columns, "(" .. row .. "/" .. column .. ") is not in the valid bounds of the table (1/1)-(" .. self.rows .. "/" .. self.columns .. ")")
+
+    if self:getButton(row, column) then
+        self:setSelection(row, column)
+    else
+        local min = 1000000
+        local minRow, minColumn
+
+        for r = 1, self.rows do
+            for c = 1, self.columns do
+                if self:getButton(r, c) then
+                    local distance = math.sqrt((row - r)^2 + ((column - c) * self.ratio)^2)
+                    if distance < min then
+                        min = distance; minRow = r; minColumn = c
+                    end
+                end
+            end
+        end
+
+        if minRow and minColumn then
+            self:setSelection(minRow, minColumn)
+        else
+            self:resetSelection()
+        end
+    end
 end
 
@@ -175 +234 @@
 -- Generic move function, the values are determined at runtime depending on the arguments
 function P:moveSelection(relMove, selectedThis, selectedOther, limitThis, limitOther, isRow)
+    if not self.buttons then
+        return
+    end
+
     -- if there's no selection yet, prepare it such that the selection enters the table from the desired side
     if self.selectedRow > 0 or self.selectedColumn > 0 then
-        self:setButtonStateNormal()
+        self:setSelectedButtonsStateToNormal()
     else
         if relMove > 0 then
@@ -199 +262 @@
     -- if the button is deactivated, search the button closest to the desired location
     if self:getSelectedButton() == nil then
-        local min = self.rows + self.columns * self.ratio
+        local min = 1000000
         local minV1, minV2
         local limit, step
@@ -247 +310 @@
     end
 
-    if self:hasSelection() == true then
-        self:setButtonStateSelected()
-    end
+    self:setSelectedButtonsStateToSelected()
 end
 
 -- Resets the selection
 function P:resetSelection()
-    if self:hasSelection() then
-        self:setButtonStateNormal()
-    end
+    self:setSelectedButtonsStateToNormal()
 
     self.selectedRow = 0
@@ -286 +345 @@
 
 -- Sets the selected button's state to normal
-function P:setButtonStateNormal()
-    self:setButtonState("Normal")
+function P:setSelectedButtonsStateToNormal()
+    self:setSelectedButtonsState("Normal")
 end
 
 -- Sets the selected button's state to selected
-function P:setButtonStateSelected()
-    self:setButtonState("Selected")
+function P:setSelectedButtonsStateToSelected()
+    self:setSelectedButtonsState("Selected")
 end
 
 -- Sets the selected button's state to pushed
-function P:setButtonStatePushed()
-    self:setButtonState("Pushed")
+function P:setSelectedButtonsStateToPushed()
+    self:setSelectedButtonsState("Pushed")
 end
 
 -- Sets the selected button's state
-function P:setButtonState(state)
+function P:setSelectedButtonsState(state)
     if self:getSelectedButton() then
         local element = self:getSelectedButton().button

code/branches/usability/data/gui/scripts/GraphicsMenu.lua

@@ -86 +86 @@
     block = false
 
-    P:initButtons(1, 1)
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/GraphicsBackButton"),

code/branches/usability/data/gui/scripts/HostMenu.lua

@@ -15 +15 @@
     button:setSelected(false)
     P.createLevelList()
-
-    P:initButtons(1, 2)
 
     P:setButton(1, 1, {

code/branches/usability/data/gui/scripts/InGameMenu.lua

@@ -8 +8 @@
 
     --button are arranged in a 4x1 matrix, the left lower item is nil
-    P:initButtons(4, 1)
-
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/InGameMenu_ReturnButton"),

code/branches/usability/data/gui/scripts/KeyBindMenu.lua

@@ -101 +101 @@
     orxonox.KeyBinderManager:getInstance():registerKeybindCallback(funct)
 
-    P:initButtons(1, 1)
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/KeyBindBackButton"),

code/branches/usability/data/gui/scripts/MainMenu.lua

@@ -6 +6 @@
 function P.onLoad()
     --buttons are arranged in a 6x1 Matrix (list)
-    P:initButtons(6, 1)
-
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/QuickGameTestButton"),

code/branches/usability/data/gui/scripts/MiscConfigMenu.lua

@@ -85 +85 @@
     P.createLines()
 
-    P:initButtons(1, 1)
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/MiscConfigMenu/MiscConfigBackButton"),

code/branches/usability/data/gui/scripts/MouseControlsMenu.lua

@@ -33 +33 @@
     end
 
-    P:initButtons(1, 1)
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/MouseControlsBackButton"),

code/branches/usability/data/gui/scripts/MultiplayerMenu.lua

@@ -10 +10 @@
     P.multiplayerMode = "startClient"
 
-    --button are arranged in a 2x2 matrix, the lower items are both the back button
-    P:initButtons(2, 3)
-
+    --button are arranged in a 3x2 matrix, Join and Host buttons are in the upper left and middle, the back button in the lower right of the table
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/MultiplayerJoinButton"),

code/branches/usability/data/gui/scripts/SettingsMenu.lua

@@ -6 +6 @@
 function P.onLoad()
     --"Gameplay" and "Multiplayer Options" are not integrated in the list
-    --buttons are arranged in a 4x2 matrix. The lower-right element is not in the matrix!
-    P:initButtons(4, 2)
-
+    --buttons are arranged in a 4x2 matrix.
     P:setButton(1, 2, {
             ["button"] = winMgr:getWindow("orxonox/SettingsMenu/GraphicsButton"),

code/branches/usability/data/gui/scripts/SheetManager.lua

@@ -133 +133 @@
 
     -- select first button if the menu was opened with the keyboard
-    if previous and previous.pressedEnter and menuSheet.buttons and menuSheet:hasSelection() == false then
-        menuSheet:moveSelectionRow(1)
+    if previous and previous.pressedEnter and menuSheet:hasSelection() == false then
+        menuSheet:setSelectionNear(1, 1)
     end
 

code/branches/usability/data/gui/scripts/SingleplayerMenu.lua

@@ -14 +14 @@
 
     --buttons are arranged in a 1x2 matrix
-    P:initButtons(1, 2)
-
     P:setButton(1, 1, {
             ["button"] = winMgr:getWindow("orxonox/SingleplayerStartButton"),