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 
28 #ifndef vtkBrush_h
29 #define vtkBrush_h
30 
31 #include "vtkRenderingContext2DModule.h" // For export macro
32 #include "vtkObject.h"
33 #include "vtkColor.h" // Needed for vtkColor4ub
34 
35 class vtkImageData;
36 
37 class VTKRENDERINGCONTEXT2D_EXPORT vtkBrush : public vtkObject
38 {
39 public:
40  vtkTypeMacro(vtkBrush, vtkObject);
41  virtual void PrintSelf(ostream &os, vtkIndent indent);
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,
92  unsigned char a);
93  void SetColor(const vtkColor4ub &color);
95 
100  void SetOpacity(unsigned char a);
101 
105  unsigned char GetOpacity();
106 
110  void GetColorF(double color[4]);
111 
115  void GetColor(unsigned char color[4]);
116 
120  unsigned char * GetColor() { return &this->Color[0]; }
121 
126 
134 
136 
139  vtkGetObjectMacro(Texture, vtkImageData);
141 
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 
175 protected:
178 
179  // Storage of the color in RGBA format (0-255 per channel).
180  unsigned char* Color;
184 
185 private:
186  vtkBrush(const vtkBrush &) VTK_DELETE_FUNCTION;
187  void operator=(const vtkBrush &) VTK_DELETE_FUNCTION;
188 
189 };
190 
191 #endif //vtkBrush_h
vtkBrush
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:38
vtkBrush::Texture
vtkImageData * Texture
Definition: vtkBrush.h:182
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:183
vtkBrush::GetColor
unsigned char * GetColor()
Get the color of the brush - gives a pointer to the underlying data.
Definition: vtkBrush.h:120
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::Color
unsigned char * Color
Definition: vtkBrush.h:180
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:181
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::~vtkBrush
~vtkBrush()
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()
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkColor4ub
Definition: vtkColor.h:241
vtkBrush::GetColorObject
vtkColor4ub GetColorObject()
Get the color of the brush.
vtkBrush::PrintSelf
virtual void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkBrush::TextureProperty
TextureProperty
Texture properties.
Definition: vtkBrush.h:145
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.