vtkMRMLColorLogic.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.
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLColorLogic_h
#define __vtkMRMLColorLogic_h
 
// MRMLLogic includes
#include "vtkMRMLAbstractLogic.h"
#include "vtkMRMLLogicExport.h"
 
// MRML includes
class vtkMRMLColorNode;
class vtkMRMLColorTableNode;
class vtkMRMLMessageCollection;
class vtkMRMLProceduralColorNode;
class vtkMRMLPETProceduralColorNode;
class vtkMRMLdGEMRICProceduralColorNode;
class vtkMRMLColorTableNode;
 
// STD includes
#include <cstdlib>
#include <vector>

class VTK_MRML_LOGIC_EXPORT vtkMRMLColorLogic : public vtkMRMLAbstractLogic
{
public:
  static vtkMRMLColorLogic* New();
  vtkTypeMacro(vtkMRMLColorLogic, vtkMRMLAbstractLogic);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void AddDefaultColorNodes();

  virtual void RemoveDefaultColorNodes();

  static const char* GetColorTableNodeID(int type);

  static const char* GetdGEMRICColorNodeID(int type);

  static const char* GetPETColorNodeID(int type);

  static const char* GetProceduralColorNodeID(const char* name);

  static const char* GetFileColorNodeID(const char* fileName);
  static std::string GetFileColorNodeSingletonTag(const char* fileName);

  virtual const char* GetDefaultVolumeColorNodeID();

  virtual const char* GetDefaultLabelMapColorNodeID();

  virtual const char* GetDefaultEditorColorNodeID();

  virtual const char* GetDefaultModelColorNodeID();

  virtual const char* GetDefaultChartColorNodeID();

  virtual const char* GetDefaultPlotColorNodeID();

  void AddColorFile(const char* fileName, std::vector<std::string>* Files);

  vtkMRMLColorNode* LoadColorFile(const char* fileName, const char* nodeName = nullptr, vtkMRMLMessageCollection* userMessages = nullptr, bool userType = false);

  vtkGetStringMacro(UserColorFilePaths);
  vtkSetStringMacro(UserColorFilePaths);

  static vtkMRMLColorTableNode* CopyNode(vtkMRMLColorNode* colorNode, const char* copyName);

  static vtkMRMLProceduralColorNode* CopyProceduralNode(vtkMRMLColorNode* colorNode, const char* copyName);
 
protected:
  vtkMRMLColorLogic();
  ~vtkMRMLColorLogic() override;
  // disable copy constructor and operator
  vtkMRMLColorLogic(const vtkMRMLColorLogic&);
  void operator=(const vtkMRMLColorLogic&);

  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;

  virtual void OnMRMLSceneNewEvent();
 
  vtkMRMLColorTableNode* CreateLabelsNode();
  vtkMRMLColorTableNode* CreateDefaultTableNode(int type);
  vtkMRMLProceduralColorNode* CreateRandomNode();
  vtkMRMLProceduralColorNode* CreateRedGreenBlueNode();
  vtkMRMLPETProceduralColorNode* CreatePETColorNode(int type);
  vtkMRMLdGEMRICProceduralColorNode* CreatedGEMRICColorNode(int type);
  vtkMRMLColorTableNode* CreateDefaultFileNode(const std::string& colorname);
  vtkMRMLColorTableNode* CreateUserFileNode(const std::string& colorname);
  vtkMRMLColorTableNode* CreateFileNode(const char* fileName, vtkMRMLMessageCollection* userMessages = nullptr, bool userType = false);
  vtkMRMLProceduralColorNode* CreateProceduralFileNode(const char* fileName, vtkMRMLMessageCollection* userMessages = nullptr, bool userType = false);
 
  void AddLabelsNode();
  void AddDefaultTableNode(int i);
  void AddDefaultProceduralNodes();
  void AddPETNode(int type);
  void AddDGEMRICNode(int type);
  void AddDefaultFileNode(int i);
  void AddUserFileNode(int i);
 
  void AddDefaultTableNodes();
  void AddPETNodes();
  void AddDGEMRICNodes();
  void AddDefaultFileNodes();
  void AddUserFileNodes();
 
  virtual std::vector<std::string> FindDefaultColorFiles();
  virtual std::vector<std::string> FindUserColorFiles();

  static const char* GetColorNodeID(vtkMRMLColorNode* colorNode);

  std::vector<std::string> ColorFiles;

  std::vector<std::string> UserColorFiles;
  char* UserColorFilePaths;
 
  static std::string TempColorNodeID;
 
  std::string RemoveLeadAndTrailSpaces(std::string);
};
 
#endif