feat(command_queue): add requestViewModelInstanceName

include/rive/command_queue.hpp

@@ -269,6 +269,12 @@ class CommandQueue : public RefCnt<CommandQueue>
                                                  std::string path,
                                                  size_t size)
         {}
+
+        virtual void onViewModelInstanceNameReceived(
+            const ViewModelInstanceHandle,
+            uint64_t requestId,
+            std::string name)
+        {}
     };
 
     class StateMachineListener
@@ -631,6 +637,9 @@ class CommandQueue : public RefCnt<CommandQueue>
                                           std::string path,
                                           uint64_t requestId = 0);
 
+    void requestViewModelInstanceName(ViewModelInstanceHandle,
+                                      uint64_t requestId = 0);
+
     void requestStateMachineNames(ArtboardHandle, uint64_t requestId = 0);
     void requestDefaultViewModelInfo(ArtboardHandle,
                                      FileHandle,
@@ -826,7 +835,8 @@ class CommandQueue : public RefCnt<CommandQueue>
         listViewModelInstanceNames,
         listViewModelProperties,
         listViewModelPropertyValue,
-        getViewModelListSize
+        getViewModelListSize,
+        getViewModelInstanceName
     };
 
     enum class Message
@@ -842,6 +852,7 @@ class CommandQueue : public RefCnt<CommandQueue>
         viewModelPropertiesListed,
         viewModelPropertyValueReceived,
         viewModelListSizeReceived,
+        viewModelInstanceNameReceived,
         fileLoaded,
         fileDeleted,
         imageDecoded,

src/command_queue.cpp

@@ -998,6 +998,16 @@ void CommandQueue::requestViewModelInstanceListSize(
     m_names << path;
 }
 
+void CommandQueue::requestViewModelInstanceName(
+    ViewModelInstanceHandle handle,
+    uint64_t requestId)
+{
+    AutoLockAndNotify lock(m_commandMutex, m_commandConditionVariable);
+    m_commandStream << Command::getViewModelInstanceName;
+    m_commandStream << handle;
+    m_commandStream << requestId;
+}
+
 void CommandQueue::requestStateMachineNames(ArtboardHandle artboardHandle,
                                             uint64_t requestId)
 {
@@ -1379,6 +1389,33 @@ void CommandQueue::processMessages()
                 break;
             }
 
+            case Message::viewModelInstanceNameReceived:
+            {
+                ViewModelInstanceHandle handle;
+                std::string name;
+                uint64_t requestId;
+                m_messageStream >> handle;
+                m_messageStream >> requestId;
+                m_messageNames >> name;
+                lock.unlock();
+                if (m_globalViewModelListener)
+                {
+                    m_globalViewModelListener
+                        ->onViewModelInstanceNameReceived(handle,
+                                                         requestId,
+                                                         name);
+                }
+                auto itr = m_viewModelListeners.find(handle);
+                if (itr != m_viewModelListeners.end())
+                {
+                    itr->second->onViewModelInstanceNameReceived(
+                        handle,
+                        requestId,
+                        std::move(name));
+                }
+                break;
+            }
+
             case Message::fileLoaded:
             {
                 FileHandle handle;

src/command_server.cpp

@@ -2624,6 +2624,37 @@ bool CommandServer::processCommands()
                 break;
             }
 
+            case CommandQueue::Command::getViewModelInstanceName:
+            {
+                ViewModelInstanceHandle handle;
+                uint64_t requestId;
+                commandStream >> handle;
+                commandStream >> requestId;
+                lock.unlock();
+
+                if (auto viewModel = getViewModelInstance(handle))
+                {
+                    std::unique_lock<std::mutex> messageLock(
+                        m_commandQueue->m_messageMutex);
+                    messageStream
+                        << CommandQueue::Message::viewModelInstanceNameReceived;
+                    messageStream << handle;
+                    messageStream << requestId;
+                    m_commandQueue->m_messageNames << viewModel->name();
+                }
+                else
+                {
+                    ErrorReporter<ViewModelInstanceHandle>(
+                        this,
+                        handle,
+                        requestId,
+                        CommandQueue::Message::viewModelError)
+                        << "failed to get view model instance " << handle
+                        << " when getting instance name";
+                }
+                break;
+            }
+
             case CommandQueue::Command::pointerMove:
             {
                 StateMachineHandle handle;