vtkScalarsToColors.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkScalarsToColors.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 vtkScalarsToColors_h
#define vtkScalarsToColors_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkVariant.h" // Set/get annotation methods require variants.
#include "vtkObject.h"
 
class vtkAbstractArray;
class vtkDataArray;
class vtkUnsignedCharArray;
class vtkAbstractArray;
class vtkStringArray;
 
 
class VTKCOMMONCORE_EXPORT vtkScalarsToColors : public vtkObject
{
public:
  vtkTypeMacro(vtkScalarsToColors,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  static vtkScalarsToColors *New();
 
  virtual int IsOpaque();
 
  virtual void Build() {}
 
 
  virtual double *GetRange();
  virtual void SetRange(double min, double max);
  void SetRange(double rng[2])
    {this->SetRange(rng[0],rng[1]);}
 
  virtual unsigned char *MapValue(double v);
 
  virtual void GetColor(double v, double rgb[3]);
 
 
  double *GetColor(double v)
    {this->GetColor(v,this->RGB); return this->RGB;}
 
  virtual double GetOpacity(double v);
 
 
  double GetLuminance(double x)
    {double rgb[3]; this->GetColor(x,rgb);
    return static_cast<double>(rgb[0]*0.30 + rgb[1]*0.59 + rgb[2]*0.11);}
 
 
  virtual void SetAlpha(double alpha);
  vtkGetMacro(Alpha,double);
 
 
  virtual vtkUnsignedCharArray *MapScalars(vtkDataArray *scalars, int colorMode,
                                           int component);
  virtual vtkUnsignedCharArray *MapScalars(vtkAbstractArray *scalars, int colorMode,
                                           int component);
 
 
  vtkSetMacro(VectorMode, int);
  vtkGetMacro(VectorMode, int);
  void SetVectorModeToMagnitude();
  void SetVectorModeToComponent();
  void SetVectorModeToRGBColors();
 
//BTX
  enum VectorModes {
    MAGNITUDE=0,
    COMPONENT=1,
    RGBCOLORS=2
  };
//ETX
 
 
 
  vtkSetMacro(VectorComponent, int);
  vtkGetMacro(VectorComponent, int);
 
 
  vtkSetMacro(VectorSize, int);
  vtkGetMacro(VectorSize, int);
 
 
  void MapVectorsThroughTable(void *input, unsigned char *output,
                              int inputDataType, int numberOfValues,
                              int inputIncrement, int outputFormat,
                              int vectorComponent, int vectorSize);
  void MapVectorsThroughTable(void *input, unsigned char *output,
                              int inputDataType, int numberOfValues,
                              int inputIncrement, int outputFormat)
    { this->MapVectorsThroughTable(input, output, inputDataType, numberOfValues,
                                   inputIncrement, outputFormat, -1, -1); }
 
 
  void MapScalarsThroughTable(vtkDataArray *scalars,
                              unsigned char *output,
                              int outputFormat);
  void MapScalarsThroughTable(vtkDataArray *scalars,
                              unsigned char *output)
    {this->MapScalarsThroughTable(scalars,output,VTK_RGBA);}
  void MapScalarsThroughTable(void *input, unsigned char *output,
                              int inputDataType, int numberOfValues,
                              int inputIncrement,
                              int outputFormat)
    {this->MapScalarsThroughTable2(input, output, inputDataType,
       numberOfValues, inputIncrement, outputFormat);}
 
 
  virtual void MapScalarsThroughTable2(void *input, unsigned char *output,
                                       int inputDataType, int numberOfValues,
                                       int inputIncrement,
                                       int outputFormat);
 
  virtual void DeepCopy(vtkScalarsToColors *o);
 
 
  virtual int UsingLogScale()
    { return 0; }
 
  virtual vtkIdType GetNumberOfAvailableColors();
 
 
  virtual void SetAnnotations( vtkAbstractArray* values, vtkStringArray* annotations );
  vtkGetObjectMacro(AnnotatedValues,vtkAbstractArray);
  vtkGetObjectMacro(Annotations,vtkStringArray);
 
  virtual vtkIdType SetAnnotation(vtkVariant value, vtkStdString annotation);
 
  virtual vtkIdType SetAnnotation(vtkStdString value, vtkStdString annotation);
 
  vtkIdType GetNumberOfAnnotatedValues();
 
  vtkVariant GetAnnotatedValue(vtkIdType idx);
 
  vtkStdString GetAnnotation(vtkIdType idx);
 
  virtual void GetAnnotationColor(const vtkVariant& val, double rgba[4]);
 
  vtkIdType GetAnnotatedValueIndex( vtkVariant val );
 
  vtkIdType GetAnnotatedValueIndexInternal(vtkVariant& val);
 
  virtual void GetIndexedColor(vtkIdType i, double rgba[4]);
 
  virtual bool RemoveAnnotation(vtkVariant value);
 
  virtual void ResetAnnotations();
 
 
  vtkSetMacro(IndexedLookup,int);
  vtkGetMacro(IndexedLookup,int);
  vtkBooleanMacro(IndexedLookup,int);
 
 
 
  template<typename T> static
    unsigned char ColorToUChar(T t)
  {
    return t;
  }
  template<typename T> static
    void ColorToUChar(T t, unsigned char* dest)
  {
    *dest = ColorToUChar(t);
  }
 
 
 
protected:
  vtkScalarsToColors();
  ~vtkScalarsToColors();
 
 
  void MapColorsToColors(void *input, unsigned char *output,
                         int inputDataType, int numberOfValues,
                         int numberOfComponents, int vectorSize,
                         int outputFormat);
 
 
  vtkUnsignedCharArray *ConvertToRGBA(
    vtkDataArray *colors, int numComp, int numTuples);
 
 
 
  void MapVectorsToMagnitude(void *input, double *output,
                             int inputDataType, int numberOfValues,
                             int numberOfComponents, int vectorSize);
 
  virtual vtkIdType CheckForAnnotatedValue( vtkVariant value );
 
  virtual void UpdateAnnotatedValueMap();
 
  // Annotations of specific values.
  vtkAbstractArray* AnnotatedValues;
  vtkStringArray*   Annotations;
 
  class vtkInternalAnnotatedValueMap;
  vtkInternalAnnotatedValueMap* AnnotatedValueMap;
 
  int IndexedLookup;
 
  double Alpha;
 
  // How to map arrays with multiple components.
  int VectorMode;
  int VectorComponent;
  int VectorSize;
 
  // Obsolete, kept so subclasses will still compile
  int UseMagnitude;
 
  unsigned char RGBABytes[4];
 
private:
  double RGB[3];
  double InputRange[2];
 
  vtkScalarsToColors(const vtkScalarsToColors&);  // Not implemented.
  void operator=(const vtkScalarsToColors&);  // Not implemented.
};
 
 
template<> inline
unsigned char vtkScalarsToColors::ColorToUChar(double t)
{
  return static_cast<unsigned char>(t*255 + 0.5);
}
template<> inline
unsigned char vtkScalarsToColors::ColorToUChar(float t)
{
  return static_cast<unsigned char>(t*255 + 0.5);
}
 
 
#endif