VTK  9.3.0
vtkPen.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 
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 VTK_ABI_NAMESPACE_BEGIN
37 class VTKRENDERINGCONTEXT2D_EXPORT vtkPen : public vtkObject
38 {
39 public:
40  vtkTypeMacro(vtkPen, vtkObject);
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
43  static vtkPen* New();
44 
48  enum
49  {
56  DENSE_DOT_LINE
57  };
58 
62  void SetLineType(int type);
63 
67  int GetLineType();
68 
73  void SetColorF(double color[3]);
74 
79  void SetColorF(double r, double g, double b);
80 
85  void SetColorF(double r, double g, double b, double a);
86 
91  void SetOpacityF(double a);
92 
97  void SetColor(unsigned char color[3]);
98 
103  void SetColor(unsigned char r, unsigned char g, unsigned char b);
104 
106 
110  void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
111  void SetColor(const vtkColor4ub& color);
113 
118  void SetOpacity(unsigned char a);
119 
123  void GetColorF(double color[3]);
124 
128  void GetColor(unsigned char color[3]);
129 
134 
139  unsigned char GetOpacity();
140 
144  unsigned char* GetColor() { return this->Color; }
145 
147 
150  vtkSetMacro(Width, float);
151  vtkGetMacro(Width, float);
153 
157  void DeepCopy(vtkPen* pen);
158 
159 protected:
161  ~vtkPen() override;
162 
164 
167  unsigned char* Color;
170 
174  float Width;
175 
179  int LineType;
180 
181 private:
182  vtkPen(const vtkPen&) = delete;
183  void operator=(const vtkPen&) = delete;
184 };
185 
186 VTK_ABI_NAMESPACE_END
187 #endif // vtkPen_h
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract base class for most VTK objects
Definition: vtkObject.h:61
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:38
~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:174
static vtkPen * New()
void GetColorF(double color[3])
Get the color of the brush - expects a double of length 3 to copy into.
@ DASH_LINE
Definition: vtkPen.h:52
@ SOLID_LINE
Definition: vtkPen.h:51
@ NO_PEN
Definition: vtkPen.h:50
@ DOT_LINE
Definition: vtkPen.h:53
@ DASH_DOT_DOT_LINE
Definition: vtkPen.h:55
@ DASH_DOT_LINE
Definition: vtkPen.h:54
unsigned char * Color
Storage of the color in RGBA format (0-255 per channel).
Definition: vtkPen.h:167
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....
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:168
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:144
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:179
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:46
@ type
Definition: vtkX3D.h:516
@ color
Definition: vtkX3D.h:221