vtkColorSeries.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkColorSeries.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef vtkColorSeries_h
#define vtkColorSeries_h

#include "vtkCommonColorModule.h" // For export macro
#include "vtkObject.h"
#include "vtkColor.h" // Needed for vtkColor[34]ub
#include "vtkStdString.h" // Needed for arguments

class vtkLookupTable;

class VTKCOMMONCOLOR_EXPORT vtkColorSeries : public vtkObject
{
public:
  vtkTypeMacro(vtkColorSeries, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  static vtkColorSeries* New();

  enum ColorSchemes {
    SPECTRUM = 0,
    WARM,
    COOL,
    BLUES,
    WILD_FLOWER,
    CITRUS,
    BREWER_DIVERGING_PURPLE_ORANGE_11,
    BREWER_DIVERGING_PURPLE_ORANGE_10,
    BREWER_DIVERGING_PURPLE_ORANGE_9,
    BREWER_DIVERGING_PURPLE_ORANGE_8,
    BREWER_DIVERGING_PURPLE_ORANGE_7,
    BREWER_DIVERGING_PURPLE_ORANGE_6,
    BREWER_DIVERGING_PURPLE_ORANGE_5,
    BREWER_DIVERGING_PURPLE_ORANGE_4,
    BREWER_DIVERGING_PURPLE_ORANGE_3,
    BREWER_DIVERGING_SPECTRAL_11,
    BREWER_DIVERGING_SPECTRAL_10,
    BREWER_DIVERGING_SPECTRAL_9,
    BREWER_DIVERGING_SPECTRAL_8,
    BREWER_DIVERGING_SPECTRAL_7,
    BREWER_DIVERGING_SPECTRAL_6,
    BREWER_DIVERGING_SPECTRAL_5,
    BREWER_DIVERGING_SPECTRAL_4,
    BREWER_DIVERGING_SPECTRAL_3,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_11,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_10,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_9,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_8,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_7,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_6,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_5,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_4,
    BREWER_DIVERGING_BROWN_BLUE_GREEN_3,
    BREWER_SEQUENTIAL_BLUE_GREEN_9,
    BREWER_SEQUENTIAL_BLUE_GREEN_8,
    BREWER_SEQUENTIAL_BLUE_GREEN_7,
    BREWER_SEQUENTIAL_BLUE_GREEN_6,
    BREWER_SEQUENTIAL_BLUE_GREEN_5,
    BREWER_SEQUENTIAL_BLUE_GREEN_4,
    BREWER_SEQUENTIAL_BLUE_GREEN_3,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_9,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_8,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_7,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_6,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_5,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_4,
    BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_3,
    BREWER_SEQUENTIAL_BLUE_PURPLE_9,
    BREWER_SEQUENTIAL_BLUE_PURPLE_8,
    BREWER_SEQUENTIAL_BLUE_PURPLE_7,
    BREWER_SEQUENTIAL_BLUE_PURPLE_6,
    BREWER_SEQUENTIAL_BLUE_PURPLE_5,
    BREWER_SEQUENTIAL_BLUE_PURPLE_4,
    BREWER_SEQUENTIAL_BLUE_PURPLE_3,
    BREWER_QUALITATIVE_ACCENT,
    BREWER_QUALITATIVE_DARK2,
    BREWER_QUALITATIVE_SET2,
    BREWER_QUALITATIVE_PASTEL2,
    BREWER_QUALITATIVE_PASTEL1,
    BREWER_QUALITATIVE_SET1,
    BREWER_QUALITATIVE_PAIRED,
    BREWER_QUALITATIVE_SET3,
    CUSTOM
  };

enum LUTMode {
  ORDINAL = 0,
  CATEGORICAL
};


  virtual void SetColorScheme(int scheme);
  virtual int SetColorSchemeByName(const vtkStdString& schemeName);

  int GetNumberOfColorSchemes() const;

  virtual vtkStdString GetColorSchemeName() const;

  virtual void SetColorSchemeName(const vtkStdString& scheme);

  virtual int GetColorScheme() const;

  virtual int GetNumberOfColors() const;

  virtual void SetNumberOfColors(int numColors);

  vtkColor3ub GetColor(int index) const;

  vtkColor3ub GetColorRepeating(int index) const;

  virtual void SetColor(int index, const vtkColor3ub &color);

  virtual void AddColor(const vtkColor3ub &color);

  virtual void InsertColor(int index, const vtkColor3ub &color);

  virtual void RemoveColor(int index);

  virtual void ClearColors();

  virtual void DeepCopy(vtkColorSeries *chartColors);

  void BuildLookupTable(vtkLookupTable* lkup, int lutIndexing = CATEGORICAL);

  VTK_NEWINSTANCE
  vtkLookupTable* CreateLookupTable(int lutIndexing = CATEGORICAL);

protected:
  vtkColorSeries();
  ~vtkColorSeries() VTK_OVERRIDE;

  virtual void CopyOnWrite();


  class Private;
  Private* Storage;

  int ColorScheme;

  vtkStdString ColorSchemeName;

private:
  vtkColorSeries(const vtkColorSeries &) VTK_DELETE_FUNCTION;
  void operator=(const vtkColorSeries &) VTK_DELETE_FUNCTION;

};

#endif //vtkColorSeries_h