VTK  9.1.0
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
38#ifndef vtkPen_h
39#define vtkPen_h
40
41#include "vtkColor.h" // Needed for vtkColor4ub
42#include "vtkObject.h"
43#include "vtkRenderingContext2DModule.h" // For export macro
44
45class VTKRENDERINGCONTEXT2D_EXPORT vtkPen : public vtkObject
46{
47public:
48 vtkTypeMacro(vtkPen, vtkObject);
49 void PrintSelf(ostream& os, vtkIndent indent) override;
50
51 static vtkPen* New();
52
56 enum
57 {
64 DENSE_DOT_LINE
65 };
66
70 void SetLineType(int type);
71
76
81 void SetColorF(double color[3]);
82
87 void SetColorF(double r, double g, double b);
88
93 void SetColorF(double r, double g, double b, double a);
94
99 void SetOpacityF(double a);
100
105 void SetColor(unsigned char color[3]);
106
111 void SetColor(unsigned char r, unsigned char g, unsigned char b);
112
114
118 void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
121
126 void SetOpacity(unsigned char a);
127
131 void GetColorF(double color[3]);
132
136 void GetColor(unsigned char color[3]);
137
142
147 unsigned char GetOpacity();
148
152 unsigned char* GetColor() { return this->Color; }
153
155
158 vtkSetMacro(Width, float);
159 vtkGetMacro(Width, float);
161
165 void DeepCopy(vtkPen* pen);
166
167protected:
169 ~vtkPen() override;
170
172
175 unsigned char* Color;
178
182 float Width;
183
188
189private:
190 vtkPen(const vtkPen&) = delete;
191 void operator=(const vtkPen&) = delete;
192};
193
194#endif // vtkPen_h
a simple class to control print indentation
Definition: vtkIndent.h:43
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:46
~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:182
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:175
unsigned char * GetColor()
Get the color of the brush - gives a pointer to the underlying data.
Definition: vtkPen.h:152
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)
Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
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....
@ DASH_LINE
Definition: vtkPen.h:60
@ SOLID_LINE
Definition: vtkPen.h:59
@ NO_PEN
Definition: vtkPen.h:58
@ DOT_LINE
Definition: vtkPen.h:61
@ DASH_DOT_DOT_LINE
Definition: vtkPen.h:63
@ DASH_DOT_LINE
Definition: vtkPen.h:62
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
Storage of the color in RGBA format (0-255 per channel).
Definition: vtkPen.h:176
void SetOpacityF(double a)
Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
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:187
void DeepCopy(vtkPen *pen)
Make a deep copy of the supplied pen.
static vtkPen * New()
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