VTK  9.0.2
vtkPen.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPen.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 
29 #ifndef vtkPen_h
30 #define vtkPen_h
31 
32 #include "vtkColor.h" // Needed for vtkColor4ub
33 #include "vtkObject.h"
34 #include "vtkRenderingContext2DModule.h" // For export macro
35 
36 class VTKRENDERINGCONTEXT2D_EXPORT vtkPen : public vtkObject
37 {
38 public:
39  vtkTypeMacro(vtkPen, vtkObject);
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
42  static vtkPen* New();
43 
47  enum
48  {
55  DENSE_DOT_LINE
56  };
57 
61  void SetLineType(int type);
62 
66  int GetLineType();
67 
72  void SetColorF(double color[3]);
73 
78  void SetColorF(double r, double g, double b);
79 
84  void SetColorF(double r, double g, double b, double a);
85 
90  void SetOpacityF(double a);
91 
96  void SetColor(unsigned char color[3]);
97 
102  void SetColor(unsigned char r, unsigned char g, unsigned char b);
103 
105 
109  void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
110  void SetColor(const vtkColor4ub& color);
112 
117  void SetOpacity(unsigned char a);
118 
122  void GetColorF(double color[3]);
123 
127  void GetColor(unsigned char color[3]);
128 
133 
138  unsigned char GetOpacity();
139 
143  unsigned char* GetColor() { return this->Color; }
144 
146 
149  vtkSetMacro(Width, float);
150  vtkGetMacro(Width, float);
152 
156  void DeepCopy(vtkPen* pen);
157 
158 protected:
160  ~vtkPen() override;
161 
163 
166  unsigned char* Color;
169 
173  float Width;
174 
178  int LineType;
179 
180 private:
181  vtkPen(const vtkPen&) = delete;
182  void operator=(const vtkPen&) = delete;
183 };
184 
185 #endif // vtkPen_h
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:37
~vtkPen() override
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....
unsigned char GetOpacity()
Get the opacity (unsigned char), ranging from 0 (transparent) to 255 (opaque).
void SetOpacity(unsigned char a)
Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
float Width
Store the width of the pen in pixels.
Definition: vtkPen.h:173
static vtkPen * New()
void GetColorF(double color[3])
Get the color of the brush - expects a double of length 3 to copy into.
unsigned char * Color
Storage of the color in RGBA format (0-255 per channel).
Definition: vtkPen.h:166
void SetColorF(double color[3])
Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1....
void SetColor(const vtkColor4ub &color)
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....
void SetLineType(int type)
Set the type of line that the pen should draw.
void GetColor(unsigned char color[3])
Get the color of the brush - expects an unsigned char of length 3.
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.
void SetColor(unsigned char color[3])
Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
vtkColor4ub PenColor
Definition: vtkPen.h:167
void SetOpacityF(double a)
Set the opacity with a double, 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: vtkPen.h:143
vtkColor4ub GetColorObject()
Get the color of the pen.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int LineType
The type of line to be drawn with this pen.
Definition: vtkPen.h:178
@ DASH_LINE
Definition: vtkPen.h:51
@ SOLID_LINE
Definition: vtkPen.h:50
@ NO_PEN
Definition: vtkPen.h:49
@ DOT_LINE
Definition: vtkPen.h:52
@ DASH_DOT_DOT_LINE
Definition: vtkPen.h:54
@ DASH_DOT_LINE
Definition: vtkPen.h:53
void DeepCopy(vtkPen *pen)
Make a deep copy of the supplied pen.
int GetLineType()
Get the type of line that the pen will draw.
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.
@ Color
Definition: vtkX3D.h:52
@ type
Definition: vtkX3D.h:522
@ color
Definition: vtkX3D.h:227