vtkPen Class Reference

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 , DENSE_DOT_LINE }
	Enum of the available line types. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPen *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetLineType (int type)
	Set the type of line that the pen should draw.
int	GetLineType ()
	Get the type of line that the pen will draw.
void	SetColorF (double color[3])
	Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.
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.
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.
void	SetOpacityF (double a)
	Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
void	SetColor (unsigned char color[3])
	Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
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.
void	SetOpacity (unsigned char a)
	Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
void	GetColorF (double color[3])
	Get the color of the brush - expects a double of length 3 to copy into.
void	GetColor (unsigned char color[3])
	Get the color of the brush - expects an unsigned char of length 3.
vtkColor4ub	GetColorObject ()
	Get the color of the pen.
unsigned char	GetOpacity ()
	Get the opacity (unsigned char), ranging from 0 (transparent) to 255 (opaque).
unsigned char *	GetColor ()
	Get the color of the brush - gives a pointer to the underlying data.
void	DeepCopy (vtkPen *pen)
	Make a deep copy of the supplied pen.
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.
void	SetColor (const vtkColor4ub &color)
	Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
virtual void	SetWidth (float)
	Set/Get the width of the pen.
virtual float	GetWidth ()
	Set/Get the width of the pen.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPen ()
	~vtkPen () override
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
float	Width
	Store the width of the pen in pixels.
int	LineType
	The type of line to be drawn with this pen.
unsigned char *	Color
	Storage of the color in RGBA format (0-255 per channel).
vtkColor4ub	PenColor
	Storage of the color in RGBA format (0-255 per channel).
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

Diagram

FunctionalBagPlot

LinePlot3D

SurfacePlot

Tests:

vtkPen (Tests)

Definition at line 78 of file vtkPen.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPen::Superclass

Definition at line 81 of file vtkPen.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enum of the available line types.

Enumerator
NO_PEN
SOLID_LINE
DASH_LINE
DOT_LINE
DASH_DOT_LINE
DASH_DOT_DOT_LINE
DENSE_DOT_LINE

Definition at line 89 of file vtkPen.h.

Constructor & Destructor Documentation

vtkPen()

vtkPen::vtkPen ( )

protected

~vtkPen()

vtkPen::~vtkPen ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPen::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkPen * vtkPen::NewInstance

(

)

const

PrintSelf()

void vtkPen::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

New()

static vtkPen * vtkPen::New ( )

static

SetLineType()

void vtkPen::SetLineType

(

int

type

)

Set the type of line that the pen should draw.

The default is solid (1).

GetLineType()

int vtkPen::GetLineType

(

)

Get the type of line that the pen will draw.

SetColorF() [1/3]

void vtkPen::SetColorF

(

double

color[3]

)

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

SetColorF() [2/3]

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.

SetColorF() [3/3]

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.

SetOpacityF()

void vtkPen::SetOpacityF

(

double

a

)

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

SetColor() [1/4]

void vtkPen::SetColor

(

unsigned char

color[3]

)

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

SetColor() [2/4]

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.

SetColor() [3/4]

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.

SetColor() [4/4]

void vtkPen::SetColor

(

const vtkColor4ub &

color

)

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

SetOpacity()

void vtkPen::SetOpacity

(

unsigned char

a

)

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

GetColorF()

void vtkPen::GetColorF

(

double

color[3]

)

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

GetColor() [1/2]

void vtkPen::GetColor

(

unsigned char

color[3]

)

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

GetColorObject()

vtkColor4ub vtkPen::GetColorObject

(

)

Get the color of the pen.

GetOpacity()

unsigned char vtkPen::GetOpacity

(

)

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

GetColor() [2/2]

unsigned char * vtkPen::GetColor ( )

inline

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

Definition at line 192 of file vtkPen.h.

SetWidth()

virtual void vtkPen::SetWidth ( float  )

virtual

Set/Get the width of the pen.

GetWidth()

virtual float vtkPen::GetWidth ( )

virtual

Set/Get the width of the pen.

DeepCopy()

void vtkPen::DeepCopy

(

vtkPen *

pen

)

Make a deep copy of the supplied pen.

Member Data Documentation

Color

unsigned char* vtkPen::Color

protected

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

Definition at line 215 of file vtkPen.h.

PenColor

vtkColor4ub vtkPen::PenColor

protected

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

Definition at line 216 of file vtkPen.h.

Width

float vtkPen::Width

protected

Store the width of the pen in pixels.

Definition at line 222 of file vtkPen.h.

LineType

int vtkPen::LineType

protected

The type of line to be drawn with this pen.

Definition at line 227 of file vtkPen.h.

---

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

• Rendering/Context2D/vtkPen.h