SoPointingAction.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_POINTING_ACTION_H
#define SO_POINTING_ACTION_H
 
#include "SoInteraction.h"
#include "SoPointerPosition.h"
 
#include "triggers/ManagedMouseButtonTrigger.h"
 
class SoViewerProxy;
class SoPointingAction;
class SoInteractionProvider;
class SoInteractionCoordinator;
 
class SoOffsetAction;
 
// typedef for a callback that signals that the controller should release its
// pointing grab
typedef void (*grabReleaseFunc) (SoPointingAction*, void*);

class SOMANAGEDINTERACTION_API SoPointingAction : public SoInteraction
{
  friend class SoInteractionCoordinator;
  friend class SoOffsetPointingAction;
 
public:
  typedef enum {
      AbortAction,   
      FinishAction   
  } StopMode;

  enum {
      Button1Mask    = ManagedMouseButtonTrigger::Button1Mask,     
      Button2Mask    = ManagedMouseButtonTrigger::Button2Mask,     
      Button3Mask    = ManagedMouseButtonTrigger::Button3Mask,     
      AllButtonsMask = ManagedMouseButtonTrigger::AllButtonsMask,  
  };
 
  enum { TypeId = TypePointingAction };

  typedef ManagedMouseButtonTrigger Trigger;

  typedef std::list<Trigger> TriggerList;

  SoPointingAction(SoInteractionOwner* owner, std::string id, bool positionSensitive = true);

  virtual bool isPositionSensitive() const { return _positionSensitive; }

  void clearTriggers() { _triggers.clear(); }

  void setTrigger(int triggerMask, int ignoreMask = 0);

  void setTrigger(const Trigger& trigger);

  void addTrigger(const Trigger& trigger);

  TriggerList getTriggers() const { return _triggers; }

  virtual bool triggersAction(int mask);

  virtual int getNumModes() const { return 1; }

  virtual int getCurrentCursor(SoViewerProxy* /*viewerProxy*/) const { return -1; }

  virtual std::string getCurrentStatusMessage() const { return std::string(); }

  virtual void setMode(int /*mode*/) {}

  virtual bool isSensitiveAt(const SoPointerPosition& pos) = 0;

  virtual void setHighlightAt(const SoPointerPosition& /*pos*/) {}

  virtual void unsetHighlight() {}

  virtual void startPressAt(const SoPointerPosition& pos) = 0;

  virtual void dragMoveTo(const SoPointerPosition& pos) = 0;

  virtual SoPointingAction* endPress(int clickCount) = 0;

  virtual void dragCancelled() { endPress(0); }

  virtual bool wantsMouseOverUpdates() { return false; }

  void grabReleased();

  virtual void releaseGrab(StopMode /*mode*/) {}

  virtual bool wantsImmediateDragUpdates() { return true; }
 
protected:
  // Internal interface, do not override:
  // For SoOffsetPointingAction, this returns the SoOffsetAction that is proxied by this object.
  virtual SoOffsetAction* proxiedOffsetAction() const { return nullptr; }
 
private:
  SoPointingAction(SoInteractionOwner* owner, SoInteraction* mainAction);

  void setGrabReleaseCB (grabReleaseFunc cb, void* data);

  bool _positionSensitive;

  TriggerList _triggers;

  grabReleaseFunc _grabReleaseCB;

  void* _grabReleaseData;
};
 
#endif  // __SoPointingAction_H