ISSUE-2082: Add repeat support for bindings API

Author: CPerry26

library/private/interactor_impl.h

@@ -48,10 +48,10 @@ class interactor_impl : public interactor
   interactor& initBindings() override;
   interactor& addBinding(const interaction_bind_t& bind, std::vector<std::string> commands,
     std::string group = std::string(), documentation_callback_t documentationCallback = nullptr,
-    BindingType type = BindingType::OTHER, bool notify = true) override;
+    BindingType type = BindingType::OTHER, bool notify = true, bool repeat = false) override;
   interactor& addBinding(const interaction_bind_t& bind, std::string command,
     std::string group = std::string(), documentation_callback_t documentationCallback = nullptr,
-    BindingType type = BindingType::OTHER, bool notify = true) override;
+    BindingType type = BindingType::OTHER, bool notify = true, bool repeat = false) override;
   interactor& removeBinding(const interaction_bind_t& bind) override;
   std::vector<std::string> getBindGroups() const override;
   std::vector<interaction_bind_t> getBindsForGroup(std::string group) const override;

library/public/interactor.h

@@ -187,11 +187,13 @@ class F3D_EXPORT interactor
    *
    * If notify is true, a notification is triggered when pressing the binding
    *
+   * If repeat is true, the binding is continuously applied when holding down the key
+   *
    * Adding commands for an existing bind will throw a interactor::already_exists_exception.
    */
   virtual interactor& addBinding(const interaction_bind_t& bind, std::vector<std::string> commands,
     std::string group = {}, documentation_callback_t documentationCallback = nullptr,
-    BindingType type = BindingType::OTHER, bool notify = true) = 0;
+    BindingType type = BindingType::OTHER, bool notify = true, bool repeat = false) = 0;
 
   /**
    * See addBinding
@@ -202,17 +204,17 @@ class F3D_EXPORT interactor
    */
   virtual interactor& addBinding(const interaction_bind_t& bind, std::string command,
     std::string group = {}, documentation_callback_t documentationCallback = nullptr,
-    BindingType type = BindingType::OTHER, bool notify = true) = 0;
+    BindingType type = BindingType::OTHER, bool notify = true, bool repeat = false) = 0;
 
   /**
    * Convenience initializer list signature for add binding method
    */
   interactor& addBinding(const interaction_bind_t& bind, std::initializer_list<std::string> list,
     std::string group = {}, documentation_callback_t documentationCallback = nullptr,
-    BindingType type = BindingType::OTHER, bool notify = true)
+    BindingType type = BindingType::OTHER, bool notify = true, bool repeat = false)
   {
     return this->addBinding(bind, std::vector<std::string>(list), std::move(group),
-      std::move(documentationCallback), type, notify);
+      std::move(documentationCallback), type, notify, repeat);
   }
 
   /**

library/src/interactor_impl.cxx

@@ -61,6 +61,7 @@ class interactor_impl::internals
     documentation_callback_t DocumentationCallback;
     BindingType Type;
     bool Notify;
+    bool Repeat;
   };
 
   struct CommandCallbacks
@@ -519,36 +520,39 @@ class interactor_impl::internals
       // invalidating any references/iterators into it.
       const BindingCommands binding = commandsIt->second;
 
-      for (const std::string& command : binding.CommandVector)
+      if (binding.Repeat || rwi->GetRepeatCount() <= 1)
       {
-        std::string commandWithArgs = command;
-        if (!argsString.empty())
+        for (const std::string& command : binding.CommandVector)
         {
-          commandWithArgs.push_back(' ');
-          commandWithArgs.append(argsString);
-        };
-        try
-        {
-          // XXX: Ignore the boolean return of triggerCommand,
-          // error is already logged by triggerCommand
-          this->Interactor.triggerCommand(commandWithArgs);
-        }
-        catch (const f3d::interactor::command_runtime_exception& ex)
-        {
-          log::error(
-            "Interaction: error running command: \"" + commandWithArgs + "\": " + ex.what());
+          std::string commandWithArgs = command;
+          if (!argsString.empty())
+          {
+            commandWithArgs.push_back(' ');
+            commandWithArgs.append(argsString);
+          };
+          try
+          {
+            // XXX: Ignore the boolean return of triggerCommand,
+            // error is already logged by triggerCommand
+            this->Interactor.triggerCommand(commandWithArgs);
+          }
+          catch (const f3d::interactor::command_runtime_exception& ex)
+          {
+            log::error(
+              "Interaction: error running command: \"" + commandWithArgs + "\": " + ex.what());
+          }
         }
-      }
 
-      if (binding.Notify && binding.DocumentationCallback)
-      {
-        // trigger notification
-        vtkRenderWindow* renWin = this->Window.GetRenderWindow();
-        vtkF3DRenderer* ren =
-          vtkF3DRenderer::SafeDownCast(renWin->GetRenderers()->GetFirstRenderer());
+        if (binding.Notify && binding.DocumentationCallback)
+        {
+          // trigger notification
+          vtkRenderWindow* renWin = this->Window.GetRenderWindow();
+          vtkF3DRenderer* ren =
+            vtkF3DRenderer::SafeDownCast(renWin->GetRenderers()->GetFirstRenderer());
 
-        auto [desc, value] = binding.DocumentationCallback();
-        ren->AddNotification(desc, value, bind.format(), 3.0);
+          auto [desc, value] = binding.DocumentationCallback();
+          ren->AddNotification(desc, value, bind.format(), 3.0);
+        }
       }
     }
 
@@ -1734,10 +1738,10 @@ interactor& interactor_impl::initBindings()
 //----------------------------------------------------------------------------
 interactor& interactor_impl::addBinding(const interaction_bind_t& bind,
   std::vector<std::string> commands, std::string group,
-  documentation_callback_t documentationCallback, BindingType type, bool notify)
+  documentation_callback_t documentationCallback, BindingType type, bool notify, bool repeat)
 {
   const auto [it, success] = this->Internals->Bindings.insert(
-    { bind, { std::move(commands), std::move(documentationCallback), type, notify } });
+    { bind, { std::move(commands), std::move(documentationCallback), type, notify, repeat } });
   if (!success)
   {
     throw interactor::already_exists_exception(
@@ -1759,10 +1763,10 @@ interactor& interactor_impl::addBinding(const interaction_bind_t& bind,
 
 //----------------------------------------------------------------------------
 interactor& interactor_impl::addBinding(const interaction_bind_t& bind, std::string command,
-  std::string group, documentation_callback_t documentationCallback, BindingType type, bool notify)
+  std::string group, documentation_callback_t documentationCallback, BindingType type, bool notify, bool repeat)
 {
   return this->addBinding(bind, std::vector<std::string>{ std::move(command) }, std::move(group),
-    std::move(documentationCallback), type, notify);
+    std::move(documentationCallback), type, notify, repeat);
 }
 
 //----------------------------------------------------------------------------