VTK
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
32#ifndef vtkPen_h
33#define vtkPen_h
34
35#include "vtkRenderingContext2DModule.h" // For export macro
36#include "vtkObject.h"
37#include "vtkColor.h" // Needed for vtkColor4ub
38
39class VTKRENDERINGCONTEXT2D_EXPORT vtkPen : public vtkObject
40{
41public:
42 vtkTypeMacro(vtkPen, vtkObject);
43 virtual void PrintSelf(ostream &os, vtkIndent indent);
44
45 static vtkPen *New();
46
50 enum {
56 DASH_DOT_DOT_LINE};
57
61 void SetLineType(int type);
62
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,
110 unsigned char a);
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
159protected:
162
164
167 unsigned char* Color;
170
174 float Width;
175
180
181private:
182 vtkPen(const vtkPen &) VTK_DELETE_FUNCTION;
183 void operator=(const vtkPen &) VTK_DELETE_FUNCTION;
184
185};
186
187#endif //vtkPen_h
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:60
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:40
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....
@ DASH_LINE
Definition: vtkPen.h:53
@ SOLID_LINE
Definition: vtkPen.h:52
@ NO_PEN
Definition: vtkPen.h:51
@ DOT_LINE
Definition: vtkPen.h:54
@ DASH_DOT_LINE
Definition: vtkPen.h:55
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
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:167
unsigned char * GetColor()
Get the color of the brush - gives a pointer to the underlying data.
Definition: vtkPen.h:144
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:168
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.
int LineType
The type of line to be drawn with this pen.
Definition: vtkPen.h:179
virtual void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
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:46
@ type
Definition: vtkX3D.h:516
@ color
Definition: vtkX3D.h:221
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.