src/ViewerTest/ViewerTest_EventManager.hxx

   1 // Created on: 1998-08-27
   2 // Created by: Robert COUBLANC
   3 // Copyright (c) 1998-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _ViewerTest_EventManager_HeaderFile
  18 #define _ViewerTest_EventManager_HeaderFile
  19
  20 #include <AIS_ViewController.hxx>
  21 #include <TColgp_Array1OfPnt2d.hxx>
  22 #include <TCollection_AsciiString.hxx>
  23
  24 class AIS_InteractiveContext;
  25 class V3d_View;
  26
  27 DEFINE_STANDARD_HANDLE(ViewerTest_EventManager, Standard_Transient)
  28
  29 //! used to manage mouse event (move,select,shiftselect)
  30 //! By default the events are transmitted to interactive context.
  31 class ViewerTest_EventManager : public Standard_Transient, public AIS_ViewController
  32 {
  33   DEFINE_STANDARD_RTTIEXT(ViewerTest_EventManager, Standard_Transient)
  34 public:
  35
  36   //! Return TRUE if View should be closed on escape.
  37   static Standard_Boolean& ToCloseViewOnEscape()
  38   {
  39     static Standard_Boolean Draw_ToCloseViewOnEsc = Standard_False;
  40     return Draw_ToCloseViewOnEsc;
  41   }
  42
  43   //! Return TRUE if Draw Harness should exit on closing View.
  44   static Standard_Boolean& ToExitOnCloseView()
  45   {
  46     static Standard_Boolean Draw_ToExitOnCloseView = Standard_False;
  47     return Draw_ToExitOnCloseView;
  48   }
  49
  50   //! Use global camera animation object shared across all Views in ViewerTest.
  51   Standard_EXPORT static const Handle(AIS_AnimationCamera)& GlobalViewAnimation();
  52
  53 public:
  54
  55   //! Main constructor.
  56   Standard_EXPORT ViewerTest_EventManager(const Handle(V3d_View)& aView, const Handle(AIS_InteractiveContext)& aCtx);
  57
  58   //! Destructor.
  59   Standard_EXPORT virtual ~ViewerTest_EventManager();
  60
  61   //! Return interactive context.
  62   const Handle(AIS_InteractiveContext)& Context() const { return myCtx; }
  63
  64   //! Returns TRUE if picking point mode has been enabled (for VPick command).
  65   Standard_Boolean ToPickPoint() const { return myToPickPnt; }
  66
  67   //! Start picking point for VPick command.
  68   void StartPickPoint (const char* theArgX,
  69                        const char* theArgY,
  70                        const char* theArgZ)
  71   {
  72     myToPickPnt = Standard_True;
  73     myPickPntArgVec[0] = theArgX;
  74     myPickPntArgVec[1] = theArgY;
  75     myPickPntArgVec[2] = theArgZ;
  76   }
  77
  78   //! Handle mouse button press/release event.
  79   Standard_EXPORT virtual bool UpdateMouseButtons (const Graphic3d_Vec2i& thePoint,
  80                                                    Aspect_VKeyMouse theButtons,
  81                                                    Aspect_VKeyFlags theModifiers,
  82                                                    bool theIsEmulated) Standard_OVERRIDE;
  83
  84   //! Release key.
  85   Standard_EXPORT virtual void KeyDown (Aspect_VKey theKey,
  86                                         double theTime,
  87                                         double thePressure = 1.0) Standard_OVERRIDE;
  88
  89   //! Release key.
  90   Standard_EXPORT virtual void KeyUp (Aspect_VKey theKey,
  91                                       double theTime) Standard_OVERRIDE;
  92
  93   //! Redraw the View on an Expose Event
  94   Standard_EXPORT virtual void ProcessExpose();
  95
  96   //! Handle redraw.
  97   Standard_EXPORT virtual void handleViewRedraw (const Handle(AIS_InteractiveContext)& theCtx,
  98                                                  const Handle(V3d_View)& theView) Standard_OVERRIDE;
  99
 100   //! Resize View.
 101   Standard_EXPORT virtual void ProcessConfigure();
 102
 103   //! Handle KeyPress event.
 104   Standard_EXPORT void ProcessKeyPress (Aspect_VKey theKey);
 105
 106 protected:
 107
 108   //! Register hot-keys for specified Action.
 109   void addActionHotKeys (Aspect_VKey theAction,
 110                          unsigned int theHotKey1 = 0,
 111                          unsigned int theHotKey2 = 0,
 112                          unsigned int theHotKey3 = 0,
 113                          unsigned int theHotKey4 = 0,
 114                          unsigned int theHotKey5 = 0)
 115   {
 116     if (theHotKey1 != 0) { myNavKeyMap.Bind (theHotKey1, theAction); }
 117     if (theHotKey2 != 0) { myNavKeyMap.Bind (theHotKey2, theAction); }
 118     if (theHotKey3 != 0) { myNavKeyMap.Bind (theHotKey3, theAction); }
 119     if (theHotKey4 != 0) { myNavKeyMap.Bind (theHotKey4, theAction); }
 120     if (theHotKey5 != 0) { myNavKeyMap.Bind (theHotKey5, theAction); }
 121   }
 122
 123   //! Handle modifier key changes.
 124   Standard_EXPORT bool navigationKeyModifierSwitch (unsigned int theModifOld,
 125                                                     unsigned int theModifNew,
 126                                                     double       theTimeStamp);
 127
 128 private:
 129
 130   Handle(AIS_InteractiveContext) myCtx;
 131   Handle(V3d_View) myView;
 132   NCollection_DataMap<unsigned int, Aspect_VKey> myNavKeyMap; //!< map of Hot-Key (key+modifiers) to Action
 133
 134   TCollection_AsciiString myPickPntArgVec[3];
 135   Standard_Boolean myToPickPnt;
 136   Standard_Boolean myIsTmpContRedraw;
 137
 138 };
 139
 140 #endif // _ViewerTest_EventManager_HeaderFile