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
40#ifndef vtkBrush_h
41#define vtkBrush_h
42
43#include "vtkColor.h" // Needed for vtkColor4ub
44#include "vtkObject.h"
45#include "vtkRenderingContext2DModule.h" // For export macro
46
47class vtkImageData;
48
49class VTKRENDERINGCONTEXT2D_EXPORT vtkBrush : public vtkObject
50{
51public:
52 vtkTypeMacro(vtkBrush, vtkObject);
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
55 static vtkBrush* New();
56
61 void SetColorF(double color[3]);
62
67 void SetColorF(double r, double g, double b);
68
73 void SetColorF(double r, double g, double b, double a);
74
79 void SetOpacityF(double a);
80
84 double GetOpacityF();
85
90 void SetColor(unsigned char color[3]);
91
96 void SetColor(unsigned char r, unsigned char g, unsigned char b);
97
99
103 void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
104 void SetColor(const vtkColor4ub& color);
106
111 void SetOpacity(unsigned char a);
112
116 unsigned char GetOpacity();
117
121 void GetColorF(double color[4]);
122
126 void GetColor(unsigned char color[4]);
127
131 unsigned char* GetColor() { return &this->Color[0]; }
132
137
145
147
150 vtkGetObjectMacro(Texture, vtkImageData);
152
157 {
158 Nearest = 0x01,
159 Linear = 0x02,
160 Stretch = 0x04,
161 Repeat = 0x08
162 };
163
165
172 vtkSetMacro(TextureProperties, int);
174
176
179 vtkGetMacro(TextureProperties, int);
181
185 void DeepCopy(vtkBrush* brush);
186
187protected:
189 ~vtkBrush() override;
190
191 // Storage of the color in RGBA format (0-255 per channel).
192 unsigned char* Color;
196
197private:
198 vtkBrush(const vtkBrush&) = delete;
199 void operator=(const vtkBrush&) = delete;
200};
201
202#endif // vtkBrush_h
provides a brush that fills shapes drawn by vtkContext2D.
Definition vtkBrush.h:50
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:195
vtkColor4ub BrushColor
Definition vtkBrush.h:193
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:192
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:157
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:131
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:194
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:49
abstract base class for most VTK objects
Definition vtkObject.h:72