provides a brush that fills shapes drawn by vtkContext2D. More...

#include <vtkBrush.h>

Inheritance diagram for vtkBrush:

Collaboration diagram for vtkBrush:

Public Types
typedef vtkObject	Superclass

enum	TextureProperty { Nearest = 0x01, Linear = 0x02, Stretch = 0x04, Repeat = 0x08 }
Public Member Functions
virtual int	IsA (const char *type)
vtkBrush *	NewInstance () const
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)
double	GetOpacityF ()
void	SetColor (unsigned char color[3])
void	SetColor (unsigned char r, unsigned char g, unsigned char b)
void	SetOpacity (unsigned char a)
unsigned char	GetOpacity ()
void	GetColorF (double color[4])
void	GetColor (unsigned char color[4])
unsigned char *	GetColor ()
vtkColor4ub	GetColorObject ()
void	SetTexture (vtkImageData *image)
void	DeepCopy (vtkBrush *brush)

void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
void	SetColor (const vtkColor4ub &color)

virtual vtkImageData *	GetTexture ()

virtual void	SetTextureProperties (int)

virtual int	GetTextureProperties ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkBrush *	SafeDownCast (vtkObjectBase *o)
static vtkBrush *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBrush ()
	~vtkBrush ()
Protected Attributes
unsigned char *	Color
vtkColor4ub	BrushColor
vtkImageData *	Texture
int	TextureProperties

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 36 of file vtkBrush.h.

Member Typedef Documentation

typedef vtkObject vtkBrush::Superclass

Reimplemented from vtkObject.

Definition at line 39 of file vtkBrush.h.

Member Enumeration Documentation

enum vtkBrush::TextureProperty

Texture properties

Enumerator:

Nearest
Linear
Stretch
Repeat

Definition at line 111 of file vtkBrush.h.

Constructor & Destructor Documentation

vtkBrush::vtkBrush ( ) [protected]

vtkBrush::~vtkBrush ( ) [protected]

Member Function Documentation

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 ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkBrush::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkBrush* vtkBrush::NewInstance ( ) const

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).

double vtkBrush::GetOpacityF ( )

Get the opacity 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::SetColor ( const vtkColor4ub & color )

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).

unsigned char vtkBrush::GetOpacity ( )

Get the opacity 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 94 of file vtkBrush.h.

vtkColor4ub vtkBrush::GetColorObject ( )

Get the color of the brush.

void vtkBrush::SetTexture ( vtkImageData * image )

Set the texture that will be used to fill polygons By default, no texture is set. The image will be registered with the brush (ref count is incremented) To disable the texture, set Texture to 0.

virtual vtkImageData* vtkBrush::GetTexture ( ) [virtual]

Get the texture that is used to fill polygons

virtual void vtkBrush::SetTextureProperties ( int ) [virtual]

Set properties to the texture By default, the texture is linearly stretched. The behavior is undefined when Linear and Nearest are both set The behavior is undefined when Stretch and Repeat are both set The behavior is undefined if TextureProperties is 0

virtual int vtkBrush::GetTextureProperties ( ) [virtual]

Get the properties associated to the texture

void vtkBrush::DeepCopy ( vtkBrush * brush )

Make a deep copy of the supplied brush.

Member Data Documentation

unsigned char* vtkBrush::Color [protected]

Definition at line 141 of file vtkBrush.h.

vtkColor4ub vtkBrush::BrushColor [protected]

Definition at line 142 of file vtkBrush.h.

vtkImageData* vtkBrush::Texture [protected]

Definition at line 143 of file vtkBrush.h.

int vtkBrush::TextureProperties [protected]

Definition at line 144 of file vtkBrush.h.

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

dox/Rendering/Context2D/vtkBrush.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation