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
- Examples:
- vtkTextProperty (Examples)
- Tests:
- vtkTextProperty (Tests)
Definition at line 38 of file vtkTextProperty.h.
Member Typedef Documentation
Constructor & Destructor Documentation
vtkTextProperty::vtkTextProperty |
( |
|
) |
[protected] |
|
vtkTextProperty::~vtkTextProperty |
( |
|
) |
[protected] |
|
Member Function Documentation
virtual const char* vtkTextProperty::GetClassName |
( |
|
) |
[virtual] |
|
static 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. |
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. |
|
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] |
|
virtual double* vtkTextProperty::GetColor |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::GetColor |
( |
double |
data[3] |
) |
[virtual] |
|
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] |
|
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] |
|
void vtkTextProperty::SetFontFamilyToArial |
( |
|
) |
[inline] |
|
void vtkTextProperty::SetFontFamilyToCourier |
( |
|
) |
[inline] |
|
void vtkTextProperty::SetFontFamilyToTimes |
( |
|
) |
[inline] |
|
char * vtkTextProperty::GetFontFamilyAsString |
( |
|
) |
[inline] |
|
virtual void vtkTextProperty::SetFontSize |
( |
int |
|
) |
[virtual] |
|
virtual int vtkTextProperty::GetFontSize |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::SetBold |
( |
int |
|
) |
[virtual] |
|
|
Enable/disable text bolding. |
virtual int vtkTextProperty::GetBold |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::BoldOn |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::BoldOff |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::SetItalic |
( |
int |
|
) |
[virtual] |
|
|
Enable/disable text italic. |
virtual int vtkTextProperty::GetItalic |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::ItalicOn |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::ItalicOff |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::SetShadow |
( |
int |
|
) |
[virtual] |
|
|
Enable/disable text shadows. |
virtual int vtkTextProperty::GetShadow |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::ShadowOn |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::ShadowOff |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::SetAntiAliasing |
( |
int |
|
) |
[virtual] |
|
|
Enable/disable the local aliasing hint. |
virtual int vtkTextProperty::GetAntiAliasing |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::AntiAliasingOn |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::AntiAliasingOff |
( |
|
) |
[virtual] |
|
static int vtkTextProperty::GetGlobalAntiAliasing |
( |
|
) |
[static] |
|
|
Set/Get the global antialiasing hint. Control whether to *globally* force text antialiasing (ALL), disable antialiasing (NONE) or allow antialising depending on the per-object AntiAliasing attribute (SOME). |
static void vtkTextProperty::SetGlobalAntiAliasing |
( |
int |
val |
) |
[static] |
|
static void vtkTextProperty::SetGlobalAntiAliasingToSome |
( |
|
) |
[inline, static] |
|
static void vtkTextProperty::SetGlobalAntiAliasingToNone |
( |
|
) |
[inline, static] |
|
static void vtkTextProperty::SetGlobalAntiAliasingToAll |
( |
|
) |
[inline, static] |
|
virtual void vtkTextProperty::SetJustification |
( |
int |
|
) |
[virtual] |
|
|
Set/Get the horizontal justification to left (default), centered, or right. |
virtual int vtkTextProperty::GetJustification |
( |
|
) |
[virtual] |
|
void vtkTextProperty::SetJustificationToLeft |
( |
|
) |
[inline] |
|
void vtkTextProperty::SetJustificationToCentered |
( |
|
) |
[inline] |
|
void vtkTextProperty::SetJustificationToRight |
( |
|
) |
[inline] |
|
char * vtkTextProperty::GetJustificationAsString |
( |
|
) |
[inline] |
|
virtual void vtkTextProperty::SetVerticalJustification |
( |
int |
|
) |
[virtual] |
|
|
Set/Get the vertical justification to bottom (default), middle, or top. |
virtual int vtkTextProperty::GetVerticalJustification |
( |
|
) |
[virtual] |
|
void vtkTextProperty::SetVerticalJustificationToBottom |
( |
|
) |
[inline] |
|
void vtkTextProperty::SetVerticalJustificationToCentered |
( |
|
) |
[inline] |
|
void vtkTextProperty::SetVerticalJustificationToTop |
( |
|
) |
[inline] |
|
char * vtkTextProperty::GetVerticalJustificationAsString |
( |
|
) |
[inline] |
|
virtual void vtkTextProperty::SetLineOffset |
( |
double |
|
) |
[virtual] |
|
|
These methods can be used to control the spacing and placement of text (in the vertical direction). LineOffset is a vertical offset (measured in pixels); LineSpacing is the spacing between lines, expressed as a text height multiplication factor. |
virtual double vtkTextProperty::GetLineOffset |
( |
|
) |
[virtual] |
|
virtual void vtkTextProperty::SetLineSpacing |
( |
double |
|
) |
[virtual] |
|
virtual double vtkTextProperty::GetLineSpacing |
( |
|
) |
[virtual] |
|
|
Shallow copy of a text property. |
void vtkTextProperty::SetFaceFileName |
( |
const char * |
|
) |
|
|
|
Specify a face file name (unsupported feature). A face filename will override the font family as well as the bold and italic attributes. |
virtual char* vtkTextProperty::GetFaceFileName |
( |
|
) |
[virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file: