PMI::TextAttributes Class Reference

#include <HUtilityPMI.h>

Public Member Functions

void GetFontName (char *out_font_name) const
 
void GetFontSize (float &out_size) const
 
void GetFontSizeUnits (Font::Size::Units &out_units) const
 
void GetInsertionPoint (Point &out_point) const
 
void GetInsertionPoint (float &out_x, float &out_y, float &out_z) const
 
void GetOrientation (Orientation &out_orientation) const
 
void GetRGBColor (RGBColor &out_color) const
 
void GetRGBColor (float &out_r, float &out_g, float &out_b) const
 
bool IsBold () const
 
bool IsFixedWidth () const
 
bool IsItalic () const
 
bool IsOverlined () const
 
bool IsStreched () const
 
bool IsStrikedThrough () const
 
bool IsUnderlined () const
 
bool IsWired () const
 
TextAttributes const & operator= (TextAttributes const &that)
 
void Set (TextAttributes const &that)
 
void SetFontName (char const *in_font_name)
 
void SetFontSize (float const in_size)
 
void SetFontSizeUnits (Font::Size::Units const in_units)
 
void SetFormat (char const &in_format)
 
void SetInsertionPoint (Point const &in_point)
 
void SetInsertionPoint (float in_x, float in_y, float in_z)
 
void SetOrientation (Orientation const &in_orientation)
 
void SetRGBColor (RGBColor const &in_color)
 
void SetRGBColor (float in_r, float in_g, float in_b)
 
void SetWidthScale (const double width_scale)
 
 TextAttributes (TextAttributes const &that)
 
double WidthScale () const
 

Detailed Description

This class represents all the information related to displaying a piece of text associated with an Entity.

Member Function Documentation

◆ GetFontName()

void PMI::TextAttributes::GetFontName ( char *  out_font_name) const

Gets the font name for the text. Returned to the user.

◆ GetFontSize()

void PMI::TextAttributes::GetFontSize ( float &  out_size) const

Gets the font size for the text. Returned to the user.

◆ GetFontSizeUnits()

void PMI::TextAttributes::GetFontSizeUnits ( Font::Size::Units &  out_units) const

Gets the font size units for the text. Returned to the user.

◆ GetInsertionPoint() [1/2]

void PMI::TextAttributes::GetInsertionPoint ( Point out_point) const

Gets the lower left corner insertion point for the text. Returned to the user.

◆ GetInsertionPoint() [2/2]

void PMI::TextAttributes::GetInsertionPoint ( float &  out_x,
float &  out_y,
float &  out_z 
) const

Gets the lower left corner insertion point for the text. Returned to the user.

◆ GetOrientation()

void PMI::TextAttributes::GetOrientation ( Orientation out_orientation) const

Gets the Orientation for the text. Returned to the user.

◆ GetRGBColor() [1/2]

void PMI::TextAttributes::GetRGBColor ( RGBColor out_color) const

Gets the color information for the text. Returned to the user.

◆ GetRGBColor() [2/2]

void PMI::TextAttributes::GetRGBColor ( float &  out_r,
float &  out_g,
float &  out_b 
) const

Gets the color information for the text. Returned to the user.

◆ IsBold()

bool PMI::TextAttributes::IsBold ( ) const

Return the option text bold to screen value.

◆ IsFixedWidth()

bool PMI::TextAttributes::IsFixedWidth ( ) const

Return true if the original font is not proportional (each glyph has the same width).

◆ IsItalic()

bool PMI::TextAttributes::IsItalic ( ) const

Return the option text italic to screen value.

◆ IsOverlined()

bool PMI::TextAttributes::IsOverlined ( ) const

Return the option text overlined to screen value.

◆ IsStreched()

bool PMI::TextAttributes::IsStreched ( ) const

Return the option text streched to screen value.

◆ IsStrikedThrough()

bool PMI::TextAttributes::IsStrikedThrough ( ) const

Return the option text striked out to screen value.

◆ IsUnderlined()

bool PMI::TextAttributes::IsUnderlined ( ) const

Return the option text underlined to screen value.

◆ IsWired()

bool PMI::TextAttributes::IsWired ( ) const

Return true if the original font is a wirefame font.

◆ SetFontName()

void PMI::TextAttributes::SetFontName ( char const *  in_font_name)

Sets the font name for the text. This will replace an existing font name.

◆ SetFontSize()

void PMI::TextAttributes::SetFontSize ( float const  in_size)

Sets the font size of the text. This will replace an existing font size.

◆ SetFontSizeUnits()

void PMI::TextAttributes::SetFontSizeUnits ( Font::Size::Units const  in_units)

Sets the font size units for the text. This will replace the existing font size units.

◆ SetFormat()

void PMI::TextAttributes::SetFormat ( char const &  in_format)

Sets format for the text. This will replace an existing format.

◆ SetInsertionPoint() [1/2]

void PMI::TextAttributes::SetInsertionPoint ( Point const &  in_point)

Sets the lower left corner insertion point for the text. This will replace an existing insertion point.

◆ SetInsertionPoint() [2/2]

void PMI::TextAttributes::SetInsertionPoint ( float  in_x,
float  in_y,
float  in_z 
)

Sets the lower left corner insertion point for the text. This will replace an existing insertion point.

◆ SetOrientation()

void PMI::TextAttributes::SetOrientation ( Orientation const &  in_orientation)

Sets the Orientation for the text. This will replace an existing Orientation.

◆ SetRGBColor() [1/2]

void PMI::TextAttributes::SetRGBColor ( RGBColor const &  in_color)

Sets the color information for the text. This will replace an existing color.

◆ SetRGBColor() [2/2]

void PMI::TextAttributes::SetRGBColor ( float  in_r,
float  in_g,
float  in_b 
)

Sets the color information for the text. This will replace an existing color.

◆ SetWidthScale()

void PMI::TextAttributes::SetWidthScale ( const double  width_scale)

Set width scale value.

◆ WidthScale()

double PMI::TextAttributes::WidthScale ( ) const

Return width scale value.


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