vtkColorTransferFunction.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkColorTransferFunction.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 vtkColorTransferFunction_h
#define vtkColorTransferFunction_h
 
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkScalarsToColors.h"
 
class vtkColorTransferFunctionInternals;
 
#define VTK_CTF_RGB           0
#define VTK_CTF_HSV           1
#define VTK_CTF_LAB           2
#define VTK_CTF_DIVERGING     3
 
#define VTK_CTF_LINEAR        0
#define VTK_CTF_LOG10         1
 
class VTKRENDERINGCORE_EXPORT vtkColorTransferFunction : public vtkScalarsToColors
{
public:
  static vtkColorTransferFunction *New();
  vtkTypeMacro(vtkColorTransferFunction,vtkScalarsToColors);
  void DeepCopy( vtkScalarsToColors *f );
  void ShallowCopy( vtkColorTransferFunction *f );
 
  void PrintSelf(ostream& os, vtkIndent indent);
 
  int GetSize();
 
 
  int AddRGBPoint( double x, double r, double g, double b );
  int AddRGBPoint( double x, double r, double g, double b,
                   double midpoint, double sharpness );
  int AddHSVPoint( double x, double h, double s, double v );
  int AddHSVPoint( double x, double h, double s, double v,
                   double midpoint, double sharpness );
  int RemovePoint( double x );
 
 
  void AddRGBSegment( double x1, double r1, double g1, double b1,
                      double x2, double r2, double g2, double b2 );
  void AddHSVSegment( double x1, double h1, double s1, double v1,
                      double x2, double h2, double s2, double v2 );
 
  void RemoveAllPoints();
 
 
  double *GetColor(double x) {
    return vtkScalarsToColors::GetColor(x); }
  void GetColor(double x, double rgb[3]);
 
 
  double GetRedValue( double x );
  double GetGreenValue( double x );
  double GetBlueValue( double x );
 
 
  int GetNodeValue( int index, double val[6] );
  int SetNodeValue( int index, double val[6] );
 
  virtual unsigned char *MapValue(double v);
 
 
  vtkGetVector2Macro( Range, double );
 
  int AdjustRange(double range[2]);
 
 
  void GetTable( double x1, double x2, int n, double* table );
  void GetTable( double x1, double x2, int n, float* table );
  const unsigned char *GetTable( double x1, double x2, int n );
 
  void BuildFunctionFromTable( double x1, double x2, int size, double *table );
 
 
  vtkSetClampMacro( Clamping, int, 0, 1 );
  vtkGetMacro( Clamping, int );
  vtkBooleanMacro( Clamping, int );
 
 
  vtkSetClampMacro( ColorSpace, int, VTK_CTF_RGB, VTK_CTF_DIVERGING );
  void SetColorSpaceToRGB(){this->SetColorSpace(VTK_CTF_RGB);};
  void SetColorSpaceToHSV(){this->SetColorSpace(VTK_CTF_HSV);};
  void SetColorSpaceToLab(){this->SetColorSpace(VTK_CTF_LAB);};
  void SetColorSpaceToDiverging(){this->SetColorSpace(VTK_CTF_DIVERGING);}
  vtkGetMacro( ColorSpace, int );
  vtkSetMacro(HSVWrap, int);
  vtkGetMacro(HSVWrap, int);
  vtkBooleanMacro(HSVWrap, int);
 
 
  vtkSetMacro(Scale,int);
  void SetScaleToLinear() { this->SetScale(VTK_CTF_LINEAR); };
  void SetScaleToLog10() { this->SetScale(VTK_CTF_LOG10); };
  vtkGetMacro(Scale,int);
 
 
  vtkSetVector3Macro(NanColor, double);
  vtkGetVector3Macro(NanColor, double);
 
 
  vtkSetVector3Macro(BelowRangeColor, double);
  vtkGetVector3Macro(BelowRangeColor, double);
 
 
  vtkSetMacro(UseBelowRangeColor, int);
  vtkGetMacro(UseBelowRangeColor, int);
  vtkBooleanMacro(UseBelowRangeColor, int);
 
 
  vtkSetVector3Macro(AboveRangeColor, double);
  vtkGetVector3Macro(AboveRangeColor, double);
 
 
  vtkSetMacro(UseAboveRangeColor, int);
  vtkGetMacro(UseAboveRangeColor, int);
  vtkBooleanMacro(UseAboveRangeColor, int);
 
  double* GetDataPointer();
 
  void FillFromDataPointer(int n, double* ptr);
 
 
  virtual void MapScalarsThroughTable2(void *input, unsigned char *output,
                                       int inputDataType, int numberOfValues,
                                       int inputIncrement, int outputIncrement);
 
 
  vtkSetMacro(AllowDuplicateScalars, int);
  vtkGetMacro(AllowDuplicateScalars, int);
  vtkBooleanMacro(AllowDuplicateScalars, int);
 
  virtual vtkIdType GetNumberOfAvailableColors();
 
  virtual void GetIndexedColor(vtkIdType idx, double rgba[4]);
 
protected:
  vtkColorTransferFunction();
  ~vtkColorTransferFunction();
 
  vtkColorTransferFunctionInternals *Internal;
 
  int Clamping;
 
  int ColorSpace;
 
  int HSVWrap;
 
  int Scale;
 
  double NanColor[3];
 
  double BelowRangeColor[3];
 
  int UseBelowRangeColor;
 
  double AboveRangeColor[3];
 
  int UseAboveRangeColor;
 
  double* Function;
 
  double Range[2];
 
  unsigned char UnsignedCharRGBAValue[4];
 
  int AllowDuplicateScalars;
 
  vtkTimeStamp BuildTime;
  unsigned char *Table;
 
  int TableSize;
 
 
  virtual void SetRange(double, double) {}
  void SetRange(double rng[2]) {this->SetRange(rng[0],rng[1]);};
 
  void SortAndUpdateRange();
 
  bool UpdateRange();
 
  void MovePoint(double oldX, double newX);
 
private:
  vtkColorTransferFunction(const vtkColorTransferFunction&);  // Not implemented.
  void operator=(const vtkColorTransferFunction&);  // Not implemented.
};
 
#endif