vtkBrush.h

Go to the documentation of this file.

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

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

#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkObject.h"
#include "vtkColor.h" // Needed for vtkColor4ub

class vtkImageData;

class VTKRENDERINGCONTEXT2D_EXPORT vtkBrush : public vtkObject
{
public:
  vtkTypeMacro(vtkBrush, vtkObject);
  void PrintSelf(ostream &os, vtkIndent indent) override;

  static vtkBrush *New();

  void SetColorF(double color[3]);

  void SetColorF(double r, double g, double b);

  void SetColorF(double r, double g, double b, double a);

  void SetOpacityF(double a);

  double GetOpacityF();

  void SetColor(unsigned char color[3]);

  void SetColor(unsigned char r, unsigned char g, unsigned char b);


  void SetColor(unsigned char r, unsigned char g, unsigned char b,
                unsigned char a);
  void SetColor(const vtkColor4ub &color);

  void SetOpacity(unsigned char a);

  unsigned char GetOpacity();

  void GetColorF(double color[4]);

  void GetColor(unsigned char color[4]);

  unsigned char * GetColor() { return &this->Color[0]; }

  vtkColor4ub GetColorObject();

  void SetTexture(vtkImageData* image);


  vtkGetObjectMacro(Texture, vtkImageData);

  enum TextureProperty {
    Nearest = 0x01,
    Linear  = 0x02,
    Stretch = 0x04,
    Repeat  = 0x08
  };


  vtkSetMacro(TextureProperties, int);


  vtkGetMacro(TextureProperties, int);

  void DeepCopy(vtkBrush *brush);

protected:
  vtkBrush();
  ~vtkBrush() override;

  // Storage of the color in RGBA format (0-255 per channel).
  unsigned char* Color;
  vtkColor4ub    BrushColor;
  vtkImageData*  Texture;
  int            TextureProperties;

private:
  vtkBrush(const vtkBrush &) = delete;
  void operator=(const vtkBrush &) = delete;

};

#endif //vtkBrush_h