VTK
vtkBrush.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBrush.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
31 #ifndef vtkBrush_h
32 #define vtkBrush_h
33 
34 #include "vtkRenderingContext2DModule.h" // For export macro
35 #include "vtkObject.h"
36 #include "vtkColor.h" // Needed for vtkColor4ub
37 
38 class vtkImageData;
39 
40 class VTKRENDERINGCONTEXT2D_EXPORT vtkBrush : public vtkObject
41 {
42 public:
43  vtkTypeMacro(vtkBrush, vtkObject);
44  void PrintSelf(ostream &os, vtkIndent indent) override;
45 
46  static vtkBrush *New();
47 
52  void SetColorF(double color[3]);
53 
58  void SetColorF(double r, double g, double b);
59 
64  void SetColorF(double r, double g, double b, double a);
65 
70  void SetOpacityF(double a);
71 
75  double GetOpacityF();
76 
81  void SetColor(unsigned char color[3]);
82 
87  void SetColor(unsigned char r, unsigned char g, unsigned char b);
88 
90 
94  void SetColor(unsigned char r, unsigned char g, unsigned char b,
95  unsigned char a);
96  void SetColor(const vtkColor4ub &color);
98 
103  void SetOpacity(unsigned char a);
104 
108  unsigned char GetOpacity();
109 
113  void GetColorF(double color[4]);
114 
118  void GetColor(unsigned char color[4]);
119 
123  unsigned char * GetColor() { return &this->Color[0]; }
124 
129 
137 
139 
142  vtkGetObjectMacro(Texture, vtkImageData);
144 
149  Nearest = 0x01,
150  Linear = 0x02,
151  Stretch = 0x04,
152  Repeat = 0x08
153  };
154 
156 
163  vtkSetMacro(TextureProperties, int);
165 
167 
170  vtkGetMacro(TextureProperties, int);
172 
176  void DeepCopy(vtkBrush *brush);
177 
178 protected:
180  ~vtkBrush() override;
181 
182  // Storage of the color in RGBA format (0-255 per channel).
183  unsigned char* Color;
187 
188 private:
189  vtkBrush(const vtkBrush &) = delete;
190  void operator=(const vtkBrush &) = delete;
191 
192 };
193 
194 #endif //vtkBrush_h
vtkBrush
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:41
vtkBrush::Texture
vtkImageData * Texture
Definition: vtkBrush.h:185
vtkBrush::SetColorF
void SetColorF(double color[3])
Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1....
vtkBrush::TextureProperties
int TextureProperties
Definition: vtkBrush.h:186
vtkBrush::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkBrush::GetColor
unsigned char * GetColor()
Get the color of the brush - gives a pointer to the underlying data.
Definition: vtkBrush.h:123
vtkX3D::image
@ image
Definition: vtkX3D.h:374
vtkX3D::Color
@ Color
Definition: vtkX3D.h:46
vtkBrush::GetOpacity
unsigned char GetOpacity()
Get the opacity ranging from 0 (transparent) to 255(opaque).
vtkBrush::SetColor
void SetColor(unsigned char r, unsigned char g, unsigned char b)
Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkBrush::New
static vtkBrush * New()
vtkBrush::~vtkBrush
~vtkBrush() override
vtkBrush::Color
unsigned char * Color
Definition: vtkBrush.h:183
vtkBrush::SetOpacity
void SetOpacity(unsigned char a)
Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
vtkBrush::SetColor
void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a)
Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
vtkBrush::SetColor
void SetColor(unsigned char color[3])
Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
vtkBrush::SetColorF
void SetColorF(double r, double g, double b)
Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1....
vtkBrush::SetOpacityF
void SetOpacityF(double a)
Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
vtkBrush::BrushColor
vtkColor4ub BrushColor
Definition: vtkBrush.h:184
vtkBrush::GetOpacityF
double GetOpacityF()
Get the opacity ranging from 0.0 (transparent) to 1.0(opaque).
vtkX3D::color
@ color
Definition: vtkX3D.h:221
vtkBrush::GetColorF
void GetColorF(double color[4])
Get the color of the brush - expects a double of length 4 to copy into.
vtkBrush::SetColorF
void SetColorF(double r, double g, double b, double a)
Set the color of the brush with four component doubles (RGBA), ranging from 0.0 to 1....
vtkBrush::GetColor
void GetColor(unsigned char color[4])
Get the color of the brush - expects an unsigned char of length 4.
vtkColor.h
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkObject.h
vtkBrush::SetColor
void SetColor(const vtkColor4ub &color)
vtkBrush::vtkBrush
vtkBrush()
vtkColor4ub
Definition: vtkColor.h:241
vtkBrush::GetColorObject
vtkColor4ub GetColorObject()
Get the color of the brush.
vtkBrush::TextureProperty
TextureProperty
Texture properties.
Definition: vtkBrush.h:148
vtkBrush::SetTexture
void SetTexture(vtkImageData *image)
Set the texture that will be used to fill polygons By default, no texture is set.
vtkBrush::DeepCopy
void DeepCopy(vtkBrush *brush)
Make a deep copy of the supplied brush.