albaInteractor.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaInteractor
 Authors: Marco Petrone
 
 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 __albaInteractor_h
#define __albaInteractor_h
 
#include "albaAgent.h"
#include "albaString.h"
#include "vtkALBASmartPointer.h"
 
//----------------------------------------------------------------------------
// forward declarations :
//----------------------------------------------------------------------------
class albaDevice;
class albaEventInteraction;
class albaVME;
class albaMatrix;
 
class vtkRenderer;
class vtkProp3D;
 
class ALBA_EXPORT albaInteractor : public albaAgent
{
public:
  albaInteractor();
  virtual ~albaInteractor();
 
  //------------------------------------------------------------------------------
  // Events
  //------------------------------------------------------------------------------
  ALBA_ID_DEC(INTERACTION_STARTED); 
  ALBA_ID_DEC(INTERACTION_STOPPED); 
  ALBA_ID_DEC(BUTTON_DOWN);         
  ALBA_ID_DEC(BUTTON_UP);           
 
  albaAbstractTypeMacro(albaInteractor,albaAgent);
 
  virtual void SetRendererAndView(vtkRenderer *ren, albaView *view);
  vtkRenderer *GetRenderer() {return m_Renderer;}
   albaView *GetView() {return m_View;}
 
  albaDevice *GetDevice() {return m_Device;}
  virtual void SetDevice(albaDevice *);
 
  virtual void SetVME(albaVME *vme);
 
  void SetProp(vtkProp3D *prop);
 
  void SetIgnoreTriggerEvents(bool flag) {m_IgnoreTriggerEvents=flag;}
  int GetIgnoreTriggerEvents(bool flag) {return m_IgnoreTriggerEvents;}
  void IgnoreTriggerEventsOn() {SetIgnoreTriggerEvents(true);}
  void IgnoreTriggerEventsOff() {SetIgnoreTriggerEvents(false);}
 
  void SetStartInteractionEvent(albaID event) {m_StartInteractionEvent=event;}
  albaID GetStartInteractionEvent() {return m_StartInteractionEvent;}
  
  void SetStopInteractionEvent(albaID event) {m_StopInteractionEvent=event;}
  albaID GetStopInteractionEvent() {return m_StopInteractionEvent;}
 
  void SetStartButton(int btn) {m_StartButton=btn;}
  int GetStartButton() {return m_StartButton;}
 
  void SetModifiers(int mod) {m_Modifiers=mod;}
  int GetModifiers() {return m_Modifiers;}
 
  int GetCurrentButton() {return m_CurrentButton;}
 
  unsigned long GetCurrentModifier() {return m_CurrentModifier;}
 
  virtual int StartInteraction(albaDevice *device);
  
  virtual int StopInteraction(albaDevice *device);
 
  virtual bool IsInteracting();
 
  virtual bool IsInteracting(albaDevice *device);
 
  enum modalities {SINGLE_BUTTON_MODE=0,MULTI_BUTTON_MODE};
 
  void SetButtonMode(int mode) {m_ButtonMode=mode;}
  int GetButtonMode() {return m_ButtonMode;}
  void SetButtonModeToSingleButton() {m_ButtonMode=SINGLE_BUTTON_MODE;}
  void SetButtonModeToMultiButton() {m_ButtonMode=MULTI_BUTTON_MODE;}
 
    
  virtual void OnEvent(albaEventBase *event);
 
  void TestModeOn() {m_TestMode = true;};
 
  void TestModeOff() {m_TestMode = false;};
 
  bool GetTestMode(){return m_TestMode;};
 
protected:
 
  virtual int OnStartInteraction(albaEventInteraction *e);
 
  virtual int OnStopInteraction(albaEventInteraction *e);
 
  virtual void OnButtonDown       (albaEventInteraction *e);
  virtual void OnButtonUp         (albaEventInteraction *e);
 
  void ComputeDisplayToWorld(double x, double y, double z, double worldPt[4]);
  void ComputeWorldToDisplay(double x, double y, double z, double displayPt[3]);
 
 
//  virtual bool FindPokedVme(albaDevice *device,albaMatrix &point_pose,vtkProp3D *&picked_prop,albaVME *&picked_vme,albaInteractor *&picked_behavior);
 
 
  albaDevice     *m_Device;
 
  bool          m_DeviceIsSet;          
  albaID         m_StartInteractionEvent;
  albaID         m_StopInteractionEvent; 
  int           m_IgnoreTriggerEvents;  
  int           m_InteractionFlag;      
  int           m_StartButton;          
  unsigned long m_Modifiers;            
  int           m_CurrentButton;        
  unsigned long m_CurrentModifier;      
  int           m_ButtonMode;           
  int           m_ButtonsCounter;       
 
  albaVME       *m_VME;                  
   albaView       *m_View;                       
 
  vtkALBASmartPointer<vtkRenderer> m_Renderer; 
   vtkALBASmartPointer<vtkProp3D>   m_Prop;     
 
  bool m_TestMode;
 
private:
  albaInteractor(const albaInteractor&);  // Not implemented.
  void operator=(const albaInteractor&);  // Not implemented.
};
 
#endif