vtkMRMLInteractionWidget.h

Go to the documentation of this file.

/*==============================================================================
 
  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.
 
  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.
 
  This file was originally developed by Kyle Sunderland, PerkLab, Queen's University
  and was supported through CANARIE's Research Software Program, Cancer
  Care Ontario, OpenAnatomy, and Brigham and Women's Hospital through NIH grant R01MH112748.
 
==============================================================================*/
 
 
#ifndef vtkMRMLInteractionWidget_h
#define vtkMRMLInteractionWidget_h
 
// MRMLDisplayableManager includes
#include "vtkMRMLDisplayableManagerExport.h"
#include "vtkMRMLAbstractWidget.h"
 
// MRML includes
#include <vtkMRMLNode.h>
 
class vtkMRMLAbstractViewNode;
class vtkMRMLApplicationLogic;
class vtkMRMLDisplayNode;
class vtkMRMLDisplayableNode;
class vtkMRMLInteractionEventData;
class vtkMRMLInteractionNode;
class vtkIdList;
class vtkPolyData;
class vtkMRMLInteractionWidgetRepresentation;
class vtkTransform;
 
class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLInteractionWidget
  : public vtkMRMLAbstractWidget
{
public:
  vtkTypeMacro(vtkMRMLInteractionWidget, vtkMRMLAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum
  {
    InteractionNone,
    InteractionTranslationHandle,
    InteractionRotationHandle,
    InteractionScaleHandle,
  };
 
  enum
  {
    WidgetStateInteraction_First = WidgetStateUser,
    WidgetStateOnTranslationHandle = WidgetStateInteraction_First, // hovering over a translation interaction handle
    WidgetStateOnRotationHandle, // hovering over a rotation interaction handle
    WidgetStateOnScaleHandle, // hovering over a scale interaction handle
    WidgetStateUniformScale, // uniform scaling
    WidgetStateInteraction_Last
  };
 
  enum
  {
    WidgetEventInteraction_First = WidgetEventUser,
    WidgetEventReserved = WidgetEventInteraction_First,  // this events is only to prevent other widgets from processing an event
    WidgetEventUniformScaleStart,
    WidgetEventUniformScaleEnd,
    WidgetEventCancel,
    WidgetEventInteraction_Last
  };
 
  virtual int GetActiveComponentType();
  virtual void SetActiveComponentType(int type);
 
  virtual int GetActiveComponentIndex();
  virtual void SetActiveComponentIndex(int index);
 
  bool CanProcessInteractionEvent(vtkMRMLInteractionEventData* eventData, double &distance2) override;
 
  bool ProcessInteractionEvent(vtkMRMLInteractionEventData* eventData) override;
 
  void Leave(vtkMRMLInteractionEventData* eventData) override;
 
  bool GetInteractive() override;
  int GetMouseCursor() override;
 
protected:
  vtkMRMLInteractionWidget();
  ~vtkMRMLInteractionWidget() override;
 
  void StartWidgetInteraction(vtkMRMLInteractionEventData* eventData);
  void EndWidgetInteraction();
 
  virtual void TranslateWidget(double eventPos[2]);
  virtual void ScaleWidget(double eventPos[2], bool uniform=false);
  virtual void RotateWidget(double eventPos[2]);
  virtual void ApplyTransform(vtkTransform* transform) = 0;
 
  int PreviewPointIndex;
 
  virtual bool ProcessMouseMove(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessWidgetMenu(vtkMRMLInteractionEventData* eventData) = 0;
  virtual bool ProcessWidgetMenuDisplayNodeTypeAndIndex(vtkMRMLInteractionEventData* eventData, vtkMRMLDisplayNode* displayNode, int type, int index);
  virtual bool ProcessWidgetTranslateStart(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessWidgetRotateStart(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessWidgetScaleStart(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessWidgetUniformScaleStart(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessEndMouseDrag(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessJumpCursor(vtkMRMLInteractionEventData* eventData);
  virtual bool ProcessCancelEvent(vtkMRMLInteractionEventData* eventData);
 
  virtual vtkMRMLNode* GetMRMLNode() = 0;
  virtual void SaveInitialState();
  virtual void RestoreInitialState();
 
  // Jump to the handle position for the given type and index. Returns true if successful.
  virtual bool JumpToHandlePosition(int type, int index);
 
  virtual bool GetClosestPointOnInteractionAxis(int type, int index, const double inputDisplay[2], double outputIntersectionWorld[3]);
 
  virtual bool GetIntersectionOnAxisPlane(int type, int index, const double inputDisplay[2], double outputIntersectionWorld[3]);
 
  double LastEventPosition[2];
 
  vtkSmartPointer<vtkMRMLNode> OriginalStateNode{ nullptr };
 
private:
  vtkMRMLInteractionWidget(const vtkMRMLInteractionWidget&) = delete;
  void operator=(const vtkMRMLInteractionWidget&) = delete;
};
 
#endif