mlVTKModule.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#pragma once
 
// Include dll-specific settings.
#include "mlInitSystemVTKSupport.h"
 
// Include most ml specific things.
#include "mlModuleIncludes.h"
 
// Include vtkObject class which is a base class of all automatically VTK
// objects which potentially can be observed.
#include <vtkObject.h>
 
// Include support for subject/observer design pattern of VTK.
#include <vtkCallbackCommand.h>
 
// Include the class for dummy polygon data source used as placeholder for NULL polygon data sources.
#include "vtkPolyDataAlgorithm.h"
 
 
ML_START_NAMESPACE
   
  //----------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------
  class MLVTK_SUPPORT_EXPORT VTKModule : public Module
  {
  public:

    VTKModule(int inputNum=0, int outputNum=0);

    virtual ~VTKModule();

    void       suppressHandleVTKObjectCalls(bool suppress);

    bool       areHandleVTKObjectCallsSuppressed();
 
  protected:

    void       setManagedObject(vtkObject *vObj);

    vtkObject *getManagedObject();
 

    void       setObservedObject(vtkObject *vObj, 
                                 vtkCommand::EventIds eventId=vtkCommand::AnyEvent, 
                                 float priority = 0.0f);

    vtkObject *getObservedObject();
 

    virtual void handleVTKObject(vtkObject * /*caller*/,  
                                 unsigned long /*eventId*/, 
                                 void * /*callData*/) { };

    std::string getInputCheckString() const;

    vtkPolyDataAlgorithm *getDummyPolyDataAlgorithm(int polyType = 0);
    
  private:

    virtual void _handleManagedVTKObject(vtkObject *caller,  
                                         unsigned long eventId, 
                                         void *callData);

    static void _vtkCallbackFunc(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata);

    static void _vtkManagedCallbackFunc(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata);
 

    bool                _suppressHandleVTKObjectCalls;

    vtkCallbackCommand *_observer;

    vtkObject          *_observedObject;

    vtkObject          *_managedObject;

    vtkCallbackCommand **_managedObservers;

    ML_MODULE_CLASS_HEADER(VTKModule);
  };
 
ML_END_NAMESPACE