vtkSlicerComponentGUI.h

Go to the documentation of this file.

#ifndef __vtkSlicerComponentGUI_h
#define __vtkSlicerComponentGUI_h

#include "vtkObject.h"
#include "vtkKWObject.h"
#include "vtkSlicerBaseGUIWin32Header.h"
#include "vtkSlicerApplicationLogic.h"
#include "vtkMRMLScene.h"
#include "vtkMRMLNode.h"
#include "vtkSlicerLogic.h"
#include "vtkObserverManager.h"


class vtkCallbackCommmand;
class vtkSlicerGUIUpdate;
class vtkSlicerLogicUpdate;
class vtkSlicerMRMLUpdate;
class vtkKWApplication;
class vtkKWFrame;


//BTX

#ifndef vtkSetMRMLNodeMacro
#define vtkSetMRMLNodeMacro(node,value)  { \
  vtkObject *oldNode = (node); \
  this->MRMLObserverManager->SetObject ( vtkObjectPointer( &(node)), (value) ); \
  if ( oldNode != (node) ) \
    { \
    this->InvokeEvent (vtkCommand::ModifiedEvent); \
    } \
};
#endif

#ifndef vtkSetAndObserveMRMLNodeMacro
#define vtkSetAndObserveMRMLNodeMacro(node,value)  { \
  vtkObject *oldNode = (node); \
  this->MRMLObserverManager->SetAndObserveObject ( vtkObjectPointer( &(node) ), (value) ); \
  if ( oldNode != (node) ) \
    { \
    this->InvokeEvent (vtkCommand::ModifiedEvent); \
    } \
};
#endif

#ifndef vtkSetAndObserveMRMLNodeEventsMacro
#define vtkSetAndObserveMRMLNodeEventsMacro(node,value,events)  { \
  vtkObject *oldNode = (node); \
  this->MRMLObserverManager->SetAndObserveObjectEvents ( vtkObjectPointer( &(node)), (value), (events)); \
  if ( oldNode != (node) ) \
    { \
    this->InvokeEvent (vtkCommand::ModifiedEvent); \
    } \
};
#endif

//ETX

//
class VTK_SLICER_BASE_GUI_EXPORT vtkSlicerComponentGUI : public vtkKWObject
{

public:
  static vtkSlicerComponentGUI* New ( );
  vtkTypeRevisionMacro ( vtkSlicerComponentGUI, vtkKWObject );
  void PrintSelf ( ostream& os, vtkIndent indent );

  vtkGetObjectMacro ( ApplicationLogic, vtkSlicerApplicationLogic );
  virtual void SetApplicationLogic ( vtkSlicerApplicationLogic *logic )
    { this->SetLogic ( vtkObjectPointer (&this->ApplicationLogic), logic );};
  void SetAndObserveApplicationLogic ( vtkSlicerApplicationLogic *logic )
    { this->SetAndObserveLogic ( vtkObjectPointer (&this->ApplicationLogic) , logic ); };

  vtkGetObjectMacro ( MRMLScene, vtkMRMLScene );
  
  void SetMRMLScene ( vtkMRMLScene *mrml )
    {
    vtkObject *oldValue = this->MRMLScene;
    this->MRMLObserverManager->SetObject ( vtkObjectPointer( &this->MRMLScene), mrml );
    if ( oldValue != this->MRMLScene )
      {
      this->InvokeEvent (vtkCommand::ModifiedEvent);
      }
    }

  void SetAndObserveMRMLScene ( vtkMRMLScene *mrml )
    {
    vtkObject *oldValue = this->MRMLScene;
    this->MRMLObserverManager->SetAndObserveObject ( vtkObjectPointer( &this->MRMLScene), mrml );
    if ( oldValue != this->MRMLScene )
      {
      this->InvokeEvent (vtkCommand::ModifiedEvent);
      }
    }

  void SetAndObserveMRMLSceneEvents ( vtkMRMLScene *mrml, vtkIntArray *events )
    {
    vtkObject *oldValue = this->MRMLScene;
    this->MRMLObserverManager->SetAndObserveObjectEvents ( vtkObjectPointer( &this->MRMLScene), mrml, events );
    if ( oldValue != this->MRMLScene )
      {
      this->InvokeEvent (vtkCommand::ModifiedEvent);
      }
    }
  
  void SetLogic ( vtkObject **logicPtr, vtkObject *logic );
  void SetAndObserveLogic ( vtkObject **logicPtr, vtkObject *logic );
  
  virtual void AddGUIObservers ( ) { };
  virtual void RemoveGUIObservers ( ) { };
  
  vtkGetObjectMacro (LogicCallbackCommand, vtkCallbackCommand);
  vtkGetObjectMacro (GUICallbackCommand, vtkCallbackCommand);
  
  void SetInLogicCallbackFlag (int flag) {
    this->InLogicCallbackFlag = flag;
  }
  vtkGetMacro(InLogicCallbackFlag, int);
  void SetInMRMLCallbackFlag (int flag) {
    this->InMRMLCallbackFlag = flag;
  }
  vtkGetMacro(InMRMLCallbackFlag, int);
  void SetInGUICallbackFlag (int flag) {
    this->InGUICallbackFlag = flag;
    }
  vtkGetMacro(InGUICallbackFlag, int);
  
  vtkSetStringMacro ( GUIName );
  vtkGetStringMacro ( GUIName );
  
  virtual void BuildGUI ( void ) { }
  virtual void BuildGUI ( vtkKWFrame * vtkNotUsed(f) ) {}
  virtual void BuildGUI ( vtkKWFrame * vtkNotUsed(f), double * vtkNotUsed(bgColor) ) {}

  virtual void TearDownGUI ( ) { };
  
  virtual void ProcessLogicEvents ( vtkObject * /*caller*/,
                                    unsigned long /*event*/, void * /*callData*/ ) { };
  virtual void ProcessGUIEvents ( vtkObject * /*caller*/, 
                                  unsigned long /*event*/, void * /*callData*/ ) { };
  
  virtual void ProcessMRMLEvents ( vtkObject * /*caller*/, 
                                   unsigned long /*event*/, void * /*callData*/ ) { };
  
  virtual void Enter ( ) { }
  virtual void Exit ( ) { }
  virtual void Enter ( vtkMRMLNode* vtkNotUsed(node) ) { this->Enter(); }
  
protected:
  vtkSlicerApplicationLogic *ApplicationLogic;
  vtkMRMLScene *MRMLScene;
  
  char *GUIName;
  
  //BTX
  static void MRMLCallback( vtkObject *__caller,
                            unsigned long eid, void *__clientData, void *callData );
  static void LogicCallback( vtkObject *__caller,
                             unsigned long eid, void *__clientData, void *callData );
  static void GUICallback( vtkObject *__caller,
                           unsigned long eid, void *__clientData, void *callData );    
  //ETX
  
  vtkCallbackCommand *LogicCallbackCommand;
  vtkCallbackCommand *GUICallbackCommand;
  vtkCallbackCommand *MRMLCallbackCommand;
  
  vtkSlicerComponentGUI ( );
  virtual ~vtkSlicerComponentGUI ( );
  
  int InLogicCallbackFlag;
  int InMRMLCallbackFlag;
  int InGUICallbackFlag;
  
  vtkObserverManager *MRMLObserverManager;
  
private:
  vtkSlicerComponentGUI ( const vtkSlicerComponentGUI& ); 
  void operator = ( const vtkSlicerComponentGUI& ); 
};


#endif