represent text properties. More...

#include <vtkTextProperty.h>

Inheritance diagram for vtkTextProperty:

Collaboration diagram for vtkTextProperty:

Public Types
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.

vtkTextProperty *	NewInstance () const

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

void	GetShadowColor (double color[3])
	Get the shadow color.

void	ShallowCopy (vtkTextProperty *tprop)
	Shallow copy of a text property.


virtual void	SetColor (double, double, double)
	Set the color of the text.

virtual void	SetColor (double[3])
	Set the color of the text.

virtual double *	GetColor ()
	Set the color of the text.

virtual void	GetColor (double &, double &, double &)
	Set the color of the text.

virtual void	GetColor (double[3])
	Set the color of the text.


virtual void	SetOpacity (double)
	Set/Get the text's opacity.

virtual double	GetOpacity ()
	Set/Get the text's opacity.


virtual void	SetBackgroundColor (double, double, double)
	The background color.

virtual void	SetBackgroundColor (double[3])
	The background color.

virtual double *	GetBackgroundColor ()
	The background color.

virtual void	GetBackgroundColor (double &, double &, double &)
	The background color.

virtual void	GetBackgroundColor (double[3])
	The background color.


virtual void	SetBackgroundOpacity (double)
	The background opacity.

virtual double	GetBackgroundOpacity ()
	The background opacity.


void	SetBackgroundRGBA (double rgba[4])
	Convenience method to set the background color and the opacity at once.

void	SetBackgroundRGBA (double r, double g, double b, double a)
	Convenience method to set the background color and the opacity at once.

void	GetBackgroundRGBA (double rgba[4])
	Convenience method to get the background color and the opacity at once.

void	GetBackgroundRGBA (double &r, double &g, double &b, double &a)
	Convenience method to set the background color and the opacity at once.


virtual void	SetFrameColor (double, double, double)
	The frame color.

virtual void	SetFrameColor (double[3])
	The frame color.

virtual double *	GetFrameColor ()
	The frame color.

virtual void	GetFrameColor (double &, double &, double &)
	The frame color.

virtual void	GetFrameColor (double[3])
	The frame color.


virtual void	SetFrame (vtkTypeBool)
	Enable/disable text frame.

virtual vtkTypeBool	GetFrame ()
	Enable/disable text frame.

virtual void	FrameOn ()
	Enable/disable text frame.

virtual void	FrameOff ()
	Enable/disable text frame.


virtual void	SetFrameWidth (int)
	Set/Get the width of the frame.

virtual int	GetFrameWidth ()
	Set/Get the width of the frame.


	vtkGetFilePathMacro (FontFile)
	The absolute filepath to a local file containing a freetype-readable font if GetFontFamily() return VTK_FONT_FILE.

	vtkSetFilePathMacro (FontFile)
	The absolute filepath to a local file containing a freetype-readable font if GetFontFamily() return VTK_FONT_FILE.


virtual void	SetFontSize (int)
	Set/Get the font size (in points).

virtual int	GetFontSize ()
	Set/Get the font size (in points).


virtual void	SetBold (vtkTypeBool)
	Enable/disable text bolding.

virtual vtkTypeBool	GetBold ()
	Enable/disable text bolding.

virtual void	BoldOn ()
	Enable/disable text bolding.

virtual void	BoldOff ()
	Enable/disable text bolding.


virtual void	SetItalic (vtkTypeBool)
	Enable/disable text italic.

virtual vtkTypeBool	GetItalic ()
	Enable/disable text italic.

virtual void	ItalicOn ()
	Enable/disable text italic.

virtual void	ItalicOff ()
	Enable/disable text italic.


virtual void	SetShadow (vtkTypeBool)
	Enable/disable text shadow.

virtual vtkTypeBool	GetShadow ()
	Enable/disable text shadow.

virtual void	ShadowOn ()
	Enable/disable text shadow.

virtual void	ShadowOff ()
	Enable/disable text shadow.


virtual void	SetShadowOffset (int, int)
	Set/Get the shadow offset, i.e.

void	SetShadowOffset (int[2])
	Set/Get the shadow offset, i.e.

virtual int *	GetShadowOffset ()
	Set/Get the shadow offset, i.e.

virtual void	GetShadowOffset (int data[2])
	Set/Get the shadow offset, i.e.


virtual void	SetJustification (int)
	Set/Get the horizontal justification to left (default), centered, or right.

virtual int	GetJustification ()
	Set/Get the horizontal justification to left (default), centered, or right.

void	SetJustificationToLeft ()
	Set/Get the horizontal justification to left (default), centered, or right.

void	SetJustificationToCentered ()
	Set/Get the horizontal justification to left (default), centered, or right.

void	SetJustificationToRight ()
	Set/Get the horizontal justification to left (default), centered, or right.

const char *	GetJustificationAsString ()
	Set/Get the horizontal justification to left (default), centered, or right.


virtual void	SetVerticalJustification (int)
	Set/Get the vertical justification to bottom (default), middle, or top.

virtual int	GetVerticalJustification ()
	Set/Get the vertical justification to bottom (default), middle, or top.

void	SetVerticalJustificationToBottom ()
	Set/Get the vertical justification to bottom (default), middle, or top.

void	SetVerticalJustificationToCentered ()
	Set/Get the vertical justification to bottom (default), middle, or top.

void	SetVerticalJustificationToTop ()
	Set/Get the vertical justification to bottom (default), middle, or top.

const char *	GetVerticalJustificationAsString ()
	Set/Get the vertical justification to bottom (default), middle, or top.


virtual void	SetUseTightBoundingBox (vtkTypeBool)
	If this property is on, text is aligned to drawn pixels not to font metrix.

virtual vtkTypeBool	GetUseTightBoundingBox ()
	If this property is on, text is aligned to drawn pixels not to font metrix.

virtual void	UseTightBoundingBoxOn ()
	If this property is on, text is aligned to drawn pixels not to font metrix.

virtual void	UseTightBoundingBoxOff ()
	If this property is on, text is aligned to drawn pixels not to font metrix.


virtual void	SetOrientation (double)
	Set/Get the text's orientation (in degrees).

virtual double	GetOrientation ()
	Set/Get the text's orientation (in degrees).


virtual void	SetLineSpacing (double)
	Set/Get the (extra) spacing between lines, expressed as a text height multiplication factor.

virtual double	GetLineSpacing ()
	Set/Get the (extra) spacing between lines, expressed as a text height multiplication factor.


virtual void	SetLineOffset (double)
	Set/Get the vertical offset (measured in pixels).

virtual double	GetLineOffset ()
	Set/Get the vertical offset (measured in pixels).


virtual void	SetCellOffset (double)
	Set/Get the horizontal offset between cells.

virtual double	GetCellOffset ()
	Set/Get the horizontal offset between cells.


virtual void	SetInteriorLinesVisibility (bool)
	Set/Get the visibility of the interior lines between cells.

virtual bool	GetInteriorLinesVisibility ()
	Set/Get the visibility of the interior lines between cells.


virtual void	SetInteriorLinesWidth (int)
	Set the width (in pixels) of the interior lines between cells.

virtual int	GetInteriorLinesWidth ()
	Set the width (in pixels) of the interior lines between cells.


virtual void	SetInteriorLinesColor (double, double, double)
	Set the color of the interior lines between cells.

virtual void	SetInteriorLinesColor (double[3])
	Set the color of the interior lines between cells.

virtual double *	GetInteriorLinesColor ()
	Set the color of the interior lines between cells.

virtual void	GetInteriorLinesColor (double &, double &, double &)
	Set the color of the interior lines between cells.

virtual void	GetInteriorLinesColor (double[3])
	Set the color of the interior lines between cells.

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 vtkTextProperty *	SafeDownCast (vtkObjectBase *o)

static vtkTextProperty *	New ()
	Creates a new text property with font size 12, bold off, italic off, and Arial font.

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

	vtkTextProperty ()

	~vtkTextProperty () 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
double	Color [3]

double	Opacity

double	BackgroundColor [3]

double	BackgroundOpacity

vtkTypeBool	Frame

double	FrameColor [3]

int	FrameWidth

char *	FontFamilyAsString

char *	FontFile

int	FontSize

vtkTypeBool	Bold

vtkTypeBool	Italic

vtkTypeBool	Shadow

int	ShadowOffset [2]

int	Justification

int	VerticalJustification

vtkTypeBool	UseTightBoundingBox

double	Orientation

double	LineOffset

double	LineSpacing

double	CellOffset

bool	InteriorLinesVisibility = false

int	InteriorLinesWidth = 1

double	InteriorLinesColor [3] = { 0.0, 0.0, 0.0 }

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

static int	GetFontFamilyFromString (const char *f)
	Set/Get the font family.

static const char *	GetFontFamilyAsString (int f)
	Set/Get the font family.

virtual char *	GetFontFamilyAsString ()
	Set/Get the font family.

virtual void	SetFontFamilyAsString (const char *)
	Set/Get the font family.

void	SetFontFamily (int t)
	Set/Get the font family.

int	GetFontFamily ()
	Set/Get the font family.

int	GetFontFamilyMinValue ()
	Set/Get the font family.

void	SetFontFamilyToArial ()
	Set/Get the font family.

void	SetFontFamilyToCourier ()
	Set/Get the font family.

void	SetFontFamilyToTimes ()
	Set/Get the font family.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

represent text properties.

vtkTextProperty is an object that represents text properties. The primary properties that can be set are color, opacity, font size, font family horizontal and vertical justification, bold/italic/shadow styles.

See also: vtkTextMapper vtkTextActor vtkLegendBoxActor vtkCaptionActor2D

Online Examples:

Cell3DDemonstration

LinearCellsDemo

LabelVerticesAndEdges

ElevationBandsWithGlyphs

Tests:: vtkTextProperty (Tests)

Definition at line 135 of file vtkTextProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTextProperty::Superclass

Definition at line 138 of file vtkTextProperty.h.

Constructor & Destructor Documentation

◆ vtkTextProperty()

vtkTextProperty::vtkTextProperty ( )

protected

◆ ~vtkTextProperty()

vtkTextProperty::~vtkTextProperty ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkTextProperty::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 vtkTextProperty * vtkTextProperty::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTextProperty::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkTextProperty * vtkTextProperty::NewInstance ( ) const

◆ PrintSelf()

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

static

Creates a new text property with font size 12, bold off, italic off, and Arial font.

◆ SetColor() [1/2]

virtual void vtkTextProperty::SetColor	(	double	,
		double	,
		double
	)

virtual

Set the color of the text.

◆ SetColor() [2/2]

virtual void vtkTextProperty::SetColor ( double [3] )

virtual

Set the color of the text.

◆ GetColor() [1/3]

virtual double * vtkTextProperty::GetColor ( )

virtual

Set the color of the text.

◆ GetColor() [2/3]

virtual void vtkTextProperty::GetColor	(	double &	,
		double &	,
		double &
	)

virtual

Set the color of the text.

◆ GetColor() [3/3]

virtual void vtkTextProperty::GetColor ( double [3] )

virtual

Set the color of the text.

◆ SetOpacity()

virtual void vtkTextProperty::SetOpacity ( double )

virtual

Set/Get the text's opacity.

1.0 is totally opaque and 0.0 is completely transparent.

◆ GetOpacity()

virtual double vtkTextProperty::GetOpacity ( )

virtual

Set/Get the text's opacity.

1.0 is totally opaque and 0.0 is completely transparent.

◆ SetBackgroundColor() [1/2]

virtual void vtkTextProperty::SetBackgroundColor	(	double	,
		double	,
		double
	)

virtual

The background color.

◆ SetBackgroundColor() [2/2]

virtual void vtkTextProperty::SetBackgroundColor ( double [3] )

virtual

The background color.

◆ GetBackgroundColor() [1/3]

virtual double * vtkTextProperty::GetBackgroundColor ( )

virtual

The background color.

◆ GetBackgroundColor() [2/3]

virtual void vtkTextProperty::GetBackgroundColor	(	double &	,
		double &	,
		double &
	)

virtual

The background color.

◆ GetBackgroundColor() [3/3]

virtual void vtkTextProperty::GetBackgroundColor ( double [3] )

virtual

The background color.

◆ SetBackgroundOpacity()

virtual void vtkTextProperty::SetBackgroundOpacity ( double )

virtual

The background opacity.

1.0 is totally opaque and 0.0 is completely transparent.

◆ GetBackgroundOpacity()

virtual double vtkTextProperty::GetBackgroundOpacity ( )

virtual

The background opacity.

1.0 is totally opaque and 0.0 is completely transparent.

◆ SetBackgroundRGBA() [1/2]

void vtkTextProperty::SetBackgroundRGBA ( double rgba[4] )

Convenience method to set the background color and the opacity at once.

◆ SetBackgroundRGBA() [2/2]

void vtkTextProperty::SetBackgroundRGBA	(	double	r,
		double	g,
		double	b,
		double	a
	)

Convenience method to set the background color and the opacity at once.

◆ GetBackgroundRGBA() [1/2]

void vtkTextProperty::GetBackgroundRGBA ( double rgba[4] )

Convenience method to get the background color and the opacity at once.

◆ GetBackgroundRGBA() [2/2]

void vtkTextProperty::GetBackgroundRGBA	(	double &	r,
		double &	g,
		double &	b,
		double &	a
	)

Convenience method to set the background color and the opacity at once.

◆ SetFrameColor() [1/2]

virtual void vtkTextProperty::SetFrameColor	(	double	,
		double	,
		double
	)

virtual

The frame color.

◆ SetFrameColor() [2/2]

virtual void vtkTextProperty::SetFrameColor ( double [3] )

virtual

The frame color.

◆ GetFrameColor() [1/3]

virtual double * vtkTextProperty::GetFrameColor ( )

virtual

The frame color.

◆ GetFrameColor() [2/3]

virtual void vtkTextProperty::GetFrameColor	(	double &	,
		double &	,
		double &
	)

virtual

The frame color.

◆ GetFrameColor() [3/3]

virtual void vtkTextProperty::GetFrameColor ( double [3] )

virtual

The frame color.

◆ SetFrame()

virtual void vtkTextProperty::SetFrame ( vtkTypeBool )

virtual

Enable/disable text frame.

◆ GetFrame()

virtual vtkTypeBool vtkTextProperty::GetFrame ( )

virtual

Enable/disable text frame.

◆ FrameOn()

virtual void vtkTextProperty::FrameOn ( )

virtual

Enable/disable text frame.

◆ FrameOff()

virtual void vtkTextProperty::FrameOff ( )

virtual

Enable/disable text frame.

◆ SetFrameWidth()

virtual void vtkTextProperty::SetFrameWidth ( int )

virtual

Set/Get the width of the frame.

The width is expressed in pixels. The default is 1 pixel.

◆ GetFrameWidth()

virtual int vtkTextProperty::GetFrameWidth ( )

virtual

Set/Get the width of the frame.

The width is expressed in pixels. The default is 1 pixel.