vtkMRMLAnnotationDisplayableManagerHelper.h

Go to the documentation of this file.

/*=auto=========================================================================

 Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.

 See COPYRIGHT.txt
 or http://www.slicer.org/copyright/copyright.txt for details.

 Program:   3D Slicer
 Module:    $RCSfile: vtkMRMLAnnotationDisplayableManagerHelper,v $
 Date:      $Date: Aug 4, 2010 10:44:52 AM $
 Version:   $Revision: 1.0 $

 =========================================================================auto=*/

#ifndef VTKMRMLANNOTATIONDISPLAYABLEMANAGERHELPER_H_
#define VTKMRMLANNOTATIONDISPLAYABLEMANAGERHELPER_H_

// Annotations includes
#include "vtkSlicerAnnotationsModuleMRMLDisplayableManagerExport.h"

// Annotations MRML includes
class vtkMRMLAnnotationDisplayNode;
class vtkMRMLAnnotationNode;

// MRML includes
class vtkMRMLInteractionNode;

// VTK includes
#include <vtkHandleWidget.h>
#include <vtkLineWidget2.h>
#include <vtkSeedWidget.h>
#include <vtkSmartPointer.h>

// STD includes
#include <map>

class VTK_SLICER_ANNOTATIONS_MODULE_MRMLDISPLAYABLEMANAGER_EXPORT
vtkMRMLAnnotationDisplayableManagerHelper
  : public vtkObject
{
public:

  static vtkMRMLAnnotationDisplayableManagerHelper *New();
  vtkTypeMacro(vtkMRMLAnnotationDisplayableManagerHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  void UpdateLockedAllWidgetsFromNodes();
  void UpdateLockedAllWidgetsFromInteractionNode(vtkMRMLInteractionNode* interactionNode);
  void UpdateLockedAllWidgets(bool locked);
  void UpdateLocked(vtkMRMLAnnotationNode* node);
  void UpdateVisible(vtkMRMLAnnotationNode* node, bool displayableInViewer = true);
  void UpdateWidget(vtkMRMLAnnotationNode* node);

  vtkAbstractWidget * GetWidget(vtkMRMLAnnotationNode * node);
  vtkAbstractWidget * GetIntersectionWidget(vtkMRMLAnnotationNode * node);
  vtkAbstractWidget * GetOverLineProjectionWidget(vtkMRMLAnnotationNode * node);
  vtkAbstractWidget * GetUnderLineProjectionWidget(vtkMRMLAnnotationNode * node);
  vtkAbstractWidget * GetPointProjectionWidget(vtkMRMLAnnotationNode * node);
  void RemoveAllWidgetsAndNodes();
  void RemoveWidgetAndNode(vtkMRMLAnnotationNode *node);


  vtkMRMLAnnotationNode * GetAnnotationNodeFromDisplayNode(vtkMRMLAnnotationDisplayNode *displayNode);

  //----------------------------------------------------------------------------------
  // The Lists!!
  //
  // An annotation which is managed by a displayableManager consists of
  //   a) the Annotation MRML Node (AnnotationNodeList)
  //   b) the vtkWidget to show this annotation (Widgets)
  //   c) a vtkWidget to represent sliceIntersections in the slice viewers (WidgetIntersections)
  //

  std::vector<vtkMRMLAnnotationNode*> AnnotationNodeList;

  typedef std::vector<vtkMRMLAnnotationNode*>::iterator AnnotationNodeListIt;

  std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*> Widgets;

  typedef std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*>::iterator WidgetsIt;

  std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*> WidgetIntersections;

  typedef std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*>::iterator WidgetIntersectionsIt;

  std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*> WidgetOverLineProjections;

  typedef std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*>::iterator WidgetOverLineProjectionsIt;

  std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*> WidgetUnderLineProjections;

  typedef std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*>::iterator WidgetUnderLineProjectionsIt;

  std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*> WidgetPointProjections;

  typedef std::map<vtkMRMLAnnotationNode*, vtkAbstractWidget*>::iterator WidgetPointProjectionsIt;

  //
  // End of The Lists!!
  //
  //----------------------------------------------------------------------------------


  void PlaceSeed(double x, double y, vtkRenderWindowInteractor * interactor, vtkRenderer * renderer);

  vtkHandleWidget * GetSeed(int index);

  void RemoveSeeds();


protected:

  vtkMRMLAnnotationDisplayableManagerHelper();
  virtual ~vtkMRMLAnnotationDisplayableManagerHelper();

private:

  vtkMRMLAnnotationDisplayableManagerHelper(const vtkMRMLAnnotationDisplayableManagerHelper&); 
  void operator=(const vtkMRMLAnnotationDisplayableManagerHelper&); 

  vtkSmartPointer<vtkSeedWidget> SeedWidget;
  std::vector<vtkSmartPointer<vtkHandleWidget> > HandleWidgetList;
  typedef std::vector<vtkSmartPointer<vtkHandleWidget> >::iterator HandleWidgetListIt;
};

#endif /* VTKMRMLANNOTATIONDISPLAYABLEMANAGERHELPER_H_ */