vtkMRMLColorTableNode.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: vtkMRMLColorTableNode.h,v $
  Date:      $Date: 2006/03/19 17:12:28 $
  Version:   $Revision: 1.0 $
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLColorTableNode_h
#define __vtkMRMLColorTableNode_h
 
#include "vtkMRMLColorNode.h"

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

  vtkLookupTable* GetLookupTable() override;

  virtual void SetAndObserveLookupTable(vtkLookupTable* newLookupTable, bool markAllColorsAsDefined = true);

  virtual void SetLookupTable(vtkLookupTable* newLookupTable) { this->SetAndObserveLookupTable(newLookupTable, /*markAllColorsAsDefined=*/true); }

  void SetType(int type) override;
  // GetType is defined in ColorTableNode class via macro.
  void SetTypeToFullRainbow();
  void SetTypeToGrey();
  void SetTypeToIron();
  void SetTypeToRainbow();
  void SetTypeToOcean();
  void SetTypeToDesert();
  void SetTypeToInvGrey();
  void SetTypeToReverseRainbow();
  void SetTypeToFMRI();
  void SetTypeToFMRIPA();
  void SetTypeToLabels();
  void SetTypeToRandom();
  void SetTypeToRed();
  void SetTypeToGreen();
  void SetTypeToBlue();
  void SetTypeToCyan();
  void SetTypeToMagenta();
  void SetTypeToYellow();
  void SetTypeToWarm1();
  void SetTypeToWarm2();
  void SetTypeToWarm3();
  void SetTypeToCool1();
  void SetTypeToCool2();
  void SetTypeToCool3();
  void SetTypeToWarmShade1();
  void SetTypeToWarmShade2();
  void SetTypeToWarmShade3();
  void SetTypeToCoolShade1();
  void SetTypeToCoolShade2();
  void SetTypeToCoolShade3();
  void SetTypeToWarmTint1();
  void SetTypeToWarmTint2();
  void SetTypeToWarmTint3();
  void SetTypeToCoolTint1();
  void SetTypeToCoolTint2();
  void SetTypeToCoolTint3();
 
  void ProcessMRMLEvents(vtkObject* caller, unsigned long event, void* callData) override;


  enum
  {
    FullRainbow = 0,
    Grey = 1,
    Iron = 2,
    Rainbow = 3,
    Ocean = 4,
    Desert = 5,
    InvGrey = 6,
    ReverseRainbow = 7,
    FMRI = 8,
    FMRIPA = 9,
    Labels = 10,
    Obsolete = 11,
    Random = 12,
    Red = 15,
    Green = 16,
    Blue = 17,
    Yellow = 18,
    Cyan = 19,
    Magenta = 20,
    Warm1 = 21,
    Warm2 = 22,
    Warm3 = 23,
    Cool1 = 24,
    Cool2 = 25,
    Cool3 = 26,
    WarmShade1 = 27,
    WarmShade2 = 28,
    WarmShade3 = 29,
    CoolShade1 = 30,
    CoolShade2 = 31,
    CoolShade3 = 32,
    WarmTint1 = 33,
    WarmTint2 = 34,
    WarmTint3 = 35,
    CoolTint1 = 36,
    CoolTint2 = 37,
    CoolTint3 = 38
  };

  int GetFirstType() override { return this->FullRainbow; };
  int GetLastType() override { return this->CoolTint3; };

  const char* GetTypeAsString() override;

  void SetNumberOfColors(int n);

  int GetNumberOfColors() override;

  void AddColor(const char* name, double r, double g, double b, double a = 1.0);

  int SetColor(int entry, const char* name, double r, double g, double b, double a = 1.0);

  bool RemoveColor(int entry);

  int SetColors(int firstEntry, int lastEntry, const char* name, double r, double g, double b, double a = 1.0);

  bool RemoveColors(int firstEntry, int lastEntry);

  int SetColor(int entry, double r, double g, double b, double a);
  int SetColor(int entry, double r, double g, double b);
  int SetOpacity(int entry, double opacity);

  bool GetColor(int entry, double color[4]) override;

  void ClearNames();

  void Reset(vtkMRMLNode* defaultNode) override;

  vtkMRMLStorageNode* CreateDefaultStorageNode() override;
 
protected:
  vtkMRMLColorTableNode();
  ~vtkMRMLColorTableNode() override;
  vtkMRMLColorTableNode(const vtkMRMLColorTableNode&);
  void operator=(const vtkMRMLColorTableNode&);

  bool IsValidColorIndex(int entry, const std::string& callerMethod, bool isCallerMethodSet = false);

  vtkLookupTable* LookupTable;

  int LastAddedColor{ -1 };
};
 
#endif