SoInteractionHandler.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2008, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef SO_INTERACTION_HANDLER_H
#define SO_INTERACTION_HANDLER_H

 
#include "SoInteractionProvider.h"
#include "SoPointerPosition.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <Inventor/events/SoKeyboardEvent.h>
#include <Inventor/events/SoMouseWheelEvent.h>
 
#include <list>
#include <ThirdPartyWarningsRestore.h>
 
class SoState;
class SoHandleEventAction;
class SoInteractionCoordinator;

class SOMANAGEDINTERACTION_API SoInteractionHandler
{
public:
  SoInteractionHandler(SoInteractionProvider* provider);
  virtual ~SoInteractionHandler();

  virtual void  handleEventForInteraction(SoHandleEventAction *action);
 
protected:
  bool handleKeyPress(SoState* state, const SoPointerPosition& location, int modifiers, SoKeyboardEvent::Key nKey,
                      bool positionValid);

  virtual bool augmentLocation (SoPointerPosition& /*position*/, bool /*dragging*/) { return true; }

  void buttonMaskChanged (SoState* state, const SoPointerPosition& location, int buttonMask);

  void modifierMaskChanged (SoState* state, const SoPointerPosition& location, int modifierMask);

  void locationChanged (SoState* state, const SoPointerPosition& location, bool force = false, bool renderRefresh = false);

  bool wheelRotated(SoState* state, const SoPointerPosition& location, int modifierMask,
                    SoMouseWheelEvent::Orientation orientation, short rotation);

  void handlePointerLeftWindow(SoState* state);

  int getCurrentButtonMask()                    { return _currentButtonMask;           }
  int getCurrentModifierMask()                  { return _currentModifierMask;         }
  SoPointerPosition getCurrentPointerLocation() { return _currentPointerLocation;      }
  bool isCurrentPointerLocationValid()          { return _currentPointerLocationValid; }

  SoInteractionCoordinator* getCoordinator()    { return _coordinator; }
 
  // Convenience method, returns the selected pointing action it belongs to this
  // interaction provider; otherwise, it returns NULL. Must be called during event handling.
  SoPointingAction* getLocalCurrentPointingAction();

  virtual bool isEnabled (SoPointingAction* action, int currentMask);

  virtual bool isValidStartingLocation(const SoPointerPosition& location);
 
  // Returns whether the pointing action may be selected by this handler, i.e., it has been
  // not been selected by another node during the current event traversal.
  // Must be called during event handling.
  bool canSelectPointingAction();
 
  // Selects the appropriate pointing action for the given location and
  // button/modifier mask. The action is set in the SoInteractionCoordinator.
  void selectTargetPointingAction(SoState* state, const SoPointerPosition& location, int mask);

  bool trySwitchGlobalPointingAction (SoState* state, const SoPointerPosition& location, int buttonMask, int modifierMask);
 
private:
  std::list<SoPointingAction*> getPointingActions(SoState* state);

  SoInteractionProvider* _provider;

  SoInteractionCoordinator* _coordinator;

  SoState* _inventorState;
 
  // Remember current state of pointer:
  int _currentButtonMask;
  int _currentModifierMask;
  SoPointerPosition _currentPointerLocation;
  bool _currentPointerLocationValid;
 
  // This flag remembers if we did find a pointing action last time we searched.
  bool _pointingActionFound;
 
  // Set to \c true if pointerPosition() had been called on pointing actions (and
  // when pointerLeftWindow() needs to be called if the cursor leaves the window).
  bool _hadPointerUpdate;
};
 
#endif // __SoInteractionHandler_H