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
30
31#ifndef vtkBrush_h
32#define vtkBrush_h
33
34#include "vtkColor.h" // Needed for vtkColor4ub
35#include "vtkObject.h"
36#include "vtkRenderingContext2DModule.h" // For export macro
37
38class vtkImageData;
39
40class VTKRENDERINGCONTEXT2D_EXPORT vtkBrush : public vtkObject
41{
42public:
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, unsigned char a);
95 void SetColor(const vtkColor4ub& color);
97
102 void SetOpacity(unsigned char a);
103
107 unsigned char GetOpacity();
108
112 void GetColorF(double color[4]);
113
117 void GetColor(unsigned char color[4]);
118
122 unsigned char* GetColor() { return &this->Color[0]; }
123
128
136
138
141 vtkGetObjectMacro(Texture, vtkImageData);
143
148 {
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
178protected:
180 ~vtkBrush() override;
181
182 // Storage of the color in RGBA format (0-255 per channel).
183 unsigned char* Color;
187
188private:
189 vtkBrush(const vtkBrush&) = delete;
190 void operator=(const vtkBrush&) = delete;
191};
192
193#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:186
vtkColor4ub BrushColor
Definition vtkBrush.h:184
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:183
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:148
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:122
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:185
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:40