SoInteractionOwner.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2014, 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_OWNER_H
#define SO_INTERACTION_OWNER_H

 
#include "SoInteractionProvider.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <string>
#include <ThirdPartyWarningsRestore.h>
 
class SoInteractionOwner;

class SOMANAGEDINTERACTION_API SoInteractionOwnerListenerInterface
{
public:
  virtual ~SoInteractionOwnerListenerInterface() = default;

  virtual void interactionAdded(SoInteractionOwner* /*owner*/, SoInteraction* /*interaction*/) {}

  virtual void interactionRemoved(SoInteractionOwner* /*owner*/, SoInteraction* /*interaction*/) {}

  virtual void ownerDeleted(SoInteractionOwner* /*owner*/) {}
};

class SOMANAGEDINTERACTION_API SoInteractionOwner : public SoInteractionProvider
{
  friend class SoInteraction;
 
public:
  SoInteractionOwner();

  ~SoInteractionOwner() override;

  virtual void objRef() = 0;
  virtual void objUnref() = 0;

  virtual std::string getID() const;

  std::list<SoInteraction*> getInteractions(SoState* state) override;

  void pointerPosition(SoState* state, const SoPointerPosition& pos) override;

  void pointerLeftWindow(SoState* state) override;

  void addListener(SoInteractionOwnerListenerInterface* listener);

  void removeListener(SoInteractionOwnerListenerInterface* listener);
 
protected:
  virtual void pointerPosition(const SoPointerPosition& /*pos*/) {}

  virtual void pointerLeftWindow() {}

  bool hasInteractions() const { return !_interactions.empty(); }

  template<class T>
  bool hasInteractionsOfType() const;

  void addPointingAction(SoPointingAction*) {};
  void addCommandAction(SoCommandAction*) {};
  void addOffsetAction(SoOffsetAction*) {};
 
private:
  using SoInteractionProvider::pointerPosition;
  using SoInteractionProvider::pointerLeftWindow;

  void addInteraction(SoInteraction* interaction);

  void removeInteraction(SoInteraction* interaction);

  std::list<SoInteraction*> _interactions;

  std::list<SoInteractionOwnerListenerInterface*> _listeners;

  bool _inDestructor;
};
 
template<class T>
bool SoInteractionOwner::hasInteractionsOfType() const
{
  std::list<SoInteraction*>::const_iterator it = _interactions.begin();
  for(;it!=_interactions.end();it++) {
    if ((*it)->isOfType<T>()) {
      return true;
    }
  }
  return false;
}
 
#endif // __SoInteractionOwner_H