dox/Charts/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 "vtkObject.h"
#include "vtkColor.h" // Needed for vtkColor3ub

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

  static vtkColorSeries* New();

//BTX

  enum {
    SPECTRUM = 0, 
    WARM,         
    COOL,         
    BLUES,        
    WILD_FLOWER,  
    CITRUS,       
    CUSTOM        
    };
//ETX

  void SetColorScheme(int scheme);


  vtkGetMacro(ColorScheme, int);

  int GetNumberOfColors();

//BTX
  vtkColor3ub GetColor(int index) const;

  vtkColor3ub GetColorRepeating(int index) const;

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

  void AddColor(const vtkColor3ub &color);


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

  void RemoveColor(int index);

  void ClearColors();

  void DeepCopy(vtkColorSeries *chartColors);

//BTX
protected:
  vtkColorSeries();
  ~vtkColorSeries();


  class Private;
  Private *Storage;

  int ColorScheme;

private:
  vtkColorSeries(const vtkColorSeries &); // Not implemented.
  void operator=(const vtkColorSeries &);   // Not implemented.
//ETX
};

#endif //__vtkColorSeries_h