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
enum	{ NO_PEN, SOLID_LINE, DASH_LINE, DOT_LINE, DASH_DOT_LINE, DASH_DOT_DOT_LINE }
	Enum of the available line types. More...

typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkPen *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

void	SetLineType (int type)
	Set the type of line that the pen should draw. More...

int	GetLineType ()
	Get the type of line that the pen will draw. More...

void	SetColorF (double color[3])
	Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0. More...

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.0. More...

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.0. More...

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

void	SetColor (unsigned char color[3])
	Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255. More...

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

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

void	GetColorF (double color[3])
	Get the color of the brush - expects a double of length 3 to copy into. More...

void	GetColor (unsigned char color[3])
	Get the color of the brush - expects an unsigned char of length 3. More...

vtkColor4ub	GetColorObject ()
	Get the color of the pen. More...

unsigned char	GetOpacity ()
	Get the opacity (unsigned char), ranging from 0 (transparent) to 255 (opaque). More...

unsigned char *	GetColor ()
	Get the color of the brush - gives a pointer to the underlying data. More...

void	DeepCopy (vtkPen *pen)
	Make a deep copy of the supplied pen. More...


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

void	SetColor (const vtkColor4ub &color)
	Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255. More...


virtual void	SetWidth (float)
	Set/Get the width of the pen. More...

virtual float	GetWidth ()
	Set/Get the width of the pen. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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 vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPen ()

	~vtkPen ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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
	Store the width of the pen in pixels. More...

int	LineType
	The type of line to be drawn with this pen. More...


unsigned char *	Color
	Storage of the color in RGBA format (0-255 per channel). More...

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

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 39 of file vtkPen.h.

Member Typedef Documentation

typedef vtkObject vtkPen::Superclass

Definition at line 42 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 50 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 vtkObjectBase.

static vtkPen* vtkPen::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPen::NewInstanceInternal ( ) const

protectedvirtual

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 144 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 167 of file vtkPen.h.

vtkColor4ub vtkPen::PenColor

protected

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

Definition at line 168 of file vtkPen.h.

float vtkPen::Width

protected

Store the width of the pen in pixels.

Definition at line 174 of file vtkPen.h.

int vtkPen::LineType

protected

The type of line to be drawn with this pen.

Definition at line 179 of file vtkPen.h.

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

/home/demarle/Builds/VTK/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