provides a pen that draws the outlines of shapes drawn by vtkContext2D. More...
#include <vtkPen.h>
Public Types | |
| typedef vtkObject | Superclass |
| enum | { NO_PEN, SOLID_LINE, DASH_LINE, DOT_LINE, DASH_DOT_LINE, DASH_DOT_DOT_LINE } |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkPen * | NewInstance () const |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| void | SetLineType (int type) |
| int | GetLineType () |
| void | SetColorF (double color[3]) |
| void | SetColorF (double r, double g, double b) |
| void | SetColorF (double r, double g, double b, double a) |
| void | SetOpacityF (double a) |
| void | SetColor (unsigned char color[3]) |
| void | SetColor (unsigned char r, unsigned char g, unsigned char b) |
| void | SetOpacity (unsigned char a) |
| void | GetColorF (double color[3]) |
| void | GetColor (unsigned char color[3]) |
| vtkColor4ub | GetColorObject () |
| unsigned char | GetOpacity () |
| unsigned char * | GetColor () |
| void | DeepCopy (vtkPen *pen) |
| void | SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a) |
| void | SetColor (const vtkColor4ub &color) |
| virtual void | SetWidth (float) |
| virtual float | GetWidth () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPen * | SafeDownCast (vtkObjectBase *o) |
| static vtkPen * | New () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkPen () | |
| ~vtkPen () | |
Protected Attributes | |
| float | Width |
| int | LineType |
| unsigned char * | Color |
| vtkColor4ub | PenColor |
Detailed Description
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
The vtkPen defines the outline of shapes that are drawn by vtkContext2D. The color is stored as four unsigned chars (RGBA), where the opacity defaults to 255, but can be modified separately to the other components. Ideally we would use a lightweight color class to store and pass around colors.
- Tests:
- vtkPen (Tests)
Member Typedef Documentation
| typedef vtkObject vtkPen::Superclass |
Member Enumeration Documentation
| anonymous enum |
Constructor & Destructor Documentation
| vtkPen::vtkPen | ( | ) | [protected] |
| vtkPen::~vtkPen | ( | ) | [protected] |
Member Function Documentation
| static int vtkPen::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
| virtual int vtkPen::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
| static vtkPen* vtkPen::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
| virtual vtkObjectBase* vtkPen::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
| vtkPen* vtkPen::NewInstance | ( | ) | const |
Reimplemented from vtkObject.
| virtual void vtkPen::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
| static vtkPen* vtkPen::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| void vtkPen::SetLineType | ( | int | type | ) |
Set the type of line that the pen should draw. The default is solid (1).
Get the type of line that the pen will draw.
| void vtkPen::SetColorF | ( | double | color[3] | ) |
Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.
| void vtkPen::SetColorF | ( | double | r, |
| double | g, | ||
| double | b | ||
| ) |
Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.
| void vtkPen::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.0.
| void vtkPen::SetOpacityF | ( | double | a | ) |
Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
| void vtkPen::SetColor | ( | unsigned char | color[3] | ) |
Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
| void vtkPen::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 vtkPen::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.
| void vtkPen::SetColor | ( | const vtkColor4ub & | color | ) |
Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
| void vtkPen::SetOpacity | ( | unsigned char | a | ) |
Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
| void vtkPen::GetColorF | ( | double | color[3] | ) |
Get the color of the brush - expects a double of length 3 to copy into.
| void vtkPen::GetColor | ( | unsigned char | color[3] | ) |
Get the color of the brush - expects an unsigned char of length 3.
Get the color of the pen.
| unsigned char vtkPen::GetOpacity | ( | ) |
Get the opacity (unsigned char), ranging from 0 (transparent) to 255 (opaque).
| unsigned char* vtkPen::GetColor | ( | ) | [inline] |
| virtual void vtkPen::SetWidth | ( | float | ) | [virtual] |
Set/Get the width of the pen.
| virtual float vtkPen::GetWidth | ( | ) | [virtual] |
Set/Get the width of the pen.
| void vtkPen::DeepCopy | ( | vtkPen * | pen | ) |
Make a deep copy of the supplied pen.
Member Data Documentation
unsigned char* vtkPen::Color [protected] |
vtkColor4ub vtkPen::PenColor [protected] |
float vtkPen::Width [protected] |
int vtkPen::LineType [protected] |
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/Context2D/vtkPen.h
