Fix sortOrder param on tablet buttons

libraries/ui/src/ui/TabletScriptingInterface.cpp

@@ -31,6 +31,8 @@
 const QString SYSTEM_TOOLBAR = "com.highfidelity.interface.toolbar.system";
 const QString SYSTEM_TABLET = "com.highfidelity.interface.tablet.system";
 const QString TabletScriptingInterface::QML = "hifi/tablet/TabletRoot.qml";
+const QString BUTTON_SORT_ORDER_KEY = "sortOrder";
+const int DEFAULT_BUTTON_SORT_ORDER = 100;
 
 static QString getUsername() {
     QString username = "Unknown user";
@@ -74,11 +76,20 @@ QVariant TabletButtonListModel::data(const QModelIndex& index, int role) const {
 }
 
 TabletButtonProxy* TabletButtonListModel::addButton(const QVariant& properties) {
-    auto tabletButtonProxy = QSharedPointer<TabletButtonProxy>(new TabletButtonProxy(properties.toMap()));
+    QVariantMap newTabletButtonProperties = properties.toMap();
+    if (newTabletButtonProperties.find(BUTTON_SORT_ORDER_KEY) == newTabletButtonProperties.end()) {
+        newTabletButtonProperties[BUTTON_SORT_ORDER_KEY] = DEFAULT_BUTTON_SORT_ORDER;
+    }
+    int insertButtonUsingIndex = computeNewButtonIndex(newTabletButtonProperties);
+    auto newTabletButtonProxy = QSharedPointer<TabletButtonProxy>(new TabletButtonProxy(newTabletButtonProperties));
     beginResetModel();
-    _buttons.push_back(tabletButtonProxy);
+    if (insertButtonUsingIndex < _buttons.size()) {
+        _buttons.insert(_buttons.begin() + insertButtonUsingIndex, newTabletButtonProxy);
+    } else {
+        _buttons.push_back(newTabletButtonProxy);
+    }
     endResetModel();
-    return tabletButtonProxy.data();
+    return newTabletButtonProxy.data();
 }
 
 void TabletButtonListModel::removeButton(TabletButtonProxy* button) {
@@ -92,6 +103,20 @@ void TabletButtonListModel::removeButton(TabletButtonProxy* button) {
     endResetModel();
 }
 
+int TabletButtonListModel::computeNewButtonIndex(const QVariantMap& newButtonProperties) {
+    int buttonCount = (int)_buttons.size();
+    int newButtonSortOrder = newButtonProperties[BUTTON_SORT_ORDER_KEY].toInt();
+    if (newButtonSortOrder == DEFAULT_BUTTON_SORT_ORDER) return buttonCount;
+    for (int i = 0; i < buttonCount; i++) {
+        QVariantMap tabletButtonProperties = _buttons[i]->getProperties();
+        int tabletButtonSortOrder = tabletButtonProperties[BUTTON_SORT_ORDER_KEY].toInt();
+        if (newButtonSortOrder <= tabletButtonSortOrder) {
+            return i;
+        }
+    }
+    return buttonCount;
+}
+
 TabletButtonsProxyModel::TabletButtonsProxyModel(QObject *parent)
     : QSortFilterProxyModel(parent) {
 }

libraries/ui/src/ui/TabletScriptingInterface.h

@@ -115,6 +115,7 @@ protected:
     friend class TabletProxy;
     TabletButtonProxy* addButton(const QVariant& properties);
     void removeButton(TabletButtonProxy* button);
+    int computeNewButtonIndex(const QVariantMap& newButtonProperties);
     using List = std::list<QSharedPointer<TabletButtonProxy>>;
     static QHash<int, QByteArray> _roles;
     static Qt::ItemFlags _flags;

scripts/developer/tests/dynamics/dynamicsTests.js

@@ -22,8 +22,7 @@
 
     var button = tablet.addButton({
         icon: Script.resolvePath("dynamicsTests.svg"),
-        text: "Dynamics",
+        text: "Dynamics"
-        sortOrder: 15
     });
 
 

scripts/developer/utilities/render/debugHighlight.js

@@ -32,8 +32,7 @@
     var button = tablet.addButton({
         text: TABLET_BUTTON_NAME,
         icon: ICON_URL,
-        activeIcon: ACTIVE_ICON_URL,
+        activeIcon: ACTIVE_ICON_URL
-        sortOrder: 1
     });
 
     var hasEventBridge = false;

scripts/developer/utilities/render/lod.js

@@ -30,8 +30,7 @@
     var button = tablet.addButton({
         text: TABLET_BUTTON_NAME,
         icon: ICON_URL,
-        activeIcon: ACTIVE_ICON_URL,
+        activeIcon: ACTIVE_ICON_URL
-        sortOrder: 1
     });
 
     var hasEventBridge = false;

scripts/developer/utilities/render/luci.js

@@ -31,8 +31,7 @@
     var button = tablet.addButton({
         text: TABLET_BUTTON_NAME,
         icon: ICON_URL,
-        activeIcon: ACTIVE_ICON_URL,
+        activeIcon: ACTIVE_ICON_URL
-        sortOrder: 1
     });
 
     var hasEventBridge = false;

scripts/system/chat.js

@@ -945,8 +945,7 @@
         tabletButton = tablet.addButton({
             icon: tabletButtonIcon,
             activeIcon: tabletButtonActiveIcon,
-            text: tabletButtonName,
+            text: tabletButtonName
-            sortOrder: 0
         });
 
         Messages.subscribe(channelName);

scripts/system/generalSettings.js

@@ -37,8 +37,7 @@
         tablet = Tablet.getTablet("com.highfidelity.interface.tablet.system");
         button = tablet.addButton({
             icon: "icons/tablet-icons/goto-i.svg",
-            text: buttonName,
+            text: buttonName
-            sortOrder: 8
         });
     }
 

scripts/system/goto.js

@@ -41,8 +41,7 @@ if (Settings.getValue("HUDUIEnabled")) {
     button = tablet.addButton({
         icon: "icons/tablet-icons/goto-i.svg",
         activeIcon: "icons/tablet-icons/goto-a.svg",
-        text: buttonName,
+        text: buttonName
-        sortOrder: 8
     });
 }
 

scripts/system/run.js

@@ -10,8 +10,7 @@
     var tablet = Tablet.getTablet("com.highfidelity.interface.tablet.system");
     var button = tablet.addButton({
         icon: Script.resolvePath("assets/images/run.svg"),
-        text: "RUN",
+        text: "RUN"
-        sortOrder: 15
     });
 
     function onClicked() {

scripts/system/tablet-users.js

@@ -37,8 +37,7 @@
     var button = tablet.addButton({
         icon: "icons/tablet-icons/users-i.svg",
         activeIcon: "icons/tablet-icons/users-a.svg",
-        text: "USERS",
+        text: "USERS"
-        sortOrder: 11
     });
 
     var onUsersScreen = false;

unpublishedScripts/marketplace/clap/clapApp.js

@@ -31,8 +31,7 @@ var activeButton = tablet.addButton({
     icon: whiteIcon,
     activeIcon: blackIcon,
     text: APP_NAME,
-    isActive: isActive,
+    isActive: isActive
-    sortOrder: 11
 });
 
 if (isActive) {

unpublishedScripts/marketplace/skyboxChanger/skyboxchanger.js

@@ -32,8 +32,7 @@
     var button = tablet.addButton({
         icon: ICONS.icon,
         activeIcon: ICONS.activeIcon,
-        text: TABLET_BUTTON_NAME,
+        text: TABLET_BUTTON_NAME
-        sortOrder: 1
     });
 
     var hasEventBridge = false;