vtkMRMLSelectionNode.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: vtkMRMLSelectionNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.3 $

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

#ifndef __vtkMRMLSelectionNode_h
#define __vtkMRMLSelectionNode_h

// MRML includes
#include "vtkMRMLNode.h"

class vtkMRMLUnitNode;

// STD includes
#include <vector>

class VTK_MRML_EXPORT vtkMRMLSelectionNode : public vtkMRMLNode
{
  public:
  static vtkMRMLSelectionNode *New();
  vtkTypeMacro(vtkMRMLSelectionNode,vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual vtkMRMLNode* CreateNodeInstance() VTK_OVERRIDE;

  virtual void ReadXMLAttributes( const char** atts) VTK_OVERRIDE;

  virtual void WriteXML(ostream& of, int indent) VTK_OVERRIDE;

  virtual void Copy(vtkMRMLNode *node) VTK_OVERRIDE;

  virtual const char* GetNodeTagName() VTK_OVERRIDE {return "Selection";}

  virtual void SetSceneReferences() VTK_OVERRIDE;

  virtual void UpdateReferenceID(const char *oldID, const char *newID) VTK_OVERRIDE;

  virtual void UpdateReferences() VTK_OVERRIDE;

  vtkGetStringMacro (ActiveVolumeID);
  void SetActiveVolumeID(const char* id);
  void SetReferenceActiveVolumeID (const char *id) { this->SetActiveVolumeID(id); };

  vtkGetStringMacro (SecondaryVolumeID);
  void SetSecondaryVolumeID(const char* id);
  void SetReferenceSecondaryVolumeID (char *id) { this->SetSecondaryVolumeID(id); };

  vtkGetStringMacro (ActiveLabelVolumeID);
  void SetActiveLabelVolumeID(const char* id);
  void SetReferenceActiveLabelVolumeID (const char *id) { this->SetActiveLabelVolumeID(id); };

  vtkGetStringMacro (ActiveFiducialListID);
  void SetActiveFiducialListID(const char* id);
  void SetReferenceActiveFiducialListID (const char *id) { this->SetActiveFiducialListID(id); };

  vtkGetStringMacro (ActivePlaceNodeClassName);
  vtkSetStringMacro(ActivePlaceNodeClassName);
  void SetReferenceActivePlaceNodeClassName (const char *className);

  vtkGetStringMacro (ActivePlaceNodeID);
  void SetActivePlaceNodeID(const char* id);
  void SetReferenceActivePlaceNodeID (const char *id)
  { this->SetActivePlaceNodeID(id);
    this->InvokeEvent(vtkMRMLSelectionNode::ActivePlaceNodeIDChangedEvent); };

  vtkGetStringMacro (ActiveROIListID);
  void SetActiveROIListID(const char* id);
  void SetReferenceActiveROIListID (const char *id) { this->SetActiveROIListID(id); };

  vtkGetStringMacro (ActiveCameraID );
  void SetActiveCameraID(const char* id);
  void SetReferenceActiveCameraID (const char *id) { this->SetActiveCameraID(id); };

  vtkGetStringMacro (ActiveTableID);
  void SetActiveTableID(const char* id);
  void SetReferenceActiveTableID (char *id) { this->SetActiveTableID(id); };

  vtkGetStringMacro (ActiveViewID );
  void SetActiveViewID(const char* id );
  void SetReferenceActiveViewID (const char *id) { this->SetActiveViewID(id); };

  vtkGetStringMacro (ActiveLayoutID );
  void SetActiveLayoutID(const char* id);
  void SetReferenceActiveLayoutID (const char *id) { this->SetActiveLayoutID(id); };

  vtkGetStringMacro (ActivePlotChartID );
  void SetActivePlotChartID(const char* id);
  void SetReferenceActivePlotChartID (const char *id) { this->SetActivePlotChartID(id); };

  enum
  {
    ActivePlaceNodeIDChangedEvent = 19001,
    ActivePlaceNodeClassNameChangedEvent,
    PlaceNodeClassNameListModifiedEvent,
    UnitModifiedEvent,
  };

  void AddNewPlaceNodeClassNameToList(const char *newID, const char *resource = NULL, const char *iconName = "");

  // -- Units --

  const char* GetUnitNodeID(const char* quantity);
  void SetUnitNodeID(const char* quantity, const char* id);

  vtkMRMLUnitNode* GetUnitNode(const char* quantity);

  void GetUnitNodes(std::vector<vtkMRMLUnitNode*>& units);

  void GetUnitNodeIDs(std::vector<const char*>& quantities,
                      std::vector<const char*>& unitIDs);

  void ProcessMRMLEvents(vtkObject *caller, unsigned long event, void *callData) VTK_OVERRIDE;

  void RemovePlaceNodeClassNameFromList(const char *className);
  std::string GetPlaceNodeClassNameByIndex(int n);
  std::string GetPlaceNodeResourceByIndex(int n);
  std::string GetPlaceNodeIconNameByIndex(int n);

  int PlaceNodeClassNameInList(std::string className);
  std::string GetPlaceNodeResourceByClassName(std::string className);
  int GetNumberOfPlaceNodeClassNamesInList() { return static_cast<int>(this->PlaceNodeClassNameList.size()); };

  std::string GetModelHierarchyDisplayNodeClassName(const std::string& dispayableNodeClass)const;

  std::map<std::string, std::string>  GetModelHierarchyDisplayNodeClassNames()const;

  void AddModelHierarchyDisplayNodeClassName(const std::string& dispayableNodeClass,
                                             const std::string& displayNodeClass);

   void ClearModelHierarchyDisplayNodeClassNames();

protected:
  vtkMRMLSelectionNode();
  ~vtkMRMLSelectionNode();
  vtkMRMLSelectionNode(const vtkMRMLSelectionNode&);
  void operator=(const vtkMRMLSelectionNode&);

  static const char* UnitNodeReferenceRole;
  static const char* UnitNodeReferenceMRMLAttributeName;

  virtual const char* GetUnitNodeReferenceRole();
  virtual const char* GetUnitNodeReferenceMRMLAttributeName();

  char *ActiveVolumeID;
  char *SecondaryVolumeID;
  char *ActiveLabelVolumeID;
  char *ActiveFiducialListID;
  char *ActivePlaceNodeID;
  char *ActivePlaceNodeClassName;
  char *ActiveROIListID;
  char *ActiveCameraID;
  char *ActiveTableID;
  char *ActiveViewID;
  char *ActiveLayoutID;
  char *ActivePlotChartID;

  std::map<std::string, std::string> ModelHierarchyDisplayNodeClassName;

  std::vector<std::string> PlaceNodeClassNameList;
  std::vector<std::string> PlaceNodeResourceList;
  std::vector<std::string> PlaceNodeIconNameList;
};

#endif