vtkMRMLCameraWidget.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 vtkMRMLCameraWidget_h
#define vtkMRMLCameraWidget_h

#include "vtkMRMLDisplayableManagerExport.h" // For export macro
#include "vtkMRMLAbstractWidget.h"
#include "vtkMRMLCameraNode.h"

class vtkSliceIntersectionRepresentation2D;
class vtkMRMLSegmentationDisplayNode;


class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLCameraWidget : public vtkMRMLAbstractWidget
{
public:
  static vtkMRMLCameraWidget *New();


  vtkTypeMacro(vtkMRMLCameraWidget, vtkMRMLAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void CreateDefaultRepresentation();

  void SetCameraNode(vtkMRMLCameraNode* cameraNode);
  vtkMRMLCameraNode* GetCameraNode();

  bool CanProcessInteractionEvent(vtkMRMLInteractionEventData* eventData, double &distance2) override;

  bool ProcessInteractionEvent(vtkMRMLInteractionEventData* eventData) override;

  bool GetTiltLocked();
  void SetTiltLocked(bool lockState);

  enum
    {
    WidgetStateMoveCrosshair = WidgetStateUser, 
    WidgetStateSpin,
    WidgetStateTouchGesture
    };

  enum
    {
    WidgetEventSpinStart = WidgetEventUser,
    WidgetEventSpinEnd,

    WidgetEventMoveCrosshairStart,
    WidgetEventMoveCrosshairEnd,

    WidgetEventCameraRotateToRight,
    WidgetEventCameraRotateToLeft,
    WidgetEventCameraRotateToAnterior,
    WidgetEventCameraRotateToPosterior,
    WidgetEventCameraRotateToSuperior,
    WidgetEventCameraRotateToInferior,

    WidgetEventCameraTranslateForwardX,
    WidgetEventCameraTranslateBackwardX,
    WidgetEventCameraTranslateForwardY,
    WidgetEventCameraTranslateBackwardY,
    WidgetEventCameraTranslateForwardZ,
    WidgetEventCameraTranslateBackwardZ,

    WidgetEventCameraRotateCcwX,
    WidgetEventCameraRotateCwX,
    WidgetEventCameraRotateCcwY,
    WidgetEventCameraRotateCwY,
    WidgetEventCameraRotateCcwZ,
    WidgetEventCameraRotateCwZ,

    WidgetEventCameraZoomIn,
    WidgetEventCameraZoomOut,
    WidgetEventCameraWheelZoomIn, // same as WidgetEventCameraZoomIn but with using wheel scaling factor
    WidgetEventCameraWheelZoomOut,

    WidgetEventToggleCameraTiltLock,

    WidgetEventCameraReset,
    WidgetEventCameraResetTranslation,
    WidgetEventCameraResetRotation,
    WidgetEventCameraResetFieldOfView, // VTK's standard camera reset (centers and resets field of view)

    WidgetEventCameraRotate,
    WidgetEventCameraPan,

    WidgetEventTouchGestureStart,
    WidgetEventTouchGestureEnd,
    WidgetEventTouchSpinCamera,
    WidgetEventTouchPinchZoom,
    WidgetEventTouchPanTranslate,

    WidgetEventSetCrosshairPosition,
    WidgetEventSetCrosshairPositionBackground, //< set crosshair position without consuming the event (so that other widgets can process the event)
    WidgetEventMaximizeView,
    };

  vtkGetMacro(MotionFactor, double);
  vtkSetMacro(MotionFactor, double);

  vtkGetMacro(MouseWheelMotionFactor, double);
  vtkSetMacro(MouseWheelMotionFactor, double);

protected:
  vtkMRMLCameraWidget();
  ~vtkMRMLCameraWidget() override;

  bool ProcessStartMouseDrag(vtkMRMLInteractionEventData* eventData);
  bool ProcessMouseMove(vtkMRMLInteractionEventData* eventData);
  bool ProcessEndMouseDrag(vtkMRMLInteractionEventData* eventData);

  bool ProcessTranslate(vtkMRMLInteractionEventData* eventData);
  bool ProcessRotate(vtkMRMLInteractionEventData* eventData);
  bool ProcessScale(vtkMRMLInteractionEventData* eventData);
  bool ProcessSpin(vtkMRMLInteractionEventData* eventData);
  bool ProcessSetCrosshair(vtkMRMLInteractionEventData* eventData);
  bool ProcessSetCrosshairBackground(vtkMRMLInteractionEventData* eventData);

  bool ProcessTouchGestureStart(vtkMRMLInteractionEventData* eventData);
  bool ProcessTouchGestureEnd(vtkMRMLInteractionEventData* eventData);
  bool ProcessTouchCameraSpin(vtkMRMLInteractionEventData* eventData);
  bool ProcessTouchCameraZoom(vtkMRMLInteractionEventData* eventData);
  bool ProcessTouchCameraTranslate(vtkMRMLInteractionEventData* eventData);

  bool ProcessWidgetMenu(vtkMRMLInteractionEventData* eventData);

  bool ProcessMaximizeView(vtkMRMLInteractionEventData* eventData);

  bool Dolly(double factor);
  vtkCamera* GetCamera();

  bool CameraModifyStart();
  void CameraModifyEnd(bool wasModified, bool updateClippingRange, bool updateLights);

  void SaveStateForUndo();

  double MotionFactor;
  double MouseWheelMotionFactor;
  bool CameraTiltLocked;

  vtkWeakPointer<vtkMRMLCameraNode> CameraNode;

  double StartEventPosition[2];
  int PreviousEventPosition[2];

  bool ModifierKeyPressedSinceLastClickAndDrag;


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

#endif