vtkSlicerPlaneWidget.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 vtkSlicerPlaneWidget_h
#define vtkSlicerPlaneWidget_h

#include "vtkSlicerMarkupsModuleVTKWidgetsExport.h"
#include "vtkSlicerMarkupsWidget.h"

class vtkSlicerMarkupsWidgetRepresentation;
class vtkPolyData;
class vtkIdList;

class VTK_SLICER_MARKUPS_MODULE_VTKWIDGETS_EXPORT vtkSlicerPlaneWidget : public vtkSlicerMarkupsWidget
{
public:
  static vtkSlicerPlaneWidget *New();

  vtkTypeMacro(vtkSlicerPlaneWidget,vtkSlicerMarkupsWidget);

  vtkSlicerMarkupsWidgetCreateInstanceMacro(vtkSlicerPlaneWidget);

  enum
  {
    WidgetStateTranslatePlane = WidgetStateMarkups_Last, // translating the plane
    WidgetStateSymmetricScale, // Scaling the plane without moving the center
    WidgetStateMarkupsPlane_Last
  };

  enum
  {
    WidgetEventControlPointPlace = WidgetEventMarkups_Last,
    WidgetEventControlPointPlacePlaneNormal,
    WidgetEventPlaneMoveStart,
    WidgetEventPlaneMoveEnd,
    WidgetEventSymmetricScaleStart,
    WidgetEventSymmetricScaleEnd,
    WidgetEventMarkupsPlane_Last
  };

  void CreateDefaultRepresentation(vtkMRMLMarkupsDisplayNode* markupsDisplayNode, vtkMRMLAbstractViewNode* viewNode, vtkRenderer* renderer) override;

  bool PlacePoint(vtkMRMLInteractionEventData* eventData) override;
  virtual bool PlacePlaneNormal(vtkMRMLInteractionEventData* eventData);

  bool CanProcessInteractionEvent(vtkMRMLInteractionEventData* eventData, double& distance2) override;
  bool ProcessInteractionEvent(vtkMRMLInteractionEventData* eventData) override;
  bool ProcessUpdatePlaneFromViewNormal(vtkMRMLInteractionEventData* event);
  bool ProcessPlaneMoveStart(vtkMRMLInteractionEventData* event);
  bool ProcessPlaneMoveEnd(vtkMRMLInteractionEventData* event);
  bool ProcessMouseMove(vtkMRMLInteractionEventData* eventData) override;
  bool ProcessPlaneTranslate(vtkMRMLInteractionEventData* event);
  bool ProcessWidgetSymmetricScaleStart(vtkMRMLInteractionEventData* eventData);
  bool ProcessPlaneSymmetricScale(vtkMRMLInteractionEventData* event);
  bool ProcessEndMouseDrag(vtkMRMLInteractionEventData* eventData) override;
  bool ProcessWidgetStopPlace(vtkMRMLInteractionEventData* eventData) override;

protected:
  vtkSlicerPlaneWidget();
  ~vtkSlicerPlaneWidget() override;

  void ScaleWidget(double eventPos[2]) override;
  virtual void ScaleWidget(double eventPos[2], bool symmetricScale);
  void RotateWidget(double eventPos[2]) override;

  void FlipPlaneHandles(bool flipLRHandle, bool flipAPHandle);

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

#endif