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) override;
 
  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes(const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  void Copy(vtkMRMLNode* node) override;

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

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

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

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

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

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

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

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

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

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

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

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

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

  void AddNewPlaceNodeClassNameToList(const char* newID, const char* resource = nullptr, 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) 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()); };

  void SetActivePlaceNodePlacementValid(bool valid);
  bool GetActivePlaceNodePlacementValid();
 
protected:
  vtkMRMLSelectionNode();
  ~vtkMRMLSelectionNode() override;
  vtkMRMLSelectionNode(const vtkMRMLSelectionNode&);
  void operator=(const vtkMRMLSelectionNode&);
 
  char* ActivePlaceNodeClassName;
  bool ActivePlaceNodePlacementValid;
 
  std::vector<std::string> PlaceNodeClassNameList;
  std::vector<std::string> PlaceNodeResourceList;
  std::vector<std::string> PlaceNodeIconNameList;
};
 
#endif