#include <hps.h>

Inheritance diagram for HPS::TextAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (TextAttributeKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (TextAttributeKit const &in_kit) const
 
TextAttributeKitoperator= (TextAttributeKit &&in_that)
 
TextAttributeKitoperator= (TextAttributeKit const &in_kit)
 
bool operator== (TextAttributeKit const &in_kit) const
 
void Set (TextAttributeKit const &in_kit)
 
TextAttributeKitSetAlignment (Text::Alignment in_align, Text::ReferenceFrame in_ref=Text::ReferenceFrame::WorldAligned, Text::Justification in_justify=Text::Justification::Left)
 
TextAttributeKitSetBackground (bool in_state, char const *in_name)
 
TextAttributeKitSetBackground (char const *in_name)
 
TextAttributeKitSetBackground (bool in_state)
 
TextAttributeKitSetBackgroundMargins (float in_size, Text::MarginUnits in_units=Text::MarginUnits::Percent)
 
TextAttributeKitSetBackgroundMargins (FloatArray const &in_sizes, TextMarginUnitsArray const &in_units)
 
TextAttributeKitSetBackgroundMargins (size_t in_count, float const in_sizes [], HPS::Text::MarginUnits const in_units [])
 
TextAttributeKitSetBackgroundStyle (char const *in_name)
 
TextAttributeKitSetBold (bool in_state)
 
TextAttributeKitSetExtraSpace (bool in_state, float in_size=0.0f, Text::SizeUnits in_units=Text::SizeUnits::ObjectSpace)
 
TextAttributeKitSetExtraSpace (float in_size, Text::SizeUnits in_units)
 
TextAttributeKitSetFont (char const *in_name)
 
TextAttributeKitSetGreeking (bool in_state, float in_size=0.0f, Text::GreekingUnits in_units=Text::GreekingUnits::ObjectSpace, Text::GreekingMode in_mode=Text::GreekingMode::Lines)
 
TextAttributeKitSetGreeking (float in_size, Text::GreekingUnits in_units=Text::GreekingUnits::ObjectSpace, Text::GreekingMode in_mode=Text::GreekingMode::Lines)
 
TextAttributeKitSetItalic (bool in_state)
 
TextAttributeKitSetLineSpacing (float in_multiplier)
 
TextAttributeKitSetOverline (bool in_state)
 
TextAttributeKitSetPath (Vector const &in_path)
 
TextAttributeKitSetPreference (Text::Preference in_pref)
 
TextAttributeKitSetPreference (float in_cutoff, Text::SizeUnits in_units, Text::Preference in_smaller, Text::Preference in_larger)
 
TextAttributeKitSetRenderer (Text::Renderer in_rend)
 
TextAttributeKitSetRotation (Text::Rotation in_state, float in_angle=0.0f)
 
TextAttributeKitSetRotation (float in_angle)
 
TextAttributeKitSetSize (float in_size, Text::SizeUnits in_units)
 
TextAttributeKitSetSizeTolerance (bool in_state, float in_size=50.0f, Text::SizeToleranceUnits in_units=Text::SizeToleranceUnits::Percent)
 
TextAttributeKitSetSizeTolerance (float in_size, Text::SizeToleranceUnits in_units)
 
TextAttributeKitSetSlant (float in_angle)
 
TextAttributeKitSetSpacing (float in_multiplier)
 
TextAttributeKitSetStrikethrough (bool in_state)
 
TextAttributeKitSetTransform (Text::Transform in_trans)
 
TextAttributeKitSetUnderline (bool in_state)
 
void Show (TextAttributeKit &out_kit) const
 
bool ShowAlignment (Text::Alignment &out_align, Text::ReferenceFrame &out_ref, Text::Justification &out_justify) const
 
bool ShowBackground (bool &out_state, UTF8 &out_name) const
 
bool ShowBackgroundMargins (FloatArray &out_size, TextMarginUnitsArray &out_units) const
 
bool ShowBackgroundStyle (UTF8 &out_name) const
 
bool ShowBold (bool &out_state) const
 
bool ShowExtraSpace (bool &out_state, float &out_size, Text::SizeUnits &out_units) const
 
bool ShowFont (UTF8 &out_name) const
 
bool ShowGreeking (bool &out_state, float &out_size, Text::GreekingUnits &out_units, Text::GreekingMode &out_mode) const
 
bool ShowItalic (bool &out_state) const
 
bool ShowLineSpacing (float &out_multiplier) const
 
bool ShowOverline (bool &out_state) const
 
bool ShowPath (Vector &out_path) const
 
bool ShowPreference (float &out_cutoff, Text::SizeUnits &out_units, Text::Preference &out_smaller, Text::Preference &out_larger) const
 
bool ShowRenderer (Text::Renderer &out_rend) const
 
bool ShowRotation (Text::Rotation &out_rot, float &out_angle) const
 
bool ShowSize (float &out_size, Text::SizeUnits &out_units) const
 
bool ShowSizeTolerance (bool &out_state, float &out_size, Text::SizeToleranceUnits &out_units) const
 
bool ShowSlant (float &out_angle) const
 
bool ShowSpacing (float &out_multiplier) const
 
bool ShowStrikethrough (bool &out_state) const
 
bool ShowTransform (Text::Transform &out_trans) const
 
bool ShowUnderline (bool &out_state) const
 
 TextAttributeKit ()
 
 TextAttributeKit (TextAttributeKit const &in_kit)
 
 TextAttributeKit (TextAttributeKit &&in_that)
 
TextAttributeKitUnsetAlignment ()
 
TextAttributeKitUnsetBackground ()
 
TextAttributeKitUnsetBackgroundMargins ()
 
TextAttributeKitUnsetBackgroundStyle ()
 
TextAttributeKitUnsetBold ()
 
TextAttributeKitUnsetEverything ()
 
TextAttributeKitUnsetExtraSpace ()
 
TextAttributeKitUnsetFont ()
 
TextAttributeKitUnsetGreeking ()
 
TextAttributeKitUnsetItalic ()
 
TextAttributeKitUnsetLineSpacing ()
 
TextAttributeKitUnsetOverline ()
 
TextAttributeKitUnsetPath ()
 
TextAttributeKitUnsetPreference ()
 
TextAttributeKitUnsetRenderer ()
 
TextAttributeKitUnsetRotation ()
 
TextAttributeKitUnsetSize ()
 
TextAttributeKitUnsetSizeTolerance ()
 
TextAttributeKitUnsetSlant ()
 
TextAttributeKitUnsetSpacing ()
 
TextAttributeKitUnsetStrikethrough ()
 
TextAttributeKitUnsetTransform ()
 
TextAttributeKitUnsetUnderline ()
 
virtual ~TextAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static TextAttributeKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TextAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The HPS::TextAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::TextAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ TextAttributeKit() [1/3]

HPS::TextAttributeKit::TextAttributeKit ( )

Initializes an empty kit.

◆ TextAttributeKit() [2/3]

HPS::TextAttributeKit::TextAttributeKit ( TextAttributeKit const &  in_kit)

The copy constructor creates a new TextAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

◆ TextAttributeKit() [3/3]

HPS::TextAttributeKit::TextAttributeKit ( TextAttributeKit &&  in_that)

The move constructor creates a TextAttributeKit by transferring the underlying impl of the rvalue reference to this TextAttributeKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a TextAttributeKit to take the impl from.

◆ ~TextAttributeKit()

virtual HPS::TextAttributeKit::~TextAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::TextAttributeKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::TextAttributeKit::Equals ( TextAttributeKit const &  in_kit) const

Check if the source TextAttributeKit is equivalent to this object.

Parameters
in_kitThe source TextAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static TextAttributeKit HPS::TextAttributeKit::GetDefault ( )
static

Creates a TextAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A TextAttributeKit with the default settings.

◆ ObjectType()

HPS::Type HPS::TextAttributeKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Kit.

◆ operator!=()

bool HPS::TextAttributeKit::operator!= ( TextAttributeKit const &  in_kit) const

Check if the source TextAttributeKit is not equivalent to this object.

Parameters
in_kitThe source TextAttributeKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

TextAttributeKit& HPS::TextAttributeKit::operator= ( TextAttributeKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this TextAttributeKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a TextAttributeKit to take the impl from.
Returns
A reference to this TextAttributeKit.

◆ operator=() [2/2]

TextAttributeKit& HPS::TextAttributeKit::operator= ( TextAttributeKit const &  in_kit)

Copies the source TextAttributeKit into this object.

Parameters
in_kitThe source TextAttributeKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::TextAttributeKit::operator== ( TextAttributeKit const &  in_kit) const

Check if the source TextAttributeKit is equivalent to this object.

Parameters
in_kitThe source TextAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::TextAttributeKit::Set ( TextAttributeKit const &  in_kit)

Copies all settings from the source TextAttributeKit into this object.

Parameters
in_kitThe source TextAttributeKit to copy.

◆ SetAlignment()

TextAttributeKit& HPS::TextAttributeKit::SetAlignment ( Text::Alignment  in_align,
Text::ReferenceFrame  in_ref = Text::ReferenceFrame::WorldAligned,
Text::Justification  in_justify = Text::Justification::Left 
)

Sets the alignment for text.

Parameters
in_alignmentThe alignment for text.
in_reference_frameThe reference frame for text.
in_justificationThe justification for text.
Returns
A reference to this object.

◆ SetBackground() [1/3]

TextAttributeKit& HPS::TextAttributeKit::SetBackground ( bool  in_state,
char const *  in_name 
)

Sets the background to be used with text.

Parameters
in_stateWhether a background is drawn for text.
in_nameThe name of a shape definition.
Returns
A reference to this object.

◆ SetBackground() [2/3]

TextAttributeKit& HPS::TextAttributeKit::SetBackground ( char const *  in_name)

Sets the background to be used with text. The state is implicitly on.

Parameters
in_nameThe name of a shape definition.
Returns
A reference to this object.

◆ SetBackground() [3/3]

TextAttributeKit& HPS::TextAttributeKit::SetBackground ( bool  in_state)

Sets the background to be used with text.

Parameters
in_stateWhether a background is drawn for text.
Returns
A reference to this object.

◆ SetBackgroundMargins() [1/3]

TextAttributeKit& HPS::TextAttributeKit::SetBackgroundMargins ( float  in_size,
Text::MarginUnits  in_units = Text::MarginUnits::Percent 
)

Sets the amount of additional padding around text strings when backgrounds are used.

Parameters
in_sizeThe size of the margins.
in_unitsThe units of the size.
Returns
A reference to this object.

◆ SetBackgroundMargins() [2/3]

TextAttributeKit& HPS::TextAttributeKit::SetBackgroundMargins ( FloatArray const &  in_sizes,
TextMarginUnitsArray const &  in_units 
)

Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines.

Parameters
in_sizesThe size of the margins.
in_unitsThe units of the size.
Returns
A reference to this object.

◆ SetBackgroundMargins() [3/3]

TextAttributeKit& HPS::TextAttributeKit::SetBackgroundMargins ( size_t  in_count,
float const  in_sizes[],
HPS::Text::MarginUnits const  in_units[] 
)

Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines.

Parameters
in_countThe number of elements in each array.
in_sizesThe size of the margins.
in_unitsThe units of the size.
Returns
A reference to this object.

◆ SetBackgroundStyle()

TextAttributeKit& HPS::TextAttributeKit::SetBackgroundStyle ( char const *  in_name)

Allows specifying a named style to be used in the drawing of text backgrounds. If no style is specified, backgrounds inherit the face and edge attributes from the containing segment.

Parameters
in_nameThe name of a style, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetBold()

TextAttributeKit& HPS::TextAttributeKit::SetBold ( bool  in_state)

Sets whether text should be bold. For fonts which do not have a bold variant, this setting will be ignored.

Parameters
in_stateWhether text should be bold.
Returns
A reference to this object.

◆ SetExtraSpace() [1/2]

TextAttributeKit& HPS::TextAttributeKit::SetExtraSpace ( bool  in_state,
float  in_size = 0.0f,
Text::SizeUnits  in_units = Text::SizeUnits::ObjectSpace 
)

Sets the amount of additional space to add between characters in a text string.

Parameters
in_stateWhether to add additional space between characters in a text string.
in_sizeThe size of the additional space to add between characters.
in_unitsThe units of the size of the additional space to add between characters.
Returns
A reference to this object.

◆ SetExtraSpace() [2/2]

TextAttributeKit& HPS::TextAttributeKit::SetExtraSpace ( float  in_size,
Text::SizeUnits  in_units 
)

Sets the amount of additional space to add between characters in a text string. This function implicitly enables the addition of extra space.

Parameters
in_sizeThe size of the additional space to add between characters.
in_unitsThe units of the size of the additional space to add between characters.
Returns
A reference to this object.

◆ SetFont()

TextAttributeKit& HPS::TextAttributeKit::SetFont ( char const *  in_name)

Sets the font to use for text. This must either be a builtin font or a font Visualize can locate in the directories specified by World::SetFontDirectories. If the requested font cannot be found, the stroked font will be used.

Parameters
in_nameUTF8-encoded font name to use for text.
Returns
A reference to this TextKey.
See also
World::SetFontDirectories

◆ SetGreeking() [1/2]

TextAttributeKit& HPS::TextAttributeKit::SetGreeking ( bool  in_state,
float  in_size = 0.0f,
Text::GreekingUnits  in_units = Text::GreekingUnits::ObjectSpace,
Text::GreekingMode  in_mode = Text::GreekingMode::Lines 
)

Sets the greeking settings to use for text.

Parameters
in_stateWhether greeking is enabled for text.
in_sizeThe size below which to draw a simple symbol in place of a character.
in_unitsThe units of the size below which to draw a simple glyph in place of a character.
in_modeThe type of symbol to draw for characters which are smaller than the greeking size.
Returns
A reference to this object.

◆ SetGreeking() [2/2]

TextAttributeKit& HPS::TextAttributeKit::SetGreeking ( float  in_size,
Text::GreekingUnits  in_units = Text::GreekingUnits::ObjectSpace,
Text::GreekingMode  in_mode = Text::GreekingMode::Lines 
)

Sets the greeking settings to use for text. This function implicitly enables text greeking.

Parameters
in_sizeThe size below which to draw a simple symbol in place of a character.
in_unitsThe units of the size below which to draw a simple glyph in place of a character.
in_modeThe type of symbol to draw for characters which are smaller than the greeking size.
Returns
A reference to this object.

◆ SetItalic()

TextAttributeKit& HPS::TextAttributeKit::SetItalic ( bool  in_state)

Sets whether text should be italic. For fonts which do not have an italic variant, this setting will be ignored.

Parameters
in_stateWhether text should be italic.
Returns
A reference to this object.

◆ SetLineSpacing()

TextAttributeKit& HPS::TextAttributeKit::SetLineSpacing ( float  in_multiplier)

Sets the line spacing multiplier for text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string.

Parameters
in_multiplierThe line spacing multiplier for text.
Returns
A reference to this object.

◆ SetOverline()

TextAttributeKit& HPS::TextAttributeKit::SetOverline ( bool  in_state)

Sets whether an overline should be drawn over text.

Parameters
in_stateWhether an overline should be drawn over text.
Returns
A reference to this object.

◆ SetPath()

TextAttributeKit& HPS::TextAttributeKit::SetPath ( Vector const &  in_path)

Sets the path for text. This setting controls the vector along which text strings will be displayed.

Parameters
in_pathThe path for text.
Returns
A reference to this object.

◆ SetPreference() [1/2]

TextAttributeKit& HPS::TextAttributeKit::SetPreference ( Text::Preference  in_pref)

Sets the font type preference for text. This function implicitly sets the same font type for all text sizes.

Parameters
in_preferenceThe font type preference for text.
Returns
A reference to this object.

◆ SetPreference() [2/2]

TextAttributeKit& HPS::TextAttributeKit::SetPreference ( float  in_cutoff,
Text::SizeUnits  in_units,
Text::Preference  in_smaller,
Text::Preference  in_larger 
)

Sets the preference for text. This setting controls which font type is used for text for "large" and "small" sizes and the cutoff at which this distinction is made.

Parameters
in_cutoffThe font size below which the smaller preference is used and above which the larger preference is used.
in_unitsThe units for the font size below which the smaller preference is used and above which the larger preference is used.
in_smallerThe font type preference for strings below the cutoff size.
in_largerThe font type preference for strings above the cutoff size.
Returns
A reference to this object.

◆ SetRenderer()

TextAttributeKit& HPS::TextAttributeKit::SetRenderer ( Text::Renderer  in_rend)

Sets the renderer for text.

Parameters
in_rendererThe renderer for text.
Returns
A reference to this object.

◆ SetRotation() [1/2]

TextAttributeKit& HPS::TextAttributeKit::SetRotation ( Text::Rotation  in_state,
float  in_angle = 0.0f 
)

Sets the angle characters should be rotated within text strings. To rotate the text as a block (instead of each individual character) use SetPath with SetRotation(HPS::Text::Rotation::FollowPath), or use a modelling matrix rotation.

Parameters
in_stateWhether and how to rotate the characters within text string.
in_angleThe angle in degrees to rotate each character within text strings. This is only relevant if in_state is Text::Rotation::Rotate.
Returns
A reference to this object.

◆ SetRotation() [2/2]

TextAttributeKit& HPS::TextAttributeKit::SetRotation ( float  in_angle)

Sets the angle characters should be rotated within text strings. To rotate the text as a block (instead of each individual character) use SetPath with SetRotation(HPS::Text::Rotation::FollowPath), or use a modelling matrix rotation. This function implicitly sets a rotation state of Text::Rotation::Rotate.

Parameters
in_angleThe angle in degrees to rotate each character within text strings.
Returns
A reference to this object.

◆ SetSize()

TextAttributeKit& HPS::TextAttributeKit::SetSize ( float  in_size,
Text::SizeUnits  in_units 
)

Sets the font size to use for text.

Parameters
in_sizeThe size for text.
in_unitsThe units of the size for text.
Returns
A reference to this object.

◆ SetSizeTolerance() [1/2]

TextAttributeKit& HPS::TextAttributeKit::SetSizeTolerance ( bool  in_state,
float  in_size = 50.0f,
Text::SizeToleranceUnits  in_units = Text::SizeToleranceUnits::Percent 
)

Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.

Parameters
in_stateWhether a size tolerance is enabled for text.
in_sizeThe size for the tolerance.
in_unitsThe units of the size for the tolerance.
Returns
A reference to this object.

◆ SetSizeTolerance() [2/2]

TextAttributeKit& HPS::TextAttributeKit::SetSizeTolerance ( float  in_size,
Text::SizeToleranceUnits  in_units 
)

Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. This function implicitly enables a size tolerance.

Parameters
in_sizeThe size for the tolerance.
in_unitsThe units of the size for the tolerance.
Returns
A reference to this object.

◆ SetSlant()

TextAttributeKit& HPS::TextAttributeKit::SetSlant ( float  in_angle)

Sets the slant angle for text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular.

Parameters
in_angleThe angle in degrees to slant text. This value must be in the range [-75.0f,+75.0f].
Returns
A reference to this object.

◆ SetSpacing()

TextAttributeKit& HPS::TextAttributeKit::SetSpacing ( float  in_multiplier)

Sets the spacing multiplier for text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on.

Parameters
in_multiplierThe spacing multiplier for text.
Returns
A reference to this object.

◆ SetStrikethrough()

TextAttributeKit& HPS::TextAttributeKit::SetStrikethrough ( bool  in_state)

Sets whether a strikethrough should be drawn through text.

Parameters
in_stateWhether a strikethrough should be drawn through text.
Returns
A reference to this object.

◆ SetTransform()

TextAttributeKit& HPS::TextAttributeKit::SetTransform ( Text::Transform  in_trans)

Sets the transform behavior for text.

Parameters
in_transformThe transform behavior for text.
Returns
A reference to this object.

◆ SetUnderline()

TextAttributeKit& HPS::TextAttributeKit::SetUnderline ( bool  in_state)

Sets whether an underline should be drawn under text.

Parameters
in_stateWhether an underline should be drawn under text.
Returns
A reference to this object.

◆ Show()

void HPS::TextAttributeKit::Show ( TextAttributeKit out_kit) const

Copies all settings from this TextAttributeKit into the given TextAttributeKit.

Parameters
out_kitThe TextAttributeKit to populate with the contents of this object.

◆ ShowAlignment()

bool HPS::TextAttributeKit::ShowAlignment ( Text::Alignment out_align,
Text::ReferenceFrame out_ref,
Text::Justification out_justify 
) const

Shows the alignment for text.

Parameters
out_alignmentThe alignment for text.
out_reference_frameThe reference frame for text.
out_justificationThe justification for text.
Returns
true if an alignment was set, false otherwise.

◆ ShowBackground()

bool HPS::TextAttributeKit::ShowBackground ( bool &  out_state,
UTF8 out_name 
) const

Shows the background to be used with text.

Parameters
out_stateWhether a background is drawn for text.
out_nameThe name of a shape definition.
Returns
true if a spacing multiplier was set, false otherwise.

◆ ShowBackgroundMargins()

bool HPS::TextAttributeKit::ShowBackgroundMargins ( FloatArray out_size,
TextMarginUnitsArray out_units 
) const

Shows the amount of additional padding around text strings when backgrounds are used.

Parameters
out_sizeThe size of the margins.
out_unitsThe units of the sizes.
Returns
true if a spacing multiplier was set, false otherwise.

◆ ShowBackgroundStyle()

bool HPS::TextAttributeKit::ShowBackgroundStyle ( UTF8 out_name) const

Shows the named style to be used in the drawing of text backgrounds.

Parameters
out_nameThe name of a style, defined in a portfolio that is accessible.
Returns
true if a spacing multiplier was set, false otherwise.

◆ ShowBold()

bool HPS::TextAttributeKit::ShowBold ( bool &  out_state) const

Shows whether text should be bold.

Parameters
out_stateWhether text should be bold.
Returns
true if a bold setting was set, false otherwise.

◆ ShowExtraSpace()

bool HPS::TextAttributeKit::ShowExtraSpace ( bool &  out_state,
float &  out_size,
Text::SizeUnits out_units 
) const

Shows the amount of additional space to add between characters in a text string.

Parameters
out_stateWhether to add additional space between characters in a text string.
out_sizeThe size of the additional space to add between characters.
out_unitsThe units of the size of the additional space to add between characters.
Returns
true if an extra space setting was set, false otherwise.

◆ ShowFont()

bool HPS::TextAttributeKit::ShowFont ( UTF8 out_name) const

Shows the font to use for text.

Parameters
out_nameUTF8-encoded font name to use for text.
Returns
true if a font was set, false otherwise.

◆ ShowGreeking()

bool HPS::TextAttributeKit::ShowGreeking ( bool &  out_state,
float &  out_size,
Text::GreekingUnits out_units,
Text::GreekingMode out_mode 
) const

Shows the greeking settings to use for text.

Parameters
out_stateWhether greeking is enabled for text.
out_sizeThe size below which to draw a simple symbol in place of a character.
out_unitsThe units of the size below which to draw a simple glyph in place of a character.
out_modeThe type of symbol to draw for characters which are smaller than the greeking size.
Returns
true if greeking settings were set, false otherwise.

◆ ShowItalic()

bool HPS::TextAttributeKit::ShowItalic ( bool &  out_state) const

Shows whether text should be italic.

Parameters
out_stateWhether text should be italic.
Returns
true if an italic setting was set, false otherwise.

◆ ShowLineSpacing()

bool HPS::TextAttributeKit::ShowLineSpacing ( float &  out_multiplier) const

Shows the line spacing multiplier for text.

Parameters
out_multiplierThe line spacing multiplier for text.
Returns
true if a line space multiplier was set, false otherwise.

◆ ShowOverline()

bool HPS::TextAttributeKit::ShowOverline ( bool &  out_state) const

Shows whether an overline should be drawn over text.

Parameters
out_stateWhether an overline should be drawn over text.
Returns
true if an overline setting was set, false otherwise.

◆ ShowPath()

bool HPS::TextAttributeKit::ShowPath ( Vector out_path) const

Shows the path for text.

Parameters
out_pathThe path for text.
Returns
true if a path was set, false otherwise.

◆ ShowPreference()

bool HPS::TextAttributeKit::ShowPreference ( float &  out_cutoff,
Text::SizeUnits out_units,
Text::Preference out_smaller,
Text::Preference out_larger 
) const

Shows the preference for text.

Parameters
out_cutoffThe font size below which the smaller preference is used and above which the larger preference is used.
out_unitsThe units for the font size below which the smaller preference is used and above which the larger preference is used.
out_smallerThe font type preference for strings below the cutoff size.
out_largerThe font type preference for strings above the cutoff size.
Returns
true if a preference was set, false otherwise.

◆ ShowRenderer()

bool HPS::TextAttributeKit::ShowRenderer ( Text::Renderer out_rend) const

Shows the renderer for text.

Parameters
in_rendererThe renderer for text.
Returns
true if a renderer was set, false otherwise.

◆ ShowRotation()

bool HPS::TextAttributeKit::ShowRotation ( Text::Rotation out_rot,
float &  out_angle 
) const

Shows the angle characters should be rotated within text strings.

Parameters
out_rotWhether to rotate the characters within text strings, and if so, what the angle should be measured with repect to.
out_angleThe angle in degrees to rotate each character within text strings.
Returns
true if a rotation setting was set, false otherwise.

◆ ShowSize()

bool HPS::TextAttributeKit::ShowSize ( float &  out_size,
Text::SizeUnits out_units 
) const

Shows the font size to use for text.

Parameters
out_sizeThe size for text.
out_unitsThe units of the size for text.
Returns
true if a size was set, false otherwise.

◆ ShowSizeTolerance()

bool HPS::TextAttributeKit::ShowSizeTolerance ( bool &  out_state,
float &  out_size,
Text::SizeToleranceUnits out_units 
) const

Shows the size tolerance settings to use for text.

Parameters
out_stateWhether a size tolerance is enabled for text.
out_sizeThe size for the tolerance.
out_unitsThe units of the size for the tolerance.
Returns
true if a size tolerance was set, false otherwise.

◆ ShowSlant()

bool HPS::TextAttributeKit::ShowSlant ( float &  out_angle) const

Shows the slant angle for text.

Parameters
out_angleThe angle in degrees to slant text.
Returns
true if a slang angle was set, false otherwise.

◆ ShowSpacing()

bool HPS::TextAttributeKit::ShowSpacing ( float &  out_multiplier) const

Shows the spacing multiplier for text.

Parameters
out_multiplierThe spacing multiplier for text.
Returns
true if a spacing multiplier was set, false otherwise.

◆ ShowStrikethrough()

bool HPS::TextAttributeKit::ShowStrikethrough ( bool &  out_state) const

Shows whether a strikethrough should be drawn through text.

Parameters
out_stateWhether a strikethrough should be drawn through text.
Returns
true if a strikethrough setting was set, false otherwise.

◆ ShowTransform()

bool HPS::TextAttributeKit::ShowTransform ( Text::Transform out_trans) const

Shows the transform state for text.

Parameters
out_transformThe transform state for text.
Returns
true if a transform state was set, false otherwise.

◆ ShowUnderline()

bool HPS::TextAttributeKit::ShowUnderline ( bool &  out_state) const

Shows whether an underline should be drawn under text.

Parameters
out_stateWhether an underline should be drawn under text.
Returns
true if an underline setting was set, false otherwise.

◆ UnsetAlignment()

TextAttributeKit& HPS::TextAttributeKit::UnsetAlignment ( )

Removes the alignment setting.

Returns
A reference to this object.

◆ UnsetBackground()

TextAttributeKit& HPS::TextAttributeKit::UnsetBackground ( )

Removes the background setting.

Returns
A reference to this object.

◆ UnsetBackgroundMargins()

TextAttributeKit& HPS::TextAttributeKit::UnsetBackgroundMargins ( )

Removes the background margin setting.

Returns
A reference to this object.

◆ UnsetBackgroundStyle()

TextAttributeKit& HPS::TextAttributeKit::UnsetBackgroundStyle ( )

Removes the background style setting.

Returns
A reference to this object.

◆ UnsetBold()

TextAttributeKit& HPS::TextAttributeKit::UnsetBold ( )

Removes the bold setting.

Returns
A reference to this object.

◆ UnsetEverything()

TextAttributeKit& HPS::TextAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetExtraSpace()

TextAttributeKit& HPS::TextAttributeKit::UnsetExtraSpace ( )

Removes the extra space setting.

Returns
A reference to this object.

◆ UnsetFont()

TextAttributeKit& HPS::TextAttributeKit::UnsetFont ( )

Removes the font setting.

Returns
A reference to this object.

◆ UnsetGreeking()

TextAttributeKit& HPS::TextAttributeKit::UnsetGreeking ( )

Removes the greeking setting.

Returns
A reference to this object.

◆ UnsetItalic()

TextAttributeKit& HPS::TextAttributeKit::UnsetItalic ( )

Removes the italic setting.

Returns
A reference to this object.

◆ UnsetLineSpacing()

TextAttributeKit& HPS::TextAttributeKit::UnsetLineSpacing ( )

Removes the line spacing setting.

Returns
A reference to this object.

◆ UnsetOverline()

TextAttributeKit& HPS::TextAttributeKit::UnsetOverline ( )

Removes the overline setting.

Returns
A reference to this object.

◆ UnsetPath()

TextAttributeKit& HPS::TextAttributeKit::UnsetPath ( )

Removes the path setting.

Returns
A reference to this object.

◆ UnsetPreference()

TextAttributeKit& HPS::TextAttributeKit::UnsetPreference ( )

Removes the preference setting.

Returns
A reference to this object.

◆ UnsetRenderer()

TextAttributeKit& HPS::TextAttributeKit::UnsetRenderer ( )

Removes the renderer setting.

Returns
A reference to this object.

◆ UnsetRotation()

TextAttributeKit& HPS::TextAttributeKit::UnsetRotation ( )

Removes the rotation setting.

Returns
A reference to this object.

◆ UnsetSize()

TextAttributeKit& HPS::TextAttributeKit::UnsetSize ( )

Removes the size setting.

Returns
A reference to this object.

◆ UnsetSizeTolerance()

TextAttributeKit& HPS::TextAttributeKit::UnsetSizeTolerance ( )

Removes the size tolerance setting.

Returns
A reference to this object.

◆ UnsetSlant()

TextAttributeKit& HPS::TextAttributeKit::UnsetSlant ( )

Removes the slant setting.

Returns
A reference to this object.

◆ UnsetSpacing()

TextAttributeKit& HPS::TextAttributeKit::UnsetSpacing ( )

Removes the spacing setting.

Returns
A reference to this object.

◆ UnsetStrikethrough()

TextAttributeKit& HPS::TextAttributeKit::UnsetStrikethrough ( )

Removes the strikethrough setting.

Returns
A reference to this object.

◆ UnsetTransform()

TextAttributeKit& HPS::TextAttributeKit::UnsetTransform ( )

Removes the transform setting.

Returns
A reference to this object.

◆ UnsetUnderline()

TextAttributeKit& HPS::TextAttributeKit::UnsetUnderline ( )

Removes the underline setting.

Returns
A reference to this object.

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