VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkTextProperty Class Reference

represent text properties. More...

#include <vtkTextProperty.h>

Inheritance diagram for vtkTextProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkTextProperty:
Collaboration graph
[legend]

List of all members.

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 doubleGetColor ()
virtual void GetColor (double &, double &, double &)
virtual void GetColor (double[3])
virtual void SetOpacity (double)
virtual double GetOpacity ()
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 intGetShadowOffset ()
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 vtkTextPropertySafeDownCast (vtkObject *o)
static vtkTextPropertyNew ()

Protected Member Functions

 vtkTextProperty ()
 ~vtkTextProperty ()

Protected Attributes

double Color [3]
double Opacity
char * FontFamilyAsString
int FontSize
int Bold
int Italic
int Shadow
int ShadowOffset [2]
int Justification
int VerticalJustification
double Orientation
double LineOffset
double LineSpacing
virtual char * GetFontFamilyAsString ()
virtual void SetFontFamilyAsString (const char *)
void SetFontFamily (int t)
int GetFontFamily ()
int GetFontFamilyMinValue ()
void SetFontFamilyToArial ()
void SetFontFamilyToCourier ()
void SetFontFamilyToTimes ()
static int GetFontFamilyFromString (const char *f)
static const char * GetFontFamilyAsString (int f)

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 37 of file vtkTextProperty.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 40 of file vtkTextProperty.h.


Constructor & Destructor Documentation

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

Member Function Documentation

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

Reimplemented from vtkObject.

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

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 char* vtkTextProperty::GetFontFamilyAsString ( ) [virtual]

Set/Get the font family. Supports legacy three font family system.

virtual void vtkTextProperty::SetFontFamilyAsString ( const char *  ) [virtual]

Set/Get the font family. Supports legacy three font family system.

void vtkTextProperty::SetFontFamily ( int  t) [inline]

Set/Get the font family. Supports legacy three font family system.

Definition at line 201 of file vtkTextProperty.h.

int vtkTextProperty::GetFontFamily ( ) [inline]

Set/Get the font family. Supports legacy three font family system.

Definition at line 238 of file vtkTextProperty.h.

int vtkTextProperty::GetFontFamilyMinValue ( ) [inline]

Set/Get the font family. Supports legacy three font family system.

Definition at line 66 of file vtkTextProperty.h.

void vtkTextProperty::SetFontFamilyToArial ( ) [inline]

Set/Get the font family. Supports legacy three font family system.

Definition at line 206 of file vtkTextProperty.h.

void vtkTextProperty::SetFontFamilyToCourier ( ) [inline]

Set/Get the font family. Supports legacy three font family system.

Definition at line 211 of file vtkTextProperty.h.

void vtkTextProperty::SetFontFamilyToTimes ( ) [inline]

Set/Get the font family. Supports legacy three font family system.

Definition at line 216 of file vtkTextProperty.h.

int vtkTextProperty::GetFontFamilyFromString ( const char *  f) [inline, static]

Set/Get the font family. Supports legacy three font family system.

Definition at line 221 of file vtkTextProperty.h.

const char * vtkTextProperty::GetFontFamilyAsString ( int  f) [inline, static]

Set/Get the font family. Supports legacy three font family system.

Definition at line 184 of file vtkTextProperty.h.

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 116 of file vtkTextProperty.h.

void vtkTextProperty::SetJustificationToCentered ( ) [inline]

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

Definition at line 118 of file vtkTextProperty.h.

void vtkTextProperty::SetJustificationToRight ( ) [inline]

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

Definition at line 120 of file vtkTextProperty.h.

const char * vtkTextProperty::GetJustificationAsString ( void  ) [inline]

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

Definition at line 243 of file vtkTextProperty.h.

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 130 of file vtkTextProperty.h.

void vtkTextProperty::SetVerticalJustificationToCentered ( ) [inline]

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

Definition at line 132 of file vtkTextProperty.h.

void vtkTextProperty::SetVerticalJustificationToTop ( ) [inline]

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

Definition at line 134 of file vtkTextProperty.h.

const char * vtkTextProperty::GetVerticalJustificationAsString ( void  ) [inline]

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

Definition at line 260 of file vtkTextProperty.h.

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

Definition at line 165 of file vtkTextProperty.h.

Definition at line 166 of file vtkTextProperty.h.

Definition at line 167 of file vtkTextProperty.h.

Definition at line 168 of file vtkTextProperty.h.

Definition at line 169 of file vtkTextProperty.h.

Definition at line 170 of file vtkTextProperty.h.

Definition at line 171 of file vtkTextProperty.h.

Definition at line 172 of file vtkTextProperty.h.

Definition at line 173 of file vtkTextProperty.h.

Definition at line 174 of file vtkTextProperty.h.

Definition at line 175 of file vtkTextProperty.h.

Definition at line 176 of file vtkTextProperty.h.

Definition at line 177 of file vtkTextProperty.h.


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