0032122: Samples - handle WASD keys in WebGL sample

diff --git a/samples/webgl/WasmOcctView.cpp b/samples/webgl/WasmOcctView.cpp
index ec333033005dfbe04dd3c4a1eb5e7b0fe8bccb7c..ec8e5f72541e8973eb60a29f2e47e2b0c0b32aab 100644 (file)
--- a/samples/webgl/WasmOcctView.cpp
+++ b/samples/webgl/WasmOcctView.cpp
@@ -137,6 +137,28 @@ WasmOcctView::WasmOcctView()
 : myDevicePixelRatio (1.0f),
   myUpdateRequests (0)
 {
+  addActionHotKeys (Aspect_VKey_NavForward,        Aspect_VKey_W, Aspect_VKey_W | Aspect_VKeyFlags_SHIFT);
+  addActionHotKeys (Aspect_VKey_NavBackward ,      Aspect_VKey_S, Aspect_VKey_S | Aspect_VKeyFlags_SHIFT);
+  addActionHotKeys (Aspect_VKey_NavSlideLeft,      Aspect_VKey_A, Aspect_VKey_A | Aspect_VKeyFlags_SHIFT);
+  addActionHotKeys (Aspect_VKey_NavSlideRight,     Aspect_VKey_D, Aspect_VKey_D | Aspect_VKeyFlags_SHIFT);
+  addActionHotKeys (Aspect_VKey_NavRollCCW,        Aspect_VKey_Q, Aspect_VKey_Q | Aspect_VKeyFlags_SHIFT);
+  addActionHotKeys (Aspect_VKey_NavRollCW,         Aspect_VKey_E, Aspect_VKey_E | Aspect_VKeyFlags_SHIFT);
+
+  addActionHotKeys (Aspect_VKey_NavSpeedIncrease,  Aspect_VKey_Plus,  Aspect_VKey_Plus  | Aspect_VKeyFlags_SHIFT,
+                                                   Aspect_VKey_Equal,
+                                                   Aspect_VKey_NumpadAdd, Aspect_VKey_NumpadAdd | Aspect_VKeyFlags_SHIFT);
+  addActionHotKeys (Aspect_VKey_NavSpeedDecrease,  Aspect_VKey_Minus, Aspect_VKey_Minus | Aspect_VKeyFlags_SHIFT,
+                                                   Aspect_VKey_NumpadSubtract, Aspect_VKey_NumpadSubtract | Aspect_VKeyFlags_SHIFT);
+
+  // arrow keys conflict with browser page scrolling, so better be avoided in non-fullscreen mode
+  addActionHotKeys (Aspect_VKey_NavLookUp,         Aspect_VKey_Numpad8); // Aspect_VKey_Up
+  addActionHotKeys (Aspect_VKey_NavLookDown,       Aspect_VKey_Numpad2); // Aspect_VKey_Down
+  addActionHotKeys (Aspect_VKey_NavLookLeft,       Aspect_VKey_Numpad4); // Aspect_VKey_Left
+  addActionHotKeys (Aspect_VKey_NavLookRight,      Aspect_VKey_Numpad6); // Aspect_VKey_Right
+  addActionHotKeys (Aspect_VKey_NavSlideLeft,      Aspect_VKey_Numpad1); // Aspect_VKey_Left |Aspect_VKeyFlags_SHIFT
+  addActionHotKeys (Aspect_VKey_NavSlideRight,     Aspect_VKey_Numpad3); // Aspect_VKey_Right|Aspect_VKeyFlags_SHIFT
+  addActionHotKeys (Aspect_VKey_NavSlideUp,        Aspect_VKey_Numpad9); // Aspect_VKey_Up   |Aspect_VKeyFlags_SHIFT
+  addActionHotKeys (Aspect_VKey_NavSlideDown,      Aspect_VKey_Numpad7); // Aspect_VKey_Down |Aspect_VKeyFlags_SHIFT
 }
 
 // ================================================================
@@ -430,6 +452,14 @@ void WasmOcctView::handleViewRedraw (const Handle(AIS_InteractiveContext)& theCt
 {
   myUpdateRequests = 0;
   AIS_ViewController::handleViewRedraw (theCtx, theView);
+
+  for (NCollection_DataMap<unsigned int, Aspect_VKey>::Iterator aNavKeyIter (myNavKeyMap);
+       !myToAskNextFrame && aNavKeyIter.More(); aNavKeyIter.Next())
+  {
+    const Aspect_VKey aVKey = aNavKeyIter.Key() & ~Aspect_VKeyFlags_ALL;
+    myToAskNextFrame = myKeys.IsKeyDown (aVKey);
+  }
+
   if (myToAskNextFrame)
   {
     // ask more frames
@@ -696,6 +726,43 @@ EM_BOOL WasmOcctView::onTouchEvent (int theEventType, const EmscriptenTouchEvent
   return hasUpdates || !myTouchPoints.IsEmpty() ? EM_TRUE : EM_FALSE;
 }
 
+// ================================================================
+// Function : navigationKeyModifierSwitch
+// Purpose  :
+// ================================================================
+bool WasmOcctView::navigationKeyModifierSwitch (unsigned int theModifOld,
+                                                unsigned int theModifNew,
+                                                double       theTimeStamp)
+{
+  bool hasActions = false;
+  for (unsigned int aKeyIter = 0; aKeyIter < Aspect_VKey_ModifiersLower; ++aKeyIter)
+  {
+    if (!myKeys.IsKeyDown (aKeyIter))
+    {
+      continue;
+    }
+
+    Aspect_VKey anActionOld = Aspect_VKey_UNKNOWN, anActionNew = Aspect_VKey_UNKNOWN;
+    myNavKeyMap.Find (aKeyIter | theModifOld, anActionOld);
+    myNavKeyMap.Find (aKeyIter | theModifNew, anActionNew);
+    if (anActionOld == anActionNew)
+    {
+      continue;
+    }
+
+    if (anActionOld != Aspect_VKey_UNKNOWN)
+    {
+      myKeys.KeyUp (anActionOld, theTimeStamp);
+    }
+    if (anActionNew != Aspect_VKey_UNKNOWN)
+    {
+      hasActions = true;
+      myKeys.KeyDown (anActionNew, theTimeStamp);
+    }
+  }
+  return hasActions;
+}
+
 // ================================================================
 // Function : onKeyDownEvent
 // Purpose  :
@@ -714,15 +781,27 @@ EM_BOOL WasmOcctView::onKeyDownEvent (int theEventType, const EmscriptenKeyboard
   {
     return EM_FALSE;
   }
+  if (theEvent->repeat == EM_TRUE)
+  {
+    return EM_FALSE;
+  }
 
-  if (theEvent->repeat == EM_FALSE)
+  const unsigned int aModifOld = myKeys.Modifiers();
+  AIS_ViewController::KeyDown (aVKey, aTimeStamp);
+
+  const unsigned int aModifNew = myKeys.Modifiers();
+  if (aModifNew != aModifOld
+   && navigationKeyModifierSwitch (aModifOld, aModifNew, aTimeStamp))
   {
-    myKeys.KeyDown (aVKey, aTimeStamp);
+    // modifier key just pressed
   }
 
-  if (Aspect_VKey2Modifier (aVKey) == 0)
+  Aspect_VKey anAction = Aspect_VKey_UNKNOWN;
+  if (myNavKeyMap.Find (aVKey | myKeys.Modifiers(), anAction)
+  &&  anAction != Aspect_VKey_UNKNOWN)
   {
-    // normal key
+    AIS_ViewController::KeyDown (anAction, aTimeStamp);
+    UpdateView();
   }
   return EM_FALSE;
 }
@@ -746,28 +825,43 @@ EM_BOOL WasmOcctView::onKeyUpEvent (int theEventType, const EmscriptenKeyboardEv
     return EM_FALSE;
   }
 
-  if (theEvent->repeat == EM_TRUE)
+  const unsigned int aModifOld = myKeys.Modifiers();
+  AIS_ViewController::KeyUp (aVKey, aTimeStamp);
+
+  Aspect_VKey anAction = Aspect_VKey_UNKNOWN;
+  if (myNavKeyMap.Find (aVKey | myKeys.Modifiers(), anAction)
+  &&  anAction != Aspect_VKey_UNKNOWN)
   {
-    return EM_FALSE;
+    AIS_ViewController::KeyUp (anAction, aTimeStamp);
+    UpdateView();
   }
 
-  const unsigned int aModif = myKeys.Modifiers();
-  myKeys.KeyUp (aVKey, aTimeStamp);
-  if (Aspect_VKey2Modifier (aVKey) == 0)
+  const unsigned int aModifNew = myKeys.Modifiers();
+  if (aModifNew != aModifOld
+   && navigationKeyModifierSwitch (aModifOld, aModifNew, aTimeStamp))
   {
-    // normal key released
-    switch (aVKey | aModif)
+    // modifier key released
+  }
+
+  return processKeyPress (aVKey | aModifNew) ? EM_TRUE : EM_FALSE;
+}
+
+//==============================================================================
+//function : processKeyPress
+//purpose  :
+//==============================================================================
+bool WasmOcctView::processKeyPress (Aspect_VKey theKey)
+{
+  switch (theKey)
+  {
+    case Aspect_VKey_F:
     {
-      case Aspect_VKey_F:
-      {
-        myView->FitAll (0.01, false);
-        myView->Invalidate();
-        updateView();
-        return EM_TRUE;
-      }
+      myView->FitAll (0.01, false);
+      UpdateView();
+      return true;
     }
   }
-  return EM_FALSE;
+  return false;
 }
 
 // ================================================================

diff --git a/samples/webgl/WasmOcctView.h b/samples/webgl/WasmOcctView.h
index c05ce179a34e08b77e8322d032acedf4ae65ce7a..3acf35e86e405e0841206403166843e77d66a8e8 100644 (file)
--- a/samples/webgl/WasmOcctView.h
+++ b/samples/webgl/WasmOcctView.h
@@ -209,10 +209,37 @@ private:
   static EM_BOOL onKeyUpCallback (int theEventType, const EmscriptenKeyboardEvent* theEvent, void* theView)
   { return ((WasmOcctView* )theView)->onKeyUpEvent (theEventType, theEvent); }
 
+private:
+
+  //! Register hot-keys for specified Action.
+  void addActionHotKeys (Aspect_VKey theAction,
+                         unsigned int theHotKey1 = 0,
+                         unsigned int theHotKey2 = 0,
+                         unsigned int theHotKey3 = 0,
+                         unsigned int theHotKey4 = 0,
+                         unsigned int theHotKey5 = 0)
+  {
+    if (theHotKey1 != 0) { myNavKeyMap.Bind (theHotKey1, theAction); }
+    if (theHotKey2 != 0) { myNavKeyMap.Bind (theHotKey2, theAction); }
+    if (theHotKey3 != 0) { myNavKeyMap.Bind (theHotKey3, theAction); }
+    if (theHotKey4 != 0) { myNavKeyMap.Bind (theHotKey4, theAction); }
+    if (theHotKey5 != 0) { myNavKeyMap.Bind (theHotKey5, theAction); }
+  }
+
+  //! Handle navigation keys.
+  bool navigationKeyModifierSwitch (unsigned int theModifOld,
+                                    unsigned int theModifNew,
+                                    double       theTimeStamp);
+
+  //! Handle hot-key.
+  bool processKeyPress (Aspect_VKey theKey);
+
 private:
 
   NCollection_IndexedDataMap<TCollection_AsciiString, Handle(AIS_InteractiveObject)> myObjects; //!< map of named objects
 
+  NCollection_DataMap<unsigned int, Aspect_VKey> myNavKeyMap; //!< map of Hot-Key (key+modifiers) to Action
+
   Handle(AIS_InteractiveContext) myContext;          //!< interactive context
   Handle(V3d_View)               myView;             //!< 3D view
   Handle(Prs3d_TextAspect)       myTextStyle;        //!< text style for OSD elements