vtkBrush.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

#ifndef vtkBrush_h
#define vtkBrush_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkImageData;

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

  static vtkBrush* New();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetColorF(double color[3]);

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

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

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetOpacityF(double a);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  double GetOpacityF();

  void SetColor(unsigned char color[3]);

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


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  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();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void GetColorF(double color[4]);

  void GetColor(unsigned char color[4]);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  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;
};

VTK_ABI_NAMESPACE_END
#endif // vtkBrush_h