vtkSliceViewInteractorStyle.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkSliceViewInteractorStyle.h,v $

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

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

#ifndef __vtkSliceViewInteractorStyle_h
#define __vtkSliceViewInteractorStyle_h

// VTK includes
#include "vtkInteractorStyleUser.h"
#include "vtkMatrix4x4.h"

// MRML includes
#include "vtkMRMLDisplayableManagerExport.h"

class vtkMRMLSegmentationDisplayNode;
class vtkMRMLSliceLogic;

class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkSliceViewInteractorStyle : public vtkInteractorStyleUser
{
public:
  static vtkSliceViewInteractorStyle *New();
  vtkTypeMacro(vtkSliceViewInteractorStyle,vtkInteractorStyleUser);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual void OnMouseMove() VTK_OVERRIDE;
  virtual void OnLeftButtonDown() VTK_OVERRIDE;
  virtual void OnLeftButtonUp() VTK_OVERRIDE;
  virtual void OnMiddleButtonDown() VTK_OVERRIDE;
  virtual void OnMiddleButtonUp() VTK_OVERRIDE;
  virtual void OnRightButtonDown() VTK_OVERRIDE;
  virtual void OnRightButtonUp() VTK_OVERRIDE;
  virtual void OnMouseWheelForward() VTK_OVERRIDE;
  virtual void OnMouseWheelBackward() VTK_OVERRIDE;
  virtual void OnChar() VTK_OVERRIDE;
  virtual void OnKeyPress() VTK_OVERRIDE;
  virtual void OnKeyRelease() VTK_OVERRIDE;
  virtual void OnExpose() VTK_OVERRIDE;
  virtual void OnConfigure() VTK_OVERRIDE;
  virtual void OnEnter() VTK_OVERRIDE;
  virtual void OnLeave() VTK_OVERRIDE;


  enum
    {
    None = 0,
    Translate = 1,
    Zoom = 2,
    Rotate = 4, /* Rotate not currently used */
    Blend = 8, /* fg to bg, labelmap to bg */
    AdjustWindowLevelBackground = 16,
    AdjustWindowLevelForeground = 32,
    BrowseSlice = 64,
    ShowSlice = 128,
    AdjustLightbox = 256,
    SelectVolume = 512,
    SetCursorPosition = 1024, /* adjust cursor position in crosshair node as mouse is moved */
    AllActionsMask = Translate | Zoom | Rotate | Blend | AdjustWindowLevelBackground | AdjustWindowLevelForeground
      | BrowseSlice | ShowSlice | AdjustLightbox | SelectVolume | SetCursorPosition
    };
  vtkGetMacro(ActionState, int);
  vtkSetMacro(ActionState, int);

  void SetActionEnabled(int actionsMask, bool enable = true);
  bool GetActionEnabled(int actionsMask);


  double GetSliceSpacing();
  void IncrementSlice();
  void DecrementSlice();
  void MoveSlice(double delta);
  void ScaleZoom(double zoomScaleFactor);

  void StartTranslate();
  void EndTranslate();

  void StartBlend();
  void EndBlend();

  void StartAdjustWindowLevel();
  void EndAdjustWindowLevel();

  void GetEventXYZ(double xyz[4]);

  void SetSliceLogic(vtkMRMLSliceLogic* SliceLogic);
  vtkGetObjectMacro(SliceLogic, vtkMRMLSliceLogic);

  vtkMRMLSegmentationDisplayNode* GetVisibleSegmentationDisplayNode();

  void CycleVolumeLayer(int layer, int direction);

  void SetLabelOpacity(double opacity);
  double GetLabelOpacity();

protected:

  vtkSliceViewInteractorStyle();
  ~vtkSliceViewInteractorStyle();

  int GetMouseInteractionMode();

  bool IsMouseInsideVolume(bool background);

  bool VolumeWindowLevelEditable(const char* volumeNodeID);

  int ActionState;
  int ActionsEnabled;

  bool ShiftKeyUsedForPreviousAction;

  int StartActionEventPosition[2];
  double StartActionFOV[3];
  double VolumeScalarRange[2];
  vtkMRMLSegmentationDisplayNode* StartActionSegmentationDisplayNode;

  int LastEventPosition[2];
  double LastForegroundOpacity;
  double LastLabelOpacity;
  double LastVolumeWindowLevel[2];

  vtkMRMLSliceLogic *SliceLogic;

private:
  vtkSliceViewInteractorStyle(const vtkSliceViewInteractorStyle&);  
  void operator=(const vtkSliceViewInteractorStyle&);  
};

#endif