albaInteractorConstraint.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaInteractorConstraint
 Authors: Marco Petrone, 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 __albaInteractorConstraint_h
#define __albaInteractorConstraint_h
 
#include "vtkALBASmartPointer.h"
#include "vtkDoubleArray.h"
//----------------------------------------------------------------------------
// forward declarations :
//----------------------------------------------------------------------------
class albaRefSys;
 
//----------------------------------------------------------------------------
 
class ALBA_EXPORT albaInteractorConstraint
{
public:
  albaInteractorConstraint();
  virtual ~albaInteractorConstraint();
 
  albaInteractorConstraint(const albaInteractorConstraint& source);
 
  //----------------------------------------------------------------------------
  // Enums
  //----------------------------------------------------------------------------
 
  enum AXIS
  {
    X = 0,
    Y,
    Z,  
    NUM_AXES,
  };
 
  enum PLANE
  {
    XY = 0,
    XZ,
    YZ,
    NUM_PLANES,
  };
 
  enum CONSTRAINT_MODALITY
  {
    LOCK = 0,    // <No movement is allowed on/around the given axis
    FREE,        // <Move freely on/around the given axis
    BOUNDS,      // <Bounds constraint
    SNAP_STEP,   // <Snap on a given interval by a given step
    SNAP_ARRAY,  // <Snap on values provided in a given double array
  };
 
  //----------------------------------------------------------------------------
  // Constraint modality settings
  //----------------------------------------------------------------------------
 
  void SetConstraintModality(int constraintModalityOnX, int constraintModalityOnY, int constraintModalityOnZ); 
 
  void SetConstraintModality(int axis, int constrainModality);
 
  int GetConstraintModality(int axis);
 
  int GetNumberOfDOF();
  
  int GetConstraintAxis();   
 
  int GetConstraintPlane();
 
  int GetConstraintPlaneAxes(int& axis1, int& axis2);
 
  void Reset();
    
  //----------------------------------------------------------------------------
  // BOUNDS modality settings
  //----------------------------------------------------------------------------
 
  void SetLowerBound(int axis, double lbound);
 
  double GetLowerBound(int axis);
 
  void SetUpperBound(int axis, double ubound);
 
  double GetUpperBound(int axis);
 
  void SetBounds(int axis, double *bounds);
 
  void GetBounds(int axis, double *bounds);
 
  //----------------------------------------------------------------------------
  // SNAP_STEP modality settings
  //----------------------------------------------------------------------------
 
  void SetMin(int axis, double min);
      
  double GetMin(int axis);
 
  void SetMax(int axis, double min);
      
  double GetMax(int axis);
  
  void SetStep(int axis, double step);
      
  double GetStep(int axis); 
 
  void SetSnapStep(int axis, double min,double max, double step);
  
  //----------------------------------------------------------------------------
  // SNAP_ARRAY modality settings
  //----------------------------------------------------------------------------
 
  void SetSnapArray(int axis, vtkDoubleArray *array);
       
  vtkDoubleArray *GetSnapArray(int axis);
 
  //----------------------------------------------------------------------------
  // Reference system settings
  //----------------------------------------------------------------------------
  
  albaRefSys *GetRefSys();
 
  void SetRefSys(albaRefSys *ref_sys);
  void SetRefSys(albaRefSys &ref_sys);
   
  //----------------------------------------------------------------------------
 
  void Print(std::ostream& os, const int tabs);
 
  void DeepCopy(const albaInteractorConstraint *source) { *this=*source;}
 
protected:
 
  albaRefSys *m_RefSys;
  
  int m_ConstraintModality[3];
 
  double m_LowerBound[3];
  double m_UpperBound[3];
 
  double m_Min[3];
  double m_Max[3];
  double m_Step[3];
 
  vtkALBAAutoPointer<vtkDoubleArray> m_SnapArray[3];
  
};
 
#endif