albaInteractorGenericMouse.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaInteractorGenericMouse
 Authors: Stefano Perticoni
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 
 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 __albaInteractorGenericMouse_h
#define __albaInteractorGenericMouse_h
 
//----------------------------------------------------------------------------
// Include:
//----------------------------------------------------------------------------
#include "albaInteractorGenericInterface.h"
#include "albaInteractorConstraint.h"
 
//----------------------------------------------------------------------------
//forward ref
//----------------------------------------------------------------------------
class albaDeviceButtonsPadMouse;
class albaMatrix;
 
class vtkCamera;
class vtkDoubleArray;
 
class ALBA_EXPORT albaInteractorGenericMouse : public albaInteractorGenericInterface
{
public:
  albaTypeMacro(albaInteractorGenericMouse, albaInteractor);
  
  //----------------------------------------------------------------------------
  // Actions performed on mouse driven events
  //----------------------------------------------------------------------------
 
  void OnButtonDownAction(int X, int Y);
 
  void OnMouseMoveAction(int X, int Y);
 
  void OnButtonUpAction();
  
  enum MouseAction {MOUSE_DOWN = 0, MOUSE_MOVE, MOUSE_UP};
 
  // modified by Rafael. 9-9-2004
  // Made this function public
  void SendTransformMatrix(const albaMatrix &matrix, int mouseAction = MOUSE_MOVE, double rotationAngle = 0);  
 
  virtual void SetCurrentCamera(vtkCamera *camera) {m_CurrentCamera=camera;}
 
  //----------------------------------------------------------------------------
  // result matrix 
  //----------------------------------------------------------------------------
 
  void SetResultMatrixConcatenationSemanticToPostMultiply() 
       { this->m_ResultMatrixConcatenationSemantic = POSTMULTIPLY; }
  void SetResultMatrixConcatenationSemanticToPreMultiply()
       { this->m_ResultMatrixConcatenationSemantic = POSTMULTIPLY; }
  int  GetResultMatrixConcatenationSemantic()
       { return this->m_ResultMatrixConcatenationSemantic; }
 
  void SetResultMatrixConcatenation(bool active) {this->m_ResultMatrixConcatenation = active;}
  bool GetResultMatrixConcatenation() {return this->m_ResultMatrixConcatenation;};
 
  void ResultMatrixConcatenationOn() {this->m_ResultMatrixConcatenation = true;};
  void ResultMatrixConcatenationOff() {this->m_ResultMatrixConcatenation = false;};
 
protected:
 
  albaInteractorGenericMouse();
  ~albaInteractorGenericMouse();
 
  void EnableTranslationInternal(bool enable);
  void EnableRotationInternal(bool enable);
  void EnableScalingInternal(bool enable);
  void EnableUniformScalingInternal(bool enable);
 
  void Translate(double *p1, double *p2);  
 
  void Rotate(double *p1, double *p2, double *viewup);
 
  void Scale(double *p1, double *p2, double *viewup);
 
  int BinarySearch(double pos, vtkDoubleArray *array, int& helper_point_status);
 
  //----------------------------------------------------------------------------
  //manage the state of the helper point
  //----------------------------------------------------------------------------
 
  // Register the status of the helper point: it could be coincident with
  // one of the grid points (ON_GRID_POINT) or not (NOT_ON_GRID_POINT)
  int m_HelperPointStatus;
 
  enum HELPER_POINT_STATUS
  {
    NOT_ON_GRID_POINT,
    ON_GRID_POINT,
  };
 
  // If m_HelperPointStatus is NOT_ON_GRID_POINT this is the  index of the first array 
  // element on the left of the helper point. If m_HelperPointStatus is ON_GRID_POINT this is 
  // the array index corresponding to the helper point position 
  int m_HelpPIndex;
 
  //the constrain ref sys matrix
  albaMatrix *m_ConstrainRefSys;
 
  //----------------------------------------------------------------------------
  // result matrix: the matrix to keep updated 
  //----------------------------------------------------------------------------
  // Register the pointer to the matrix to be updated
  albaMatrix *m_ResultMatrix;
  
  int m_ResultMatrixConcatenationSemantic;
 
  enum
  {
    PREMULTIPLY,
    POSTMULTIPLY,  
  };
 
  //----------------------------------------------------------------------------
  // trackball interaction style stuff 
  //----------------------------------------------------------------------------
 
   virtual void TrackballRotate();
   virtual void TrackballTranslate();
   virtual void TrackballRoll();
 
  //----------------------------------------------------------------------------
  // snap on surface
  //----------------------------------------------------------------------------
  void SnapOnSurface();
 
 
   //----------------------------------------------------------------------------
   // normal on surface
   //----------------------------------------------------------------------------
   void NormalOnSurface();
 
   //----------------------------------------------------------------------------
   // trackball interaction style stuff 
   //----------------------------------------------------------------------------
 
   int m_LastX, m_LastY;
 
   //----------------------------------------------------------------------------
 
   int m_MousePointer2DPosition[2];
   int m_LastMousePointer2DPosition[2];
 
   vtkCamera *m_CurrentCamera; 
 
   double  m_LastPickPosition[3];
 
private:
 
  albaInteractorGenericMouse(const albaInteractorGenericMouse&);  // Not implemented.
  void operator=(const albaInteractorGenericMouse&);   // Not implemented.
           
  // Projection Accumulator; accumulates projections of the motion
  // vector along mouse move events 
  //   
  // P1  P2   P3      PN
  // ->----->----->-------->
  // -------m_ProjectionAccumulator-------->
  //
  double m_ProjectionAccumulator;
 
  void SendTransformMatrix(double *versor, double translation, int mouseAction = MOUSE_MOVE);
  void SendTransformMatrix(double *vector, int mouseAction = MOUSE_MOVE);
 
  void ConcatenateToResultMatrix(const albaMatrix &matrix);
 
  bool m_ResultMatrixConcatenation;
 
};
#endif