vtkLookupTable.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkLookupTable.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 vtkLookupTable_h
#define vtkLookupTable_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkScalarsToColors.h"

#include "vtkUnsignedCharArray.h" // Needed for inline method

#define VTK_RAMP_LINEAR 0
#define VTK_RAMP_SCURVE 1
#define VTK_RAMP_SQRT 2
#define VTK_SCALE_LINEAR 0
#define VTK_SCALE_LOG10 1

class VTKCOMMONCORE_EXPORT vtkLookupTable : public vtkScalarsToColors
{
public:

  static const vtkIdType REPEATED_LAST_COLOR_INDEX;
  static const vtkIdType BELOW_RANGE_COLOR_INDEX;
  static const vtkIdType ABOVE_RANGE_COLOR_INDEX;
  static const vtkIdType NAN_COLOR_INDEX;
  static const vtkIdType NUMBER_OF_SPECIAL_COLORS;

  static vtkLookupTable *New();

  vtkTypeMacro(vtkLookupTable,vtkScalarsToColors);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  int IsOpaque() override;

  int Allocate(int sz=256, int ext=256);

  void Build() override;

  virtual void ForceBuild();

  void BuildSpecialColors();


  vtkSetMacro(Ramp,int);
  void SetRampToLinear() { this->SetRamp(VTK_RAMP_LINEAR); }
  void SetRampToSCurve() { this->SetRamp(VTK_RAMP_SCURVE); }
  void SetRampToSQRT() { this->SetRamp(VTK_RAMP_SQRT); }
  vtkGetMacro(Ramp,int);


  void SetScale(int scale);
  void SetScaleToLinear() { this->SetScale(VTK_SCALE_LINEAR); }
  void SetScaleToLog10() { this->SetScale(VTK_SCALE_LOG10); }
  vtkGetMacro(Scale,int);


  virtual void SetTableRange(const double r[2]);
  virtual void SetTableRange(double min, double max);
  vtkGetVectorMacro(TableRange,double,2);


  vtkSetVector2Macro(HueRange,double);
  vtkGetVector2Macro(HueRange,double);


  vtkSetVector2Macro(SaturationRange,double);
  vtkGetVector2Macro(SaturationRange,double);


  vtkSetVector2Macro(ValueRange,double);
  vtkGetVector2Macro(ValueRange,double);


  vtkSetVector2Macro(AlphaRange,double);
  vtkGetVector2Macro(AlphaRange,double);


  vtkSetVector4Macro(NanColor, double);
  vtkGetVector4Macro(NanColor, double);

  unsigned char* GetNanColorAsUnsignedChars();

  static void GetColorAsUnsignedChars(const double colorIn[4],
                                      unsigned char colorOut[4]);


  vtkSetVector4Macro(BelowRangeColor, double);
  vtkGetVector4Macro(BelowRangeColor, double);


  vtkSetMacro(UseBelowRangeColor, vtkTypeBool);
  vtkGetMacro(UseBelowRangeColor, vtkTypeBool);
  vtkBooleanMacro(UseBelowRangeColor, vtkTypeBool);


  vtkSetVector4Macro(AboveRangeColor, double);
  vtkGetVector4Macro(AboveRangeColor, double);


  vtkSetMacro(UseAboveRangeColor, vtkTypeBool);
  vtkGetMacro(UseAboveRangeColor, vtkTypeBool);
  vtkBooleanMacro(UseAboveRangeColor, vtkTypeBool);

  const unsigned char* MapValue(double v) override;

  void GetColor(double x, double rgb[3]) override;

  double GetOpacity(double v) override;

  virtual vtkIdType GetIndex(double v);


  void SetNumberOfTableValues(vtkIdType number);
  vtkIdType GetNumberOfTableValues() { return this->NumberOfColors; }

  virtual void SetTableValue(vtkIdType indx, const double rgba[4]);

  virtual void SetTableValue(vtkIdType indx,
                              double r, double g, double b, double a=1.0);

  double *GetTableValue(vtkIdType id) VTK_SIZEHINT(4);

  void GetTableValue(vtkIdType id, double rgba[4]);

  unsigned char *GetPointer(vtkIdType id) {
    return this->Table->GetPointer(4*id); }

  unsigned char *WritePointer(vtkIdType id, int number);


  double *GetRange() VTK_SIZEHINT(2) override
    { return this->GetTableRange(); }
  void SetRange(double min, double max) override
    { this->SetTableRange(min, max); }
  void SetRange(const double rng[2]) override { this->SetRange(rng[0], rng[1]); }

  static void GetLogRange(const double range[2], double log_range[2]);

  static double ApplyLogScale(double v, const double range[2],
    const double log_range[2]);


  vtkSetClampMacro(NumberOfColors,vtkIdType,2,VTK_ID_MAX);
  vtkGetMacro(NumberOfColors,vtkIdType);


  void SetTable(vtkUnsignedCharArray *);
  vtkGetObjectMacro(Table,vtkUnsignedCharArray);

  void MapScalarsThroughTable2(void *input,
                               unsigned char *output,
                               int inputDataType,
                               int numberOfValues,
                               int inputIncrement,
                               int outputIncrement) override;

  void DeepCopy(vtkScalarsToColors *lut) override;

  int UsingLogScale() override
  {
    return (this->GetScale() == VTK_SCALE_LOG10) ? 1 : 0;
  }

  vtkIdType GetNumberOfAvailableColors() override;

  void GetIndexedColor(vtkIdType idx, double rgba[4]) override;

protected:
  vtkLookupTable(int sze=256, int ext=256);
  ~vtkLookupTable() override;

  vtkIdType NumberOfColors;
  vtkUnsignedCharArray *Table;
  double TableRange[2];
  double HueRange[2];
  double SaturationRange[2];
  double ValueRange[2];
  double AlphaRange[2];
  double NanColor[4];
  double BelowRangeColor[4];
  vtkTypeBool    UseBelowRangeColor;
  double AboveRangeColor[4];
  vtkTypeBool    UseAboveRangeColor;

  int Scale;
  int Ramp;
  vtkTimeStamp InsertTime;
  vtkTimeStamp BuildTime;
  double RGBA[4]; //used during conversion process
  unsigned char NanColorChar[4];

  int OpaqueFlag;
  vtkTimeStamp OpaqueFlagBuildTime;
  vtkTimeStamp SpecialColorsBuildTime;

  void ResizeTableForSpecialColors();

private:
  vtkLookupTable(const vtkLookupTable&) = delete;
  void operator=(const vtkLookupTable&) = delete;
};

//----------------------------------------------------------------------------
inline unsigned char *vtkLookupTable::WritePointer(vtkIdType id,
                                                   int number)
{
  this->InsertTime.Modified();
  return this->Table->WritePointer(4*id, 4*number);
}

#endif