VTK  9.2.5
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 
131 #ifndef vtkPen_h
132 #define vtkPen_h
133 
134 #include "vtkColor.h" // Needed for vtkColor4ub
135 #include "vtkObject.h"
136 #include "vtkRenderingContext2DModule.h" // For export macro
137 
138 class VTKRENDERINGCONTEXT2D_EXPORT vtkPen : public vtkObject
139 {
140 public:
141  vtkTypeMacro(vtkPen, vtkObject);
142  void PrintSelf(ostream& os, vtkIndent indent) override;
143 
144  static vtkPen* New();
145 
149  enum
150  {
157  DENSE_DOT_LINE
158  };
159 
163  void SetLineType(int type);
164 
168  int GetLineType();
169 
174  void SetColorF(double color[3]);
175 
180  void SetColorF(double r, double g, double b);
181 
186  void SetColorF(double r, double g, double b, double a);
187 
192  void SetOpacityF(double a);
193 
198  void SetColor(unsigned char color[3]);
199 
204  void SetColor(unsigned char r, unsigned char g, unsigned char b);
205 
207 
211  void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
212  void SetColor(const vtkColor4ub& color);
214 
219  void SetOpacity(unsigned char a);
220 
224  void GetColorF(double color[3]);
225 
229  void GetColor(unsigned char color[3]);
230 
235 
240  unsigned char GetOpacity();
241 
245  unsigned char* GetColor() { return this->Color; }
246 
248 
251  vtkSetMacro(Width, float);
252  vtkGetMacro(Width, float);
254 
258  void DeepCopy(vtkPen* pen);
259 
260 protected:
262  ~vtkPen() override;
263 
265 
268  unsigned char* Color;
271 
275  float Width;
276 
280  int LineType;
281 
282 private:
283  vtkPen(const vtkPen&) = delete;
284  void operator=(const vtkPen&) = delete;
285 };
286 
287 #endif // vtkPen_h
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:139
~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:275
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:268
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:269
@ DASH_LINE
Definition: vtkPen.h:153
@ SOLID_LINE
Definition: vtkPen.h:152
@ NO_PEN
Definition: vtkPen.h:151
@ DOT_LINE
Definition: vtkPen.h:154
@ DASH_DOT_DOT_LINE
Definition: vtkPen.h:156
@ DASH_DOT_LINE
Definition: vtkPen.h:155
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:245
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:280
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