represent text properties. More...

#include <vtkTextProperty.h>

Inheritance diagram for vtkTextProperty:

Collaboration diagram for vtkTextProperty:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkTextProperty *	NewInstance () const
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 &, double &, double &)
virtual void	GetColor (double[3])

virtual void	SetOpacity (double)
virtual double	GetOpacity ()

virtual void	SetBackgroundColor (double, double, double)
virtual void	SetBackgroundColor (double[3])
virtual double *	GetBackgroundColor ()
virtual void	GetBackgroundColor (double &, double &, double &)
virtual void	GetBackgroundColor (double[3])

virtual void	SetBackgroundOpacity (double)
virtual double	GetBackgroundOpacity ()

virtual char *	GetFontFile ()
virtual void	SetFontFile (const char *)

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 ()
const char *	GetJustificationAsString ()

virtual void	SetVerticalJustification (int)
virtual int	GetVerticalJustification ()
void	SetVerticalJustificationToBottom ()
void	SetVerticalJustificationToCentered ()
void	SetVerticalJustificationToTop ()
const 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
static int	IsTypeOf (const char *type)
static vtkTextProperty *	SafeDownCast (vtkObjectBase *o)
static vtkTextProperty *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTextProperty ()
	~vtkTextProperty ()
Protected Attributes
double	Color [3]
double	Opacity
double	BackgroundColor [3]
double	BackgroundOpacity
char *	FontFamilyAsString
char *	FontFile
int	FontSize
int	Bold
int	Italic
int	Shadow
int	ShadowOffset [2]
int	Justification
int	VerticalJustification
double	Orientation
double	LineOffset
double	LineSpacing
static int	GetFontFamilyFromString (const char *f)
static const char *	GetFontFamilyAsString (int f)
virtual char *	GetFontFamilyAsString ()
virtual void	SetFontFamilyAsString (const char *)
void	SetFontFamily (int t)
int	GetFontFamily ()
int	GetFontFamilyMinValue ()
void	SetFontFamilyToArial ()
void	SetFontFamilyToCourier ()
void	SetFontFamilyToTimes ()

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

Examples:: vtkTextProperty (Examples)

Tests:: vtkTextProperty (Tests)

Definition at line 38 of file vtkTextProperty.h.

Member Typedef Documentation

typedef vtkObject vtkTextProperty::Superclass

Reimplemented from vtkObject.

Definition at line 41 of file vtkTextProperty.h.

Constructor & Destructor Documentation

vtkTextProperty::vtkTextProperty ( ) [protected]

vtkTextProperty::~vtkTextProperty ( ) [protected]

Member Function Documentation

static int vtkTextProperty::IsTypeOf ( const char * name ) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int 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 vtkObject.

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

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkTextProperty::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkTextProperty* vtkTextProperty::NewInstance ( ) const

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.

static 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 &	,
		double &	,
		double &
	)		`[virtual]`

Set the color of the text.

virtual void vtkTextProperty::GetColor ( double [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::SetBackgroundColor	(	double	,
		double	,
		double
	)		`[virtual]`

The background color.

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

The background color.

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

The background color.

virtual void vtkTextProperty::GetBackgroundColor	(	double &	,
		double &	,
		double &
	)		`[virtual]`

The background color.

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

The background color.

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

The background opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual double vtkTextProperty::GetBackgroundOpacity ( ) [virtual]

The background opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual char* vtkTextProperty::GetFontFamilyAsString ( ) [virtual]