VTK  9.0.20210622
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTextProperty Class Reference

represent text properties. More...

#include <vtkTextProperty.h>

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

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. More...
 
vtkTextPropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetShadowColor (double color[3])
 Get the shadow color. More...
 
void ShallowCopy (vtkTextProperty *tprop)
 Shallow copy of a text property. More...
 
virtual void SetColor (double, double, double)
 Set the color of the text. More...
 
virtual void SetColor (double[3])
 Set the color of the text. More...
 
virtual double * GetColor ()
 Set the color of the text. More...
 
virtual void GetColor (double &, double &, double &)
 Set the color of the text. More...
 
virtual void GetColor (double[3])
 Set the color of the text. More...
 
virtual void SetOpacity (double)
 Set/Get the text's opacity. More...
 
virtual double GetOpacity ()
 Set/Get the text's opacity. More...
 
virtual void SetBackgroundColor (double, double, double)
 The background color. More...
 
virtual void SetBackgroundColor (double[3])
 The background color. More...
 
virtual double * GetBackgroundColor ()
 The background color. More...
 
virtual void GetBackgroundColor (double &, double &, double &)
 The background color. More...
 
virtual void GetBackgroundColor (double[3])
 The background color. More...
 
virtual void SetBackgroundOpacity (double)
 The background opacity. More...
 
virtual double GetBackgroundOpacity ()
 The background opacity. More...
 
void SetBackgroundRGBA (double rgba[4])
 Convenience method to set the background color and the opacity at once. More...
 
void SetBackgroundRGBA (double r, double g, double b, double a)
 Convenience method to set the background color and the opacity at once. More...
 
void GetBackgroundRGBA (double rgba[4])
 Convenience method to get the background color and the opacity at once. More...
 
void GetBackgroundRGBA (double &r, double &g, double &b, double &a)
 Convenience method to set the background color and the opacity at once. More...
 
virtual void SetFrameColor (double, double, double)
 The frame color. More...
 
virtual void SetFrameColor (double[3])
 The frame color. More...
 
virtual double * GetFrameColor ()
 The frame color. More...
 
virtual void GetFrameColor (double &, double &, double &)
 The frame color. More...
 
virtual void GetFrameColor (double[3])
 The frame color. More...
 
virtual void SetFrame (vtkTypeBool)
 Enable/disable text frame. More...
 
virtual vtkTypeBool GetFrame ()
 Enable/disable text frame. More...
 
virtual void FrameOn ()
 Enable/disable text frame. More...
 
virtual void FrameOff ()
 Enable/disable text frame. More...
 
virtual void SetFrameWidth (int)
 Set/Get the width of the frame. More...
 
virtual int GetFrameWidth ()
 Set/Get the width of the frame. More...
 
virtual char * GetFontFile ()
 The absolute filepath to a local file containing a freetype-readable font if GetFontFamily() return VTK_FONT_FILE. More...
 
virtual void SetFontFile (const char *)
 The absolute filepath to a local file containing a freetype-readable font if GetFontFamily() return VTK_FONT_FILE. More...
 
virtual void SetFontSize (int)
 Set/Get the font size (in points). More...
 
virtual int GetFontSize ()
 Set/Get the font size (in points). More...
 
virtual void SetBold (vtkTypeBool)
 Enable/disable text bolding. More...
 
virtual vtkTypeBool GetBold ()
 Enable/disable text bolding. More...
 
virtual void BoldOn ()
 Enable/disable text bolding. More...
 
virtual void BoldOff ()
 Enable/disable text bolding. More...
 
virtual void SetItalic (vtkTypeBool)
 Enable/disable text italic. More...
 
virtual vtkTypeBool GetItalic ()
 Enable/disable text italic. More...
 
virtual void ItalicOn ()
 Enable/disable text italic. More...
 
virtual void ItalicOff ()
 Enable/disable text italic. More...
 
virtual void SetShadow (vtkTypeBool)
 Enable/disable text shadow. More...
 
virtual vtkTypeBool GetShadow ()
 Enable/disable text shadow. More...
 
virtual void ShadowOn ()
 Enable/disable text shadow. More...
 
virtual void ShadowOff ()
 Enable/disable text shadow. More...
 
virtual void SetShadowOffset (int, int)
 Set/Get the shadow offset, i.e. More...
 
void SetShadowOffset (int[2])
 Set/Get the shadow offset, i.e. More...
 
virtual int * GetShadowOffset ()
 Set/Get the shadow offset, i.e. More...
 
virtual void GetShadowOffset (int data[2])
 Set/Get the shadow offset, i.e. More...
 
virtual void SetJustification (int)
 Set/Get the horizontal justification to left (default), centered, or right. More...
 
virtual int GetJustification ()
 Set/Get the horizontal justification to left (default), centered, or right. More...
 
void SetJustificationToLeft ()
 Set/Get the horizontal justification to left (default), centered, or right. More...
 
void SetJustificationToCentered ()
 Set/Get the horizontal justification to left (default), centered, or right. More...
 
void SetJustificationToRight ()
 Set/Get the horizontal justification to left (default), centered, or right. More...
 
const char * GetJustificationAsString ()
 Set/Get the horizontal justification to left (default), centered, or right. More...
 
virtual void SetVerticalJustification (int)
 Set/Get the vertical justification to bottom (default), middle, or top. More...
 
virtual int GetVerticalJustification ()
 Set/Get the vertical justification to bottom (default), middle, or top. More...
 
void SetVerticalJustificationToBottom ()
 Set/Get the vertical justification to bottom (default), middle, or top. More...
 
void SetVerticalJustificationToCentered ()
 Set/Get the vertical justification to bottom (default), middle, or top. More...
 
void SetVerticalJustificationToTop ()
 Set/Get the vertical justification to bottom (default), middle, or top. More...
 
const char * GetVerticalJustificationAsString ()
 Set/Get the vertical justification to bottom (default), middle, or top. More...
 
virtual void SetUseTightBoundingBox (vtkTypeBool)
 If this property is on, text is aligned to drawn pixels not to font metrix. More...
 
virtual vtkTypeBool GetUseTightBoundingBox ()
 If this property is on, text is aligned to drawn pixels not to font metrix. More...
 
virtual void UseTightBoundingBoxOn ()
 If this property is on, text is aligned to drawn pixels not to font metrix. More...
 
virtual void UseTightBoundingBoxOff ()
 If this property is on, text is aligned to drawn pixels not to font metrix. More...
 
virtual void SetOrientation (double)
 Set/Get the text's orientation (in degrees). More...
 
virtual double GetOrientation ()
 Set/Get the text's orientation (in degrees). More...
 
virtual void SetLineSpacing (double)
 Set/Get the (extra) spacing between lines, expressed as a text height multiplication factor. More...
 
virtual double GetLineSpacing ()
 Set/Get the (extra) spacing between lines, expressed as a text height multiplication factor. More...
 
virtual void SetLineOffset (double)
 Set/Get the vertical offset (measured in pixels). More...
 
virtual double GetLineOffset ()
 Set/Get the vertical offset (measured in pixels). More...
 
virtual void SetCellOffset (double)
 Set/Get the horizontal offset between cells. More...
 
virtual double GetCellOffset ()
 Set/Get the horizontal offset between cells. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTextPropertySafeDownCast (vtkObjectBase *o)
 
static vtkTextPropertyNew ()
 Creates a new text property with font size 12, bold off, italic off, and Arial font. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
static int GetFontFamilyFromString (const char *f)
 Set/Get the font family. More...
 
static const char * GetFontFamilyAsString (int f)
 Set/Get the font family. More...
 
virtual char * GetFontFamilyAsString ()
 Set/Get the font family. More...
 
virtual void SetFontFamilyAsString (const char *)
 Set/Get the font family. More...
 
void SetFontFamily (int t)
 Set/Get the font family. More...
 
int GetFontFamily ()
 Set/Get the font family. More...
 
int GetFontFamilyMinValue ()
 Set/Get the font family. More...
 
void SetFontFamilyToArial ()
 Set/Get the font family. More...
 
void SetFontFamilyToCourier ()
 Set/Get the font family. More...
 
void SetFontFamilyToTimes ()
 Set/Get the font family. More...
 

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

Definition at line 33 of file vtkTextProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 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.

◆ GetFontFamilyAsString() [1/2]

virtual char* vtkTextProperty::GetFontFamilyAsString ( )
virtual

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

◆ SetFontFamilyAsString()

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

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

◆ SetFontFamily()

void vtkTextProperty::SetFontFamily ( int  t)
inline

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 326 of file vtkTextProperty.h.

◆ GetFontFamily()

int vtkTextProperty::GetFontFamily ( )
inline

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 367 of file vtkTextProperty.h.

◆ GetFontFamilyMinValue()

int vtkTextProperty::GetFontFamilyMinValue ( )
inline

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 130 of file vtkTextProperty.h.

◆ SetFontFamilyToArial()

void vtkTextProperty::SetFontFamilyToArial ( )
inline

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 331 of file vtkTextProperty.h.

◆ SetFontFamilyToCourier()

void vtkTextProperty::SetFontFamilyToCourier ( )
inline

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 336 of file vtkTextProperty.h.

◆ SetFontFamilyToTimes()

void vtkTextProperty::SetFontFamilyToTimes ( )
inline

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 341 of file vtkTextProperty.h.

◆ GetFontFamilyFromString()

int vtkTextProperty::GetFontFamilyFromString ( const char *  f)
inlinestatic

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 346 of file vtkTextProperty.h.

◆ GetFontFamilyAsString() [2/2]

const char * vtkTextProperty::GetFontFamilyAsString ( int  f)
inlinestatic

Set/Get the font family.

Supports legacy three font family system. If the symbolic constant VTK_FONT_FILE is returned by GetFontFamily(), the string returned by GetFontFile() must be an absolute filepath to a local FreeType compatible font.

Definition at line 305 of file vtkTextProperty.h.

◆ GetFontFile()

virtual char* vtkTextProperty::GetFontFile ( )
virtual

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

The result is undefined for other values of GetFontFamily().

◆ SetFontFile()

virtual void vtkTextProperty::SetFontFile ( const char *  )
virtual

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

The result is undefined for other values of GetFontFamily().

◆ SetFontSize()

virtual void vtkTextProperty::SetFontSize ( int  )
virtual

Set/Get the font size (in points).

◆ GetFontSize()

virtual int vtkTextProperty::GetFontSize ( )
virtual

Set/Get the font size (in points).

◆ SetBold()

virtual void vtkTextProperty::SetBold ( vtkTypeBool  )
virtual

Enable/disable text bolding.

◆ GetBold()

virtual vtkTypeBool vtkTextProperty::GetBold ( )
virtual

Enable/disable text bolding.

◆ BoldOn()

virtual void vtkTextProperty::BoldOn ( )
virtual

Enable/disable text bolding.

◆ BoldOff()

virtual void vtkTextProperty::BoldOff ( )
virtual

Enable/disable text bolding.

◆ SetItalic()

virtual void vtkTextProperty::SetItalic ( vtkTypeBool  )
virtual

Enable/disable text italic.

◆ GetItalic()

virtual vtkTypeBool vtkTextProperty::GetItalic ( )
virtual

Enable/disable text italic.

◆ ItalicOn()

virtual void vtkTextProperty::ItalicOn ( )
virtual

Enable/disable text italic.

◆ ItalicOff()

virtual void vtkTextProperty::ItalicOff ( )
virtual

Enable/disable text italic.

◆ SetShadow()

virtual void vtkTextProperty::SetShadow ( vtkTypeBool  )
virtual

Enable/disable text shadow.

◆ GetShadow()

virtual vtkTypeBool vtkTextProperty::GetShadow ( )
virtual

Enable/disable text shadow.

◆ ShadowOn()

virtual void vtkTextProperty::ShadowOn ( )
virtual

Enable/disable text shadow.

◆ ShadowOff()

virtual void vtkTextProperty::ShadowOff ( )
virtual

Enable/disable text shadow.

◆ SetShadowOffset() [1/2]

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.

◆ SetShadowOffset() [2/2]

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.

◆ GetShadowOffset() [1/2]

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.

◆ GetShadowOffset() [2/2]

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.

◆ GetShadowColor()

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

Get the shadow color.

It is computed from the Color ivar

◆ SetJustification()

virtual void vtkTextProperty::SetJustification ( int  )
virtual

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

◆ GetJustification()

virtual int vtkTextProperty::GetJustification ( )
virtual

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

◆ SetJustificationToLeft()

void vtkTextProperty::SetJustificationToLeft ( )
inline

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

Definition at line 204 of file vtkTextProperty.h.

◆ SetJustificationToCentered()

void vtkTextProperty::SetJustificationToCentered ( )
inline

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

Definition at line 205 of file vtkTextProperty.h.

◆ SetJustificationToRight()

void vtkTextProperty::SetJustificationToRight ( )
inline

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

Definition at line 206 of file vtkTextProperty.h.

◆ GetJustificationAsString()

const char * vtkTextProperty::GetJustificationAsString ( void  )
inline

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

Definition at line 372 of file vtkTextProperty.h.

◆ SetVerticalJustification()

virtual void vtkTextProperty::SetVerticalJustification ( int  )
virtual

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

◆ GetVerticalJustification()

virtual int vtkTextProperty::GetVerticalJustification ( )
virtual

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

◆ SetVerticalJustificationToBottom()

void vtkTextProperty::SetVerticalJustificationToBottom ( )
inline

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

Definition at line 217 of file vtkTextProperty.h.

◆ SetVerticalJustificationToCentered()

void vtkTextProperty::SetVerticalJustificationToCentered ( )
inline

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

Definition at line 218 of file vtkTextProperty.h.

◆ SetVerticalJustificationToTop()

void vtkTextProperty::SetVerticalJustificationToTop ( )
inline

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

Definition at line 219 of file vtkTextProperty.h.

◆ GetVerticalJustificationAsString()

const char * vtkTextProperty::GetVerticalJustificationAsString ( void  )
inline

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

Definition at line 389 of file vtkTextProperty.h.

◆ SetUseTightBoundingBox()

virtual void vtkTextProperty::SetUseTightBoundingBox ( vtkTypeBool  )
virtual

If this property is on, text is aligned to drawn pixels not to font metrix.

If the text does not include descents, the bounding box will not extend below the baseline. This option can be used to get centered labels. It does not work well if the string changes as the string position will move around.

◆ GetUseTightBoundingBox()

virtual vtkTypeBool vtkTextProperty::GetUseTightBoundingBox ( )
virtual

If this property is on, text is aligned to drawn pixels not to font metrix.

If the text does not include descents, the bounding box will not extend below the baseline. This option can be used to get centered labels. It does not work well if the string changes as the string position will move around.

◆ UseTightBoundingBoxOn()

virtual void vtkTextProperty::UseTightBoundingBoxOn ( )
virtual

If this property is on, text is aligned to drawn pixels not to font metrix.

If the text does not include descents, the bounding box will not extend below the baseline. This option can be used to get centered labels. It does not work well if the string changes as the string position will move around.

◆ UseTightBoundingBoxOff()

virtual void vtkTextProperty::UseTightBoundingBoxOff ( )
virtual

If this property is on, text is aligned to drawn pixels not to font metrix.

If the text does not include descents, the bounding box will not extend below the baseline. This option can be used to get centered labels. It does not work well if the string changes as the string position will move around.

◆ SetOrientation()

virtual void vtkTextProperty::SetOrientation ( double  )
virtual

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

◆ GetOrientation()

virtual double vtkTextProperty::GetOrientation ( )
virtual

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

◆ SetLineSpacing()

virtual void vtkTextProperty::SetLineSpacing ( double  )
virtual

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

◆ GetLineSpacing()

virtual double vtkTextProperty::GetLineSpacing ( )
virtual

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

◆ SetLineOffset()

virtual void vtkTextProperty::SetLineOffset ( double  )
virtual

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

◆ GetLineOffset()

virtual double vtkTextProperty::GetLineOffset ( )
virtual

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

◆ SetCellOffset()

virtual void vtkTextProperty::SetCellOffset ( double  )
virtual

Set/Get the horizontal offset between cells.

Only used by MatplotlibMathTextUtilities

◆ GetCellOffset()

virtual double vtkTextProperty::GetCellOffset ( )
virtual

Set/Get the horizontal offset between cells.

Only used by MatplotlibMathTextUtilities

◆ ShallowCopy()

void vtkTextProperty::ShallowCopy ( vtkTextProperty tprop)

Shallow copy of a text property.

Member Data Documentation

◆ Color

double vtkTextProperty::Color[3]
protected

Definition at line 278 of file vtkTextProperty.h.

◆ Opacity

double vtkTextProperty::Opacity
protected

Definition at line 279 of file vtkTextProperty.h.

◆ BackgroundColor

double vtkTextProperty::BackgroundColor[3]
protected

Definition at line 280 of file vtkTextProperty.h.

◆ BackgroundOpacity

double vtkTextProperty::BackgroundOpacity
protected

Definition at line 281 of file vtkTextProperty.h.

◆ Frame

vtkTypeBool vtkTextProperty::Frame
protected

Definition at line 282 of file vtkTextProperty.h.

◆ FrameColor

double vtkTextProperty::FrameColor[3]
protected

Definition at line 283 of file vtkTextProperty.h.

◆ FrameWidth

int vtkTextProperty::FrameWidth
protected

Definition at line 284 of file vtkTextProperty.h.

◆ FontFamilyAsString

char* vtkTextProperty::FontFamilyAsString
protected

Definition at line 285 of file vtkTextProperty.h.

◆ FontFile

char* vtkTextProperty::FontFile
protected

Definition at line 286 of file vtkTextProperty.h.

◆ FontSize

int vtkTextProperty::FontSize
protected

Definition at line 287 of file vtkTextProperty.h.

◆ Bold

vtkTypeBool vtkTextProperty::Bold
protected

Definition at line 288 of file vtkTextProperty.h.

◆ Italic

vtkTypeBool vtkTextProperty::Italic
protected

Definition at line 289 of file vtkTextProperty.h.

◆ Shadow

vtkTypeBool vtkTextProperty::Shadow
protected

Definition at line 290 of file vtkTextProperty.h.

◆ ShadowOffset

int vtkTextProperty::ShadowOffset[2]
protected

Definition at line 291 of file vtkTextProperty.h.

◆ Justification

int vtkTextProperty::Justification
protected

Definition at line 292 of file vtkTextProperty.h.

◆ VerticalJustification

int vtkTextProperty::VerticalJustification
protected

Definition at line 293 of file vtkTextProperty.h.

◆ UseTightBoundingBox

vtkTypeBool vtkTextProperty::UseTightBoundingBox
protected

Definition at line 294 of file vtkTextProperty.h.

◆ Orientation

double vtkTextProperty::Orientation
protected

Definition at line 295 of file vtkTextProperty.h.

◆ LineOffset

double vtkTextProperty::LineOffset
protected

Definition at line 296 of file vtkTextProperty.h.

◆ LineSpacing

double vtkTextProperty::LineSpacing
protected

Definition at line 297 of file vtkTextProperty.h.

◆ CellOffset

double vtkTextProperty::CellOffset
protected

Definition at line 298 of file vtkTextProperty.h.


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