/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkVtkBlackBoxMacros.h,v $
  Language:  C++
  Date:      $Date: 2008/05/07 12:59:23 $
  Version:   $Revision: 1.3 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
                                                                                
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
                                                                                
=========================================================================*/


/**
 *  \file 
 *  \brief Defines macros for the creation of vtk object inherited black boxes
 */
#ifndef __bbtkVtkBlackBoxMacros_h__
#define __bbtkVtkBlackBoxMacros_h__
#include <vtkGarbageCollector.h>


//===========================================================================
//============================================================================
// VTK Specific macros
//===========================================================================
//===========================================================================


//===========================================================================
#define BBTK_VTK_DELETE()						\
  void bbDelete() {							\
    bbGetOutputOut()->SetSource(NULL);					\
    /*    vtkParent::SetReferenceCount(0);*/				\
    bbmDescriptorPointer.reset();					\
    vtkParent::Delete();						\
  }

#define BBTK_VTK_BLACK_BOX_INTERFACE(CLASS,PARENTBLACKBOX,VTKPARENT)	\
  BBTK_BLACK_BOX_INTERFACE(CLASS,PARENTBLACKBOX);			\
  typedef VTKPARENT vtkParent;						\
  BBTK_VTK_DELETE();

/// Declares a vtkImageAlgorithm-inherited AtomicBlackBox input 
#define BBTK_DECLARE_VTK_IMAGE_ALGORITHM_INPUT(NAME,TYPE)		\
  public:								\
  TYPE bbGetInput##NAME ()						\
  { return GetImageDataInput(0); /*vtkParent::GetInput();*/ }		\
  void bbSetInput##NAME (TYPE d)					\
  { vtkParent::SetInput( (vtkDataObject*) d);				\
    /*bbSetModifiedStatus();*/ }						       
//===========================================================================
/// Declares a vtkPolyDataAlgorithm-inherited AtomicBlackBox input 
#define BBTK_DECLARE_VTK_POLY_DATA_ALGORITHM_INPUT(NAME,TYPE)	\
  public:								\
  TYPE bbGetInput##NAME ()						\
  { return GetPolyDataInput(0); /*vtkParent::GetInput();*/ }		\
  void bbSetInput##NAME (TYPE d)					\
  { vtkParent::SetInput( (vtkDataObject*) d);				\
    /*bbSetModifiedStatus();*/ }						       
//===========================================================================

//===========================================================================
/// Declares a vtkImageAlgorithm-inherited AtomicBlackBox output 
#define BBTK_DECLARE_VTK_OUTPUT(NAME,TYPE)				\
  public:								\
  TYPE bbGetOutput##NAME ()						\
  { return vtkParent::GetOutput(); }					\
  void bbSetOutput##NAME (TYPE d)					\
  { /*vtkParent::GetOutput() = d;*/ }					
//===========================================================================

//===========================================================================
/// Declares a vtkAlgorithm-inherited AtomicBlackBox input 
#define BBTK_DECLARE_VTK_INPUT(NAME,TYPE)			\
  public:								\
  TYPE bbGetInput##NAME ()						\
  { return dynamic_cast<TYPE>(vtkParent::GetInput()); }			\
  void bbSetInput##NAME (TYPE d)					\
  { vtkParent::SetInput( (vtkDataObject*) d); /*vtkParent::GetOutput() = d;*/ }

//===========================================================================

//===========================================================================
/// Declares an AtomicBlackBox input corresponding to an 
/// inherited vtk parameter
/// which was declared by vtkSetMacro/vtkGetMacro
/// The NAME **MUST** be the same than the vtk parameter name
#define BBTK_DECLARE_VTK_PARAM(NAME,TYPE)			\
  public:								\
  TYPE bbGetInput##NAME ()						\
  { return vtkParent::Get##NAME(); }					\
  void bbSetInput##NAME (TYPE d)					\
  { vtkParent::Set##NAME(d);						\
    /*bbSetModifiedStatus();*/ }
//===========================================================================



//============================================================================
/// Defines the default bbUserProcess method for vtk inherited black boxes
/// (calls vtkParent::Update)
#define BBTK_VTK_PROCESS()						\
  public:								\
  inline void bbUserProcess()						\
  {									\
    bbtkDebugMessage("process",1,"**> Processing ["<<bbGetFullName()	\
		     <<"]"<<std::endl);					\
    vtkParent::Update();						\
    bbtkDebugMessage("process",2,"<** Processing ["<<bbGetFullName()	\
		     <<"]"<<std::endl);					\
  }
//============================================================================


//===========================================================================
/// EOF
//===========================================================================
#endif