dox/Rendering/vtkImageProperty.h

Go to the documentation of this file.

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

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

#include "vtkObject.h"

class vtkScalarsToColors;

class VTK_RENDERING_EXPORT vtkImageProperty : public vtkObject
{
public:
  vtkTypeMacro(vtkImageProperty,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  static vtkImageProperty *New();

  void DeepCopy(vtkImageProperty *p);


  vtkSetMacro(ColorWindow, double);
  vtkGetMacro(ColorWindow, double);


  vtkSetMacro(ColorLevel, double);
  vtkGetMacro(ColorLevel, double);


  virtual void SetLookupTable(vtkScalarsToColors *lut);
  vtkGetObjectMacro(LookupTable, vtkScalarsToColors);


  vtkSetMacro(UseLookupTableScalarRange, int);
  vtkGetMacro(UseLookupTableScalarRange, int);
  vtkBooleanMacro(UseLookupTableScalarRange, int);


  vtkSetClampMacro(Opacity, double, 0.0, 1.0);
  vtkGetMacro(Opacity, double);


  vtkSetClampMacro(Ambient, double, 0.0, 1.0);
  vtkGetMacro(Ambient, double);


  vtkSetClampMacro(Diffuse, double, 0.0, 1.0);
  vtkGetMacro(Diffuse, double);


  vtkSetClampMacro(InterpolationType, int,
                   VTK_NEAREST_INTERPOLATION, VTK_CUBIC_INTERPOLATION);
  vtkGetMacro(InterpolationType, int);
  void SetInterpolationTypeToNearest() {
    this->SetInterpolationType(VTK_NEAREST_INTERPOLATION); };
  void SetInterpolationTypeToLinear() {
    this->SetInterpolationType(VTK_LINEAR_INTERPOLATION); };
  void SetInterpolationTypeToCubic() {
    this->SetInterpolationType(VTK_CUBIC_INTERPOLATION); };
  virtual const char *GetInterpolationTypeAsString();


  vtkSetMacro(LayerNumber, int);
  int GetLayerNumber() { return this->LayerNumber; }


  vtkSetMacro(Checkerboard, int);
  vtkBooleanMacro(Checkerboard, int);
  vtkGetMacro(Checkerboard, int);


  vtkSetVector2Macro(CheckerboardSpacing, double);
  vtkGetVector2Macro(CheckerboardSpacing, double);


  vtkSetVector2Macro(CheckerboardOffset, double);
  vtkGetVector2Macro(CheckerboardOffset, double);


  vtkSetMacro(Backing, int);
  vtkBooleanMacro(Backing, int);
  vtkGetMacro(Backing, int);


  vtkSetVector3Macro(BackingColor, double);
  vtkGetVector3Macro(BackingColor, double);

  unsigned long GetMTime();

protected:
  vtkImageProperty();
  ~vtkImageProperty();

  vtkScalarsToColors *LookupTable;
  double ColorWindow;
  double ColorLevel;
  int UseLookupTableScalarRange;
  int InterpolationType;
  int LayerNumber;
  double Opacity;
  double Ambient;
  double Diffuse;
  int Checkerboard;
  double CheckerboardSpacing[2];
  double CheckerboardOffset[2];
  int Backing;
  double BackingColor[3];

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

#endif