vtkMRMLViewInteractorStyle.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

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

#ifndef __vtkMRMLViewInteractorStyle_h
#define __vtkMRMLViewInteractorStyle_h

// VTK includes
#include "vtkInteractorStyle3D.h"
#include "vtkSmartPointer.h"
#include "vtkWeakPointer.h"

// MRML includes
#include "vtkMRMLDisplayableManagerExport.h"

class vtkMRMLAbstractDisplayableManager;
class vtkMRMLDisplayableManagerGroup;
class vtkMRMLInteractionEventData;
class vtkTimerLog;

class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLViewInteractorStyle :
  public vtkInteractorStyle3D
{
public:
  static vtkMRMLViewInteractorStyle *New();
  vtkTypeMacro(vtkMRMLViewInteractorStyle,vtkInteractorStyle3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void OnMouseMove() override;
  void OnEnter() override;
  void OnLeave() override;
  void OnLeftButtonDown() override;
  void OnLeftButtonUp() override;
  void OnMiddleButtonDown() override;
  void OnMiddleButtonUp() override;
  void OnRightButtonDown() override;
  void OnRightButtonUp() override;
  void OnMouseWheelForward() override;
  void OnMouseWheelBackward() override;

  // Touch gesture interaction events
  void OnPinch() override;
  void OnRotate() override;
  void OnPan() override;
  void OnTap() override;
  void OnLongTap() override;

  void OnChar() override;
  void OnKeyPress() override;
  void OnKeyRelease() override;

  void OnButton3D(vtkEventData* eventData) override;
  void OnMove3D(vtkEventData* eventData) override;

  void OnExpose() override;
  void OnConfigure() override;

  void SetDisplayableManagers(vtkMRMLDisplayableManagerGroup* displayableManagers);

  virtual bool DelegateInteractionEventToDisplayableManagers(unsigned long event);

  virtual bool DelegateInteractionEventToDisplayableManagers(vtkEventData* inputEventData);

  virtual bool DelegateInteractionEventDataToDisplayableManagers(vtkMRMLInteractionEventData* eventData);

  void SetInteractor(vtkRenderWindowInteractor *interactor) override;

protected:
  vtkMRMLViewInteractorStyle();
  ~vtkMRMLViewInteractorStyle() override;

  static void CustomProcessEvents(vtkObject* object, unsigned long event, void* clientdata, void* calldata);

  void SetMouseCursor(int cursor);

  bool MouseMovedSinceButtonDown;

  vtkSmartPointer<vtkTimerLog> ClickTimer;
  int NumberOfClicks;
  double DoubleClickIntervalTimeSec;

  vtkWeakPointer<vtkMRMLDisplayableManagerGroup> DisplayableManagers;
  vtkMRMLAbstractDisplayableManager* FocusedDisplayableManager;

private:
  vtkMRMLViewInteractorStyle(const vtkMRMLViewInteractorStyle&) = delete;
  void operator=(const vtkMRMLViewInteractorStyle&) = delete;
};

#endif