VTK  9.2.6
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
27
28#ifndef vtkBrush_h
29#define vtkBrush_h
30
31#include "vtkColor.h" // Needed for vtkColor4ub
32#include "vtkObject.h"
33#include "vtkRenderingContext2DModule.h" // For export macro
34
35class vtkImageData;
36
37class VTKRENDERINGCONTEXT2D_EXPORT vtkBrush : public vtkObject
38{
39public:
40 vtkTypeMacro(vtkBrush, vtkObject);
41 void PrintSelf(ostream& os, vtkIndent indent) override;
42
43 static vtkBrush* New();
44
49 void SetColorF(double color[3]);
50
55 void SetColorF(double r, double g, double b);
56
61 void SetColorF(double r, double g, double b, double a);
62
67 void SetOpacityF(double a);
68
72 double GetOpacityF();
73
78 void SetColor(unsigned char color[3]);
79
84 void SetColor(unsigned char r, unsigned char g, unsigned char b);
85
87
91 void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
92 void SetColor(const vtkColor4ub& color);
94
99 void SetOpacity(unsigned char a);
100
104 unsigned char GetOpacity();
105
109 void GetColorF(double color[4]);
110
114 void GetColor(unsigned char color[4]);
115
119 unsigned char* GetColor() { return &this->Color[0]; }
120
125
133
135
138 vtkGetObjectMacro(Texture, vtkImageData);
140
145 {
146 Nearest = 0x01,
147 Linear = 0x02,
148 Stretch = 0x04,
149 Repeat = 0x08
150 };
151
153
160 vtkSetMacro(TextureProperties, int);
162
164
167 vtkGetMacro(TextureProperties, int);
169
173 void DeepCopy(vtkBrush* brush);
174
175protected:
177 ~vtkBrush() override;
178
179 // Storage of the color in RGBA format (0-255 per channel).
180 unsigned char* Color;
184
185private:
186 vtkBrush(const vtkBrush&) = delete;
187 void operator=(const vtkBrush&) = delete;
188};
189
190#endif // vtkBrush_h
void SetTexture(vtkImageData *image)
Set the texture that will be used to fill polygons By default, no texture is set.
static vtkBrush * New()
void GetColor(unsigned char color[4])
Get the color of the brush - expects an unsigned char of length 4.
vtkColor4ub GetColorObject()
Get the color of the brush.
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....
int TextureProperties
Definition vtkBrush.h:183
vtkColor4ub BrushColor
Definition vtkBrush.h:181
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.
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.
unsigned char * Color
Definition vtkBrush.h:180
void SetOpacity(unsigned char a)
Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
~vtkBrush() override
void SetOpacityF(double a)
Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
unsigned char GetOpacity()
Get the opacity ranging from 0 (transparent) to 255(opaque).
void SetColor(unsigned char color[3])
Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
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....
TextureProperty
Texture properties.
Definition vtkBrush.h:145
double GetOpacityF()
Get the opacity ranging from 0.0 (transparent) to 1.0(opaque).
unsigned char * GetColor()
Get the color of the brush - gives a pointer to the underlying data.
Definition vtkBrush.h:119
void SetColorF(double color[3])
Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1....
void DeepCopy(vtkBrush *brush)
Make a deep copy of the supplied brush.
void GetColorF(double color[4])
Get the color of the brush - expects a double of length 4 to copy into.
vtkImageData * Texture
Definition vtkBrush.h:182
void SetColor(const vtkColor4ub &color)
Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:34