vtkMRMLColorNode.h

Go to the documentation of this file.

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

  Portions (c) Copyright 2006 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: vtkMRMLColorNode.h,v $
  Date:      $Date: 2006/03/19 17:12:28 $
  Version:   $Revision: 1.0 $

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

#ifndef __vtkMRMLColorNode_h
#define __vtkMRMLColorNode_h

// MRML includes
#include "vtkMRMLStorableNode.h"

// VTK includes
class vtkLookupTable;
class vtkScalarsToColors;

// Std includes
#include <string>
#include <vector>

class VTK_MRML_EXPORT vtkMRMLColorNode : public vtkMRMLStorableNode
{
public:
  static vtkMRMLColorNode *New();
  vtkTypeMacro(vtkMRMLColorNode,vtkMRMLStorableNode);
  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 "Color";};

  void Reset(vtkMRMLNode* defaultNode) override;

  void UpdateScene(vtkMRMLScene *scene) override;

  virtual void SetType(int type);
  vtkGetMacro(Type,int);

  void SetTypeToUser();
  void SetTypeToFile();

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

  virtual int GetFirstType () { return this->User; }
  virtual int GetLastType () { return this->File; }

  virtual const char * GetTypeAsString();

  enum
    {
      TypeModifiedEvent = 20002
    };

  const char *GetColorName(int ind);

  int GetColorIndexByName(const char *name);

  std::string GetColorNameAsFileName(int colorIndex, const char *subst = "_");

  std::string GetColorNameWithoutSpaces(int ind, const char *subst);

  int SetColorName(int ind, const char *name);

  int SetColorNameWithSpaces(int ind, const char *name, const char *subst);
  virtual int GetNumberOfColors();

  virtual bool GetColor(int ind, double color[4]);

  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);

  virtual vtkLookupTable * GetLookupTable();

  virtual vtkScalarsToColors* GetScalarsToColors();

  vtkGetStringMacro(NoName);
  vtkSetStringMacro(NoName);

  vtkGetMacro(NamesInitialised, int);
  vtkSetMacro(NamesInitialised, int);
  vtkBooleanMacro(NamesInitialised, int);
  void SetNamesFromColors();

  bool GetModifiedSinceRead() override;

  enum
  {
    User = 13,
    File = 14,
  };

  virtual vtkLookupTable* CreateLookupTableCopy();

protected:
  vtkMRMLColorNode();
  ~vtkMRMLColorNode() override;
  vtkMRMLColorNode(const vtkMRMLColorNode&);
  void operator=(const vtkMRMLColorNode&);

  virtual bool SetNameFromColor(int index);

  virtual bool HasNameFromColor(int index);

  int Type;

  std::vector<std::string> Names;

  char *FileName;

  char *NoName;

  int NamesInitialised;
};

#endif