TextAttributes

class PMI::TextAttributes

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

Methods

PMI::TextAttributes::TextAttributes()
PMI::TextAttributes::TextAttributes(TextAttributes const &that)
PMI::TextAttributes::~TextAttributes()
void PMI::TextAttributes::Set(TextAttributes const &that)
TextAttributes const &PMI::TextAttributes::operator=(TextAttributes const &that)
void PMI::TextAttributes::GetInsertionPoint(Point &out_point) const

const

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

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

const

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

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.

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.

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

const

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

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

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

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

const

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

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.

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

const

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

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

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

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

const

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

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

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

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

const

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

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

const

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

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

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

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.

bool PMI::TextAttributes::IsBold() const

const

Return the option text bold to screen value.

bool PMI::TextAttributes::IsItalic() const

const

Return the option text italic to screen value.

bool PMI::TextAttributes::IsUnderlined() const

const

Return the option text underlined to screen value.

bool PMI::TextAttributes::IsStrikedThrough() const

const

Return the option text striked out to screen value.

bool PMI::TextAttributes::IsOverlined() const

const

Return the option text overlined to screen value.

bool PMI::TextAttributes::IsStreched() const

const

Return the option text streched to screen value.

bool PMI::TextAttributes::IsWired() const

const

Return true if the original font is a wirefame font.

bool PMI::TextAttributes::IsFixedWidth() const

const

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

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

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

double PMI::TextAttributes::WidthScale() const

const

Return width scale value.

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

Set width scale value.

Variables

PMII::PrivateImpl *PMI::TextAttributes::impl_

private

PMII::PrivateImpl