SoInteraction.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_H
#define SO_INTERACTION_H
 
#include "SoManagedInteractionSystem.h"
#include <ThirdPartyWarningsDisable.h>
#include <string>
#include <list>
#include <ThirdPartyWarningsRestore.h>
 
#include "triggers/ManagedActionTrigger.h"
 
class SoInteractionOwner;
 
class SOMANAGEDINTERACTION_API SoInteraction
{
public:
  enum {
    NoModifier       = ManagedActionTrigger::NoModifier,
    ShiftModifier    = ManagedActionTrigger::ShiftModifier,
    ControlModifier  = ManagedActionTrigger::ControlModifier,
    AltModifier      = ManagedActionTrigger::AltModifier,
    AllModifiersMask = ManagedActionTrigger::AllModifiersMask,
    // deprecated values:
    ShiftMask        = ShiftModifier,
    CtrlMask         = ControlModifier,
    AltMask          = AltModifier
  };
 
  enum InteractionType {
    TypePointingAction,
    TypeCommandAction,
    TypeOffsetAction
  };
 
 
  SoInteraction(InteractionType type, SoInteractionOwner* owner, const std::string& id, bool registerWithOwner = true);
 
  virtual ~SoInteraction();
 
  SoInteractionOwner* getOwner() const { return _owner; }
 
  virtual bool isEnabled() const         { return _enabled; }
  virtual void setEnabled(bool enabled)  { _enabled = enabled; touch(); }
 
  std::string getID() const  { return _id; }
  void setID(const std::string& id) { _id = id; touch(); }
 
  std::string getFullID() const;
 
  int getMenuPriority() const         { return _menuPriority; }
  void setMenuPriority(int priority)  { _menuPriority = priority; touch(); }
 
  virtual std::string getUserName() const            { return _userName; }
  virtual void setUserName(const std::string& name)  { _userName = name; touch(); }
 
  virtual std::string getIconFile() const            { return _iconFile; }
  virtual void setIconFile(const std::string& file)  { _iconFile = file; touch(); }
 
  virtual std::string getDescription() const             { return _description;  }
  virtual void setDescription(const std::string& descr)  { _description = descr; touch(); }
 
  InteractionType getInteractionType() const { return _interactionType; }
 
  template<class T>
  inline bool isOfType() const { return static_cast<int>(_interactionType) == T::TypeId; }
 
  virtual void ref();
  virtual void unref();
 
  int getStateVersion() const { return _stateVersion; }
 
  void touch();
 
 
private:
  SoInteractionOwner* _owner;
  InteractionType _interactionType;
 
  int _stateVersion;
  std::string _id;
  std::string _userName;
  std::string _iconFile;
  std::string _description;
  int _menuPriority;
  bool _enabled;
};
 
typedef SoInteraction SoInteractionEntry;
 
#endif  // __SoInteraction_H