vtkBrush Class Reference

#include <vtkBrush.h>

Inheritance diagram for vtkBrush:

Inheritance graph
[legend]
Collaboration diagram for vtkBrush:

Collaboration graph
[legend]

List of all members.


Detailed Description

provides a brush that fills shapes drawn by vtkContext2D.

The vtkBrush defines the fill (or pattern) 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.

Definition at line 33 of file vtkBrush.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
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[4])
void GetColor (unsigned char color[4])
unsigned char * GetColor ()
void DeepCopy (vtkBrush *brush)
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkBrushSafeDownCast (vtkObject *o)
static vtkBrushNew ()

Protected Member Functions

 vtkBrush ()
 ~vtkBrush ()

Protected Attributes

unsigned char * Color
vtkColor4ub BrushColor

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 36 of file vtkBrush.h.


Constructor & Destructor Documentation

vtkBrush::vtkBrush (  )  [protected]

vtkBrush::~vtkBrush (  )  [protected]


Member Function Documentation

virtual const char* vtkBrush::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkBrush::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 vtkBrush::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 vtkBrush* vtkBrush::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

virtual void vtkBrush::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkBrush* vtkBrush::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

void vtkBrush::SetColorF ( double  color[3]  ) 

Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.

void vtkBrush::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 vtkBrush::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 vtkBrush::SetOpacityF ( double  a  ) 

Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).

void vtkBrush::SetColor ( unsigned char  color[3]  ) 

Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.

void vtkBrush::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 vtkBrush::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 vtkBrush::SetOpacity ( unsigned char  a  ) 

Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).

void vtkBrush::GetColorF ( double  color[4]  ) 

Get the color of the brush - expects a double of length 4 to copy into.

void vtkBrush::GetColor ( unsigned char  color[4]  ) 

Get the color of the brush - expects an unsigned char of length 4.

unsigned char* vtkBrush::GetColor (  )  [inline]

Get the color of the brush - gives a pointer to the underlying data.

Definition at line 84 of file vtkBrush.h.

void vtkBrush::DeepCopy ( vtkBrush brush  ) 

Make a deep copy of the supplied brush.


Member Data Documentation

unsigned char* vtkBrush::Color [protected]

Definition at line 95 of file vtkBrush.h.

Definition at line 96 of file vtkBrush.h.


The documentation for this class was generated from the following file:

Generated on Mon Sep 27 18:19:02 2010 for VTK by  doxygen 1.5.6