/Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/OpenGL/vtkScalarsToColorsPainter.h

Go to the documentation of this file.

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

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

#include "vtkRenderingOpenGLModule.h" // For export macro
#include "vtkPainter.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
class vtkDataArray;
class vtkImageData;
class vtkInformationDoubleVectorKey;
class vtkInformationIntegerKey;
class vtkInformationObjectBaseKey;
class vtkInformationStringKey;
class vtkDataSet;
class vtkScalarsToColors;

class VTKRENDERINGOPENGL_EXPORT vtkScalarsToColorsPainter : public vtkPainter
{
public:
  static vtkScalarsToColorsPainter* New();
  vtkTypeMacro(vtkScalarsToColorsPainter, vtkPainter);
  void PrintSelf(ostream& os, vtkIndent indent);

  static vtkInformationIntegerKey* USE_LOOKUP_TABLE_SCALAR_RANGE();

  static vtkInformationDoubleVectorKey* SCALAR_RANGE();

  static vtkInformationIntegerKey* SCALAR_MODE();

  static vtkInformationIntegerKey* COLOR_MODE();

  static vtkInformationIntegerKey* INTERPOLATE_SCALARS_BEFORE_MAPPING();


  static vtkInformationObjectBaseKey* LOOKUP_TABLE();
  void SetLookupTable(vtkScalarsToColors *lut);
  vtkScalarsToColors *GetLookupTable();

  virtual void CreateDefaultLookupTable();

  static vtkInformationIntegerKey* SCALAR_VISIBILITY();


  static vtkInformationIntegerKey* ARRAY_ACCESS_MODE();
  static vtkInformationIntegerKey* ARRAY_ID();
  static vtkInformationStringKey*  ARRAY_NAME();
  static vtkInformationIntegerKey* ARRAY_COMPONENT();
  static vtkInformationIntegerKey* FIELD_DATA_TUPLE_ID();

  static vtkInformationIntegerKey* SCALAR_MATERIAL_MODE();

  virtual int GetPremultiplyColorsWithAlpha(vtkActor* actor);

  virtual vtkDataObject *GetOutput();

  virtual vtkIdType GetTextureSizeLimit();

//BTX
protected:
  vtkScalarsToColorsPainter();
  virtual ~vtkScalarsToColorsPainter();

  virtual vtkDataObject* NewClone(vtkDataObject* data);


  void MapScalarsToTexture(vtkDataSet* output,
    vtkDataArray* scalars, vtkDataSet* input);

  virtual void PrepareForRendering(vtkRenderer* renderer, vtkActor* actor);


  virtual void MapScalars(vtkDataSet* output,
    double alpha, int multiply_with_alpha,
    vtkDataSet* input);

  virtual void ProcessInformation(vtkInformation*);

  virtual void ReportReferences(vtkGarbageCollector *collector);

  int CanUseTextureMapForColoring(vtkDataObject* input);


  void UpdateColorTextureMap(double alpha, int multiply_with_alpha);

  // Methods to set the ivars. These are purposefully protected.
  // The only means of affecting these should be using the vtkInformation
  // object.
  vtkSetMacro(UseLookupTableScalarRange, int);
  vtkSetVector2Macro(ScalarRange, double);
  vtkSetMacro(ScalarMode, int);
  vtkSetMacro(ColorMode, int);
  vtkSetMacro(InterpolateScalarsBeforeMapping, int);
  vtkSetMacro(ScalarVisibility, int);
  vtkSetMacro(ScalarMaterialMode, int);
  vtkSetMacro(ArrayAccessMode, int);
  vtkSetMacro(ArrayComponent, int);
  vtkSetMacro(ArrayId, int);
  vtkSetStringMacro(ArrayName);
  vtkSetMacro(FieldDataTupleId, vtkIdType);

  vtkDataObject* OutputData;

  int ArrayAccessMode;
  int ArrayComponent;
  int ArrayId;
  char* ArrayName;
  vtkIdType FieldDataTupleId;

  vtkScalarsToColors *LookupTable;
  // Lookup table provided via the scalars. This gets preference over the one
  // set on the mapper by the user.
  vtkSmartPointer<vtkScalarsToColors> ScalarsLookupTable;
  vtkSmartPointer<vtkImageData> ColorTextureMap;
  int ColorMode;
  int InterpolateScalarsBeforeMapping;
  int ScalarMode;
  int ScalarMaterialMode;
  double LastUsedAlpha; // Essential to ensure alpha changes work correctly
                        // for composite datasets.
  int LastUsedMultiplyWithAlpha;
  double ScalarRange[2];
  int ScalarVisibility;
  int UseLookupTableScalarRange;

  vtkTimeStamp OutputUpdateTime;

  // This is set when MapScalars decides to use vertex colors for atleast on
  // dataset in the current pass.
  int UsingScalarColoring;

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

#endif