vtkTextProperty Class Reference

#include <vtkTextProperty.h>

Inheritance diagram for vtkTextProperty:

[legend]Collaboration diagram for vtkTextProperty:

[legend]List of all members.

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

Created by:

Barre, Sebastien

CVS contributions (if > 5%):

Barre, Sebastien (97%)

CVS logs (CVSweb):

.h (/Rendering/vtkTextProperty.h)
.cxx (/Rendering/vtkTextProperty.cxx)

Examples:: vtkTextProperty (Examples)

Tests:: vtkTextProperty (Tests)

Definition at line 47 of file vtkTextProperty.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void GetShadowColor (double color[3])

void ShallowCopy (vtkTextProperty *tprop)

virtual void SetColor (double, double, double)

virtual void SetColor (double[3])

virtual double * GetColor ()

virtual void GetColor (double data[3])

virtual void SetOpacity (double)

virtual double GetOpacity ()

virtual void SetFontFamily (int)

virtual int GetFontFamily ()

void SetFontFamilyToArial ()

void SetFontFamilyToCourier ()

void SetFontFamilyToTimes ()

char * GetFontFamilyAsString ()

virtual void SetFontSize (int)

virtual int GetFontSize ()

virtual void SetBold (int)

virtual int GetBold ()

virtual void BoldOn ()

virtual void BoldOff ()

virtual void SetItalic (int)

virtual int GetItalic ()

virtual void ItalicOn ()

virtual void ItalicOff ()

virtual void SetShadow (int)

virtual int GetShadow ()

virtual void ShadowOn ()

virtual void ShadowOff ()

virtual void SetShadowOffset (int, int)

void SetShadowOffset (int[2])

virtual int * GetShadowOffset ()

virtual void GetShadowOffset (int data[2])

virtual void SetJustification (int)

virtual int GetJustification ()

void SetJustificationToLeft ()

void SetJustificationToCentered ()

void SetJustificationToRight ()

char * GetJustificationAsString ()

virtual void SetVerticalJustification (int)

virtual int GetVerticalJustification ()

void SetVerticalJustificationToBottom ()

void SetVerticalJustificationToCentered ()

void SetVerticalJustificationToTop ()

char * GetVerticalJustificationAsString ()

virtual void SetOrientation (double)

virtual double GetOrientation ()

virtual void SetLineSpacing (double)

virtual double GetLineSpacing ()

virtual void SetLineOffset (double)

virtual double GetLineOffset ()

Static Public Member Functions

int IsTypeOf (const char *type)

vtkTextProperty * SafeDownCast (vtkObject *o)

vtkTextProperty * New ()

Protected Member Functions

vtkTextProperty ()

~vtkTextProperty ()

Protected Attributes

double Color [3]

double Opacity

int FontFamily

int FontSize

int Bold

int Italic

int Shadow

int ShadowOffset [2]

int Justification

int VerticalJustification

double Orientation

double LineOffset

double LineSpacing

Member Typedef Documentation

typedef vtkObject vtkTextProperty::Superclass

Reimplemented from vtkObject.
Definition at line 50 of file vtkTextProperty.h.

Constructor & Destructor Documentation

vtkTextProperty::vtkTextProperty ( ) [protected]

vtkTextProperty::~vtkTextProperty ( ) [inline, protected]

Definition at line 170 of file vtkTextProperty.h.

Member Function Documentation

virtual const char* vtkTextProperty::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

int vtkTextProperty::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

virtual int vtkTextProperty::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

vtkTextProperty* vtkTextProperty::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

void vtkTextProperty::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.

vtkTextProperty* vtkTextProperty::New ( ) [static]

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

virtual void vtkTextProperty::SetColor ( double ,

double ,

double

) [virtual]

Set the color of the text.

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

Set the color of the text.

virtual double* vtkTextProperty::GetColor ( ) [virtual]

Set the color of the text.

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

Set the color of the text.

virtual void vtkTextProperty::SetOpacity ( double ) [virtual]

Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual double vtkTextProperty::GetOpacity ( ) [virtual]

Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual void vtkTextProperty::SetFontFamily ( int ) [virtual]

Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).

virtual int vtkTextProperty::GetFontFamily ( ) [virtual]

Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).

void vtkTextProperty::SetFontFamilyToArial ( ) [inline]

Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 75 of file vtkTextProperty.h.
References VTK_ARIAL.

void vtkTextProperty::SetFontFamilyToCourier ( ) [inline]

Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 76 of file vtkTextProperty.h.
References VTK_COURIER.

void vtkTextProperty::SetFontFamilyToTimes ( ) [inline]

Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 77 of file vtkTextProperty.h.
References VTK_TIMES.

char * vtkTextProperty::GetFontFamilyAsString ( ) [inline]

Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).
Definition at line 191 of file vtkTextProperty.h.
References FontFamily.

virtual void vtkTextProperty::SetFontSize ( int ) [virtual]

Set/Get the font size (in points).

virtual int vtkTextProperty::GetFontSize ( ) [virtual]

Set/Get the font size (in points).

virtual void vtkTextProperty::SetBold ( int ) [virtual]

Enable/disable text bolding.

virtual int vtkTextProperty::GetBold ( ) [virtual]

Enable/disable text bolding.

virtual void vtkTextProperty::BoldOn ( ) [virtual]

Enable/disable text bolding.

virtual void vtkTextProperty::BoldOff ( ) [virtual]

Enable/disable text bolding.

virtual void vtkTextProperty::SetItalic ( int ) [virtual]

Enable/disable text italic.

virtual int vtkTextProperty::GetItalic ( ) [virtual]

Enable/disable text italic.

virtual void vtkTextProperty::ItalicOn ( ) [virtual]

Enable/disable text italic.

virtual void vtkTextProperty::ItalicOff ( ) [virtual]

Enable/disable text italic.

virtual void vtkTextProperty::SetShadow ( int ) [virtual]

Enable/disable text shadow.

virtual int vtkTextProperty::GetShadow ( ) [virtual]

Enable/disable text shadow.

virtual void vtkTextProperty::ShadowOn ( ) [virtual]

Enable/disable text shadow.

virtual void vtkTextProperty::ShadowOff ( ) [virtual]

Enable/disable text shadow.

virtual void vtkTextProperty::SetShadowOffset ( int ,

int

) [virtual]

Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize.

void vtkTextProperty::SetShadowOffset ( int [2] )

Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize.

virtual int* vtkTextProperty::GetShadowOffset ( ) [virtual]

Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize.

virtual void vtkTextProperty::GetShadowOffset ( int data[2] ) [virtual]

Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize.

void vtkTextProperty::GetShadowColor ( double color[3] )

Get the shadow color. It is computed from the Color ivar

virtual void vtkTextProperty::SetJustification ( int ) [virtual]

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

virtual int vtkTextProperty::GetJustification ( ) [virtual]

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

void vtkTextProperty::SetJustificationToLeft ( ) [inline]

Set/Get the horizontal justification to left (default), centered, or right.
Definition at line 123 of file vtkTextProperty.h.
References VTK_TEXT_LEFT.

void vtkTextProperty::SetJustificationToCentered ( ) [inline]

Set/Get the horizontal justification to left (default), centered, or right.
Definition at line 125 of file vtkTextProperty.h.
References VTK_TEXT_CENTERED.

void vtkTextProperty::SetJustificationToRight ( ) [inline]

Set/Get the horizontal justification to left (default), centered, or right.
Definition at line 127 of file vtkTextProperty.h.
References VTK_TEXT_RIGHT.

char * vtkTextProperty::GetJustificationAsString ( ) [inline]

Set/Get the horizontal justification to left (default), centered, or right.
Definition at line 208 of file vtkTextProperty.h.
References Justification.

virtual void vtkTextProperty::SetVerticalJustification ( int ) [virtual]

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

virtual int vtkTextProperty::GetVerticalJustification ( ) [virtual]

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

void vtkTextProperty::SetVerticalJustificationToBottom ( ) [inline]

Set/Get the vertical justification to bottom (default), middle, or top.
Definition at line 137 of file vtkTextProperty.h.
References VTK_TEXT_BOTTOM.

void vtkTextProperty::SetVerticalJustificationToCentered ( ) [inline]

Set/Get the vertical justification to bottom (default), middle, or top.
Definition at line 139 of file vtkTextProperty.h.
References VTK_TEXT_CENTERED.

void vtkTextProperty::SetVerticalJustificationToTop ( ) [inline]

Set/Get the vertical justification to bottom (default), middle, or top.
Definition at line 141 of file vtkTextProperty.h.
References VTK_TEXT_TOP.

char * vtkTextProperty::GetVerticalJustificationAsString ( ) [inline]

Set/Get the vertical justification to bottom (default), middle, or top.
Definition at line 225 of file vtkTextProperty.h.
References VerticalJustification.

virtual void vtkTextProperty::SetOrientation ( double ) [virtual]

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

virtual double vtkTextProperty::GetOrientation ( ) [virtual]

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

virtual void vtkTextProperty::SetLineSpacing ( double ) [virtual]

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

virtual double vtkTextProperty::GetLineSpacing ( ) [virtual]

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

virtual void vtkTextProperty::SetLineOffset ( double ) [virtual]

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

virtual double vtkTextProperty::GetLineOffset ( ) [virtual]

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

void vtkTextProperty::ShallowCopy ( vtkTextProperty * tprop )

Shallow copy of a text property.

Member Data Documentation

double vtkTextProperty::Color[3] [protected]

Definition at line 172 of file vtkTextProperty.h.

double vtkTextProperty::Opacity [protected]

Definition at line 173 of file vtkTextProperty.h.

int vtkTextProperty::FontFamily [protected]

Definition at line 174 of file vtkTextProperty.h.
Referenced by GetFontFamilyAsString().

int vtkTextProperty::FontSize [protected]

Definition at line 175 of file vtkTextProperty.h.

int vtkTextProperty::Bold [protected]

Definition at line 176 of file vtkTextProperty.h.

int vtkTextProperty::Italic [protected]

Definition at line 177 of file vtkTextProperty.h.

int vtkTextProperty::Shadow [protected]

Definition at line 178 of file vtkTextProperty.h.

int vtkTextProperty::ShadowOffset[2] [protected]

Definition at line 179 of file vtkTextProperty.h.

int vtkTextProperty::Justification [protected]

Definition at line 180 of file vtkTextProperty.h.
Referenced by GetJustificationAsString().

int vtkTextProperty::VerticalJustification [protected]

Definition at line 181 of file vtkTextProperty.h.
Referenced by GetVerticalJustificationAsString().

double vtkTextProperty::Orientation [protected]

Definition at line 182 of file vtkTextProperty.h.

double vtkTextProperty::LineOffset [protected]

Definition at line 183 of file vtkTextProperty.h.

double vtkTextProperty::LineSpacing [protected]

Definition at line 184 of file vtkTextProperty.h.

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

dox/Rendering/vtkTextProperty.h


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	GetShadowColor (double color[3])
void	ShallowCopy (vtkTextProperty *tprop)

virtual void	SetColor (double, double, double)
virtual void	SetColor (double[3])
virtual double *	GetColor ()
virtual void	GetColor (double data[3])

virtual void	SetOpacity (double)
virtual double	GetOpacity ()

virtual void	SetFontFamily (int)
virtual int	GetFontFamily ()
void	SetFontFamilyToArial ()
void	SetFontFamilyToCourier ()
void	SetFontFamilyToTimes ()
char *	GetFontFamilyAsString ()

virtual void	SetFontSize (int)
virtual int	GetFontSize ()

virtual void	SetBold (int)
virtual int	GetBold ()
virtual void	BoldOn ()
virtual void	BoldOff ()

virtual void	SetItalic (int)
virtual int	GetItalic ()
virtual void	ItalicOn ()
virtual void	ItalicOff ()

virtual void	SetShadow (int)
virtual int	GetShadow ()
virtual void	ShadowOn ()
virtual void	ShadowOff ()

virtual void	SetShadowOffset (int, int)
void	SetShadowOffset (int[2])
virtual int *	GetShadowOffset ()
virtual void	GetShadowOffset (int data[2])

virtual void	SetJustification (int)
virtual int	GetJustification ()
void	SetJustificationToLeft ()
void	SetJustificationToCentered ()
void	SetJustificationToRight ()
char *	GetJustificationAsString ()

virtual void	SetVerticalJustification (int)
virtual int	GetVerticalJustification ()
void	SetVerticalJustificationToBottom ()
void	SetVerticalJustificationToCentered ()
void	SetVerticalJustificationToTop ()
char *	GetVerticalJustificationAsString ()

virtual void	SetOrientation (double)
virtual double	GetOrientation ()

virtual void	SetLineSpacing (double)
virtual double	GetLineSpacing ()

virtual void	SetLineOffset (double)
virtual double	GetLineOffset ()
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkTextProperty *	SafeDownCast (vtkObject *o)
vtkTextProperty *	New ()
Protected Member Functions
	vtkTextProperty ()
	~vtkTextProperty ()
Protected Attributes
double	Color [3]
double	Opacity
int	FontFamily
int	FontSize
int	Bold
int	Italic
int	Shadow
int	ShadowOffset [2]
int	Justification
int	VerticalJustification
double	Orientation
double	LineOffset
double	LineSpacing