provides a pen that draws the outlines of shapes drawn by vtkContext2D. More...

#include <vtkPen.h>

Inheritance diagram for vtkPen:

Collaboration diagram for vtkPen:

Public Types
typedef vtkObject	Superclass


enum	{ NO_PEN, SOLID_LINE, DASH_LINE, DOT_LINE, DASH_DOT_LINE, DASH_DOT_DOT_LINE }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPen *	SafeDownCast (vtkObjectBase *o)

static vtkPen *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPen ()

	~vtkPen ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
float	Width

int	LineType


unsigned char *	Color

vtkColor4ub	PenColor

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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)

Definition at line 38 of file vtkPen.h.

Member Typedef Documentation

typedef vtkObject vtkPen::Superclass

Definition at line 41 of file vtkPen.h.

Member Enumeration Documentation

anonymous enum

Enum of the available line types.

Enumerator
NO_PEN
SOLID_LINE
DASH_LINE
DOT_LINE
DASH_DOT_LINE
DASH_DOT_DOT_LINE

Definition at line 49 of file vtkPen.h.

Constructor & Destructor Documentation

vtkPen::vtkPen ( )

protected

vtkPen::~vtkPen ( )

protected

Member Function Documentation

static int vtkPen::IsTypeOf ( const char * type )

static

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

virtual vtkObjectBase* vtkPen::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkPen* vtkPen::NewInstance ( ) const

virtual void vtkPen::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 vtkPen* vtkPen::New ( )

static

void vtkPen::SetLineType ( int type )

Set the type of line that the pen should draw. The default is solid (1).

int vtkPen::GetLineType ( )

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.

vtkColor4ub vtkPen::GetColorObject ( )

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

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

Definition at line 117 of file vtkPen.h.

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

Storage of the color in RGBA format (0-255 per channel).

Definition at line 135 of file vtkPen.h.

vtkColor4ub vtkPen::PenColor

protected

Storage of the color in RGBA format (0-255 per channel).

Definition at line 136 of file vtkPen.h.

float vtkPen::Width

protected

Store the width of the pen in pixels.

Definition at line 140 of file vtkPen.h.

int vtkPen::LineType

protected

The type of line to be drawn with this pen.

Definition at line 143 of file vtkPen.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Context2D/vtkPen.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