niftkFilteringStateMachine.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkFilteringStateMachine_h
#define niftkFilteringStateMachine_h

#include "niftkMIDASExports.h"

#include <vector>

#include <mitkInteractionEvent.h>
#include <mitkStateEvent.h>

namespace niftk
{

class StateMachineEventFilter;

class NIFTKMIDAS_EXPORT FilteringStateMachine
{

public:

  FilteringStateMachine();

  virtual ~FilteringStateMachine();

  float CanHandleEvent(const mitk::StateEvent* event) const;

  bool CanHandleEvent(mitk::InteractionEvent* event);

  virtual void InstallEventFilter(StateMachineEventFilter* eventFilter);

  virtual void RemoveEventFilter(StateMachineEventFilter* eventFilter);

  std::vector<StateMachineEventFilter*> GetEventFilters() const;

  bool IsFiltered(const mitk::StateEvent* stateEvent) const;

  bool IsFiltered(mitk::InteractionEvent* event);

protected:

  virtual float CanHandle(const mitk::StateEvent* stateEvent) const
  {
    return 1.0;
  }

  virtual bool CanHandle(mitk::InteractionEvent* event)
  {
    return true;
  }

private:

  std::vector<StateMachineEventFilter*> m_EventFilters;

};

}

#endif