#include <hps.h>

Inheritance diagram for HPS::TextKey:
HPS::GeometryKey HPS::Key HPS::Object

Public Member Functions

void Consume (TextKit &in_kit)
 
TextKeyEditTextByDeletion (size_t in_row, size_t in_column, size_t in_count)
 
TextKeyEditTextByInsertion (size_t in_row, size_t in_column, size_t in_count, char const *in_text)
 
TextKeyEditTextByReplacement (size_t in_row, size_t in_column, size_t in_count, char const *in_text)
 
HPS::Type ObjectType () const
 
TextKeyoperator= (TextKey const &other)
 
TextKeyoperator= (TextKey &&in_that)
 
void Set (TextKit const &in_kit)
 
TextKeySetAlignment (Text::Alignment in_alignment, Text::ReferenceFrame in_reference_frame=Text::ReferenceFrame::WorldAligned, Text::Justification in_justification=Text::Justification::Left)
 
TextKeySetBackground (bool in_state, char const *in_name)
 
TextKeySetBackground (char const *in_name)
 
TextKeySetBackground (bool in_state)
 
TextKeySetBackgroundMargins (float in_size, Text::MarginUnits in_units=Text::MarginUnits::Percent)
 
TextKeySetBackgroundMargins (FloatArray const &in_sizes, TextMarginUnitsArray const &in_units)
 
TextKeySetBackgroundMargins (size_t in_count, float const in_sizes [], HPS::Text::MarginUnits const in_units [])
 
TextKeySetBackgroundStyle (char const *in_name)
 
TextKeySetBold (bool in_state)
 
TextKeySetColor (RGBAColor const &in_rgba_color)
 
TextKeySetColorByIndex (float in_index)
 
TextKeySetExtraSpace (bool in_state, float in_size=0.0f, Text::SizeUnits in_units=Text::SizeUnits::ObjectSpace)
 
TextKeySetExtraSpace (float in_size, Text::SizeUnits in_units)
 
TextKeySetFont (char const *in_name)
 
TextKeySetGreeking (bool in_state, float in_size=0.0f, Text::GreekingUnits in_units=Text::GreekingUnits::ObjectSpace, Text::GreekingMode in_mode=Text::GreekingMode::Lines)
 
TextKeySetGreeking (float in_size, Text::GreekingUnits in_units, Text::GreekingMode in_mode=Text::GreekingMode::Lines)
 
TextKeySetItalic (bool in_state)
 
TextKeySetLeaderLine (Point const &in_position, Text::LeaderLineSpace in_space=Text::LeaderLineSpace::Object)
 
TextKeySetLeaderLines (PointArray const &in_positions, Text::LeaderLineSpace in_space=Text::LeaderLineSpace::Object)
 
TextKeySetLeaderLines (size_t in_count, Point const in_positions [], Text::LeaderLineSpace in_space=Text::LeaderLineSpace::Object)
 
TextKeySetLineSpacing (float in_multiplier)
 
TextKeySetModellingMatrix (MatrixKit const &in_matrix)
 
TextKeySetOverline (bool in_state)
 
TextKeySetPath (Vector const &in_path)
 
TextKeySetPosition (Point const &in_position)
 
TextKeySetPreference (Text::Preference in_preference)
 
TextKeySetPreference (float in_cutoff, Text::SizeUnits in_units, Text::Preference in_smaller, Text::Preference in_larger)
 
TextKeySetRegion (PointArray const &in_region, Text::RegionAlignment in_region_alignment, Text::RegionFitting in_region_fitting, bool in_region_adjust_direction, bool in_region_relative_coordinates, bool in_region_window_space)
 
TextKeySetRegion (size_t in_region_count, Point const in_region [], Text::RegionAlignment in_region_alignment, Text::RegionFitting in_region_fitting, bool in_region_adjust_direction, bool in_region_relative_coordinates, bool in_region_window_space)
 
TextKeySetRenderer (Text::Renderer in_renderer)
 
TextKeySetRotation (Text::Rotation in_state, float in_angle=0.0f)
 
TextKeySetRotation (float in_angle)
 
TextKeySetSize (float in_size, Text::SizeUnits in_units)
 
TextKeySetSizeTolerance (bool in_state, float in_size=50.0f, Text::SizeToleranceUnits in_units=Text::SizeToleranceUnits::Percent)
 
TextKeySetSizeTolerance (float in_size, Text::SizeToleranceUnits in_units)
 
TextKeySetSlant (float in_angle)
 
TextKeySetSpacing (float in_multiplier)
 
TextKeySetStrikethrough (bool in_state)
 
TextKeySetText (char const *in_string)
 
TextKeySetTextAttribute (TextAttributeKit const &in_kit)
 
TextKeySetTransform (Text::Transform in_transform)
 
TextKeySetUnderline (bool in_state)
 
void Show (TextKit &out_kit) const
 
bool ShowAlignment (Text::Alignment &out_alignment, Text::ReferenceFrame &out_reference_frame, Text::Justification &out_justification) 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 ShowColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_index) 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 ShowLeaderLines (PointArray &out_positions, Text::LeaderLineSpace &out_space) const
 
bool ShowLineSpacing (float &out_multiplier) const
 
bool ShowModellingMatrix (MatrixKit &out_matrix) const
 
bool ShowOverline (bool &out_state) const
 
bool ShowPath (Vector &out_path) const
 
bool ShowPosition (Point &out_position) const
 
bool ShowPreference (float &out_cutoff, Text::SizeUnits &out_units, Text::Preference &out_smaller, Text::Preference &out_larger) const
 
bool ShowRegion (PointArray &out_region, Text::RegionAlignment &out_region_alignment, Text::RegionFitting &out_region_fitting, bool &out_region_adjust_direction, bool &out_region_relative_coordinates, bool &out_region_window_space) const
 
bool ShowRenderer (Text::Renderer &out_renderer) 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 ShowText (UTF8 &out_string) const
 
bool ShowTextAttribute (TextAttributeKit &out_kit) const
 
bool ShowTransform (Text::Transform &out_trans) const
 
bool ShowUnderline (bool &out_state) const
 
 TextKey ()
 
 TextKey (Key const &in_that)
 
 TextKey (TextKey const &in_that)
 
 TextKey (TextKey &&in_that)
 
TextKeyUnsetAlignment ()
 
TextKeyUnsetBackground ()
 
TextKeyUnsetBackgroundMargins ()
 
TextKeyUnsetBackgroundStyle ()
 
TextKeyUnsetBold ()
 
TextKeyUnsetColor ()
 
TextKeyUnsetEverything ()
 
TextKeyUnsetExtraSpace ()
 
TextKeyUnsetFont ()
 
TextKeyUnsetGreeking ()
 
TextKeyUnsetItalic ()
 
TextKeyUnsetLeaderLines ()
 
TextKeyUnsetLineSpacing ()
 
TextKeyUnsetModellingMatrix ()
 
TextKeyUnsetOverline ()
 
TextKeyUnsetPath ()
 
TextKeyUnsetPreference ()
 
TextKeyUnsetRegion ()
 
TextKeyUnsetRenderer ()
 
TextKeyUnsetRotation ()
 
TextKeyUnsetSize ()
 
TextKeyUnsetSizeTolerance ()
 
TextKeyUnsetSlant ()
 
TextKeyUnsetSpacing ()
 
TextKeyUnsetStrikethrough ()
 
TextKeyUnsetTransform ()
 
TextKeyUnsetUnderline ()
 
- Public Member Functions inherited from HPS::GeometryKey
 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
GeometryKeyoperator= (GeometryKey const &in_that)
 
GeometryKeyoperator= (GeometryKey &&in_that)
 
GeometryKeySetPriority (int in_priority)
 
GeometryKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
GeometryKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
GeometryKeySetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
bool ShowBounding (BoundingKit &out_kit) const
 
bool ShowPriority (int &out_priority) const
 
size_t ShowReferrers (SegmentKeyArray &out_segments) const
 
size_t ShowReferrers (ReferenceKeyArray &out_references) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
size_t ShowUserDataCount () const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
GeometryKeyUnsetAllUserData ()
 
GeometryKeyUnsetPriority ()
 
GeometryKeyUnsetUserData (intptr_t in_index)
 
GeometryKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
GeometryKeyUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Key
virtual void Assign (Key const &in_that)
 
Key CopyTo (SegmentKey const &in_destination) const
 
void Delete ()
 
bool Equals (Key const &in_that) const
 
size_t GetHash () const
 
bool HasOwner () const
 
 Key ()
 
 Key (Key const &in_that)
 
 Key (Control const &in_control)
 
 Key (Key &&in_that)
 
void MoveTo (SegmentKey const &in_new_owner)
 
bool operator!= (Key const &in_that) const
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TextKey
 
- Static Public Attributes inherited from HPS::GeometryKey
static const HPS::Type staticType = HPS::Type::GeometryKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

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

Detailed Description

The TextKey class is a smart pointer to a database object. It is a handle to text inserted via SegmentKey::InsertText.

Constructor & Destructor Documentation

◆ TextKey() [1/4]

HPS::TextKey::TextKey ( )

The default constructor creates an uninitialized TextKey object. The Type() function will return Type::None.

◆ TextKey() [2/4]

HPS::TextKey::TextKey ( Key const &  in_that)
explicit

This constructor creates an TextKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a text key. Otherwise the copy will fail and the resulting TextKey will be invalid.

Parameters
in_keyThe source Key to copy.

◆ TextKey() [3/4]

HPS::TextKey::TextKey ( TextKey const &  in_that)

The copy constructor creates a TextKey object that shares the underlying smart-pointer of the source TextKey.

Parameters
in_thatThe source TextKey to copy.

◆ TextKey() [4/4]

HPS::TextKey::TextKey ( TextKey &&  in_that)

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

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

Member Function Documentation

◆ Consume()

void HPS::TextKey::Consume ( TextKit in_kit)

Completely replaces all settings on this TextKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this TextKey.

◆ EditTextByDeletion()

TextKey& HPS::TextKey::EditTextByDeletion ( size_t  in_row,
size_t  in_column,
size_t  in_count 
)

Removes characters from the text at the specified offset.

Parameters
in_rowThe row offset into a multiline text string. This value must be less than the number of lines in the text string.
in_columnThe column offset in Unicode code points into the specified row in a multiline text string. This value must be less than the number of Unicode code points within the specified row.
in_countThe number of Unicode code points within the given text string to remove.
Returns
A reference to this TextKey.

◆ EditTextByInsertion()

TextKey& HPS::TextKey::EditTextByInsertion ( size_t  in_row,
size_t  in_column,
size_t  in_count,
char const *  in_text 
)

Adds characters to the text at the specified offset.

Parameters
in_rowThe row offset into a multiline text string. This value must be less than the number of lines in the text string.
in_columnThe column offset in Unicode code points into the specified row in a multiline text string. This value must be less than the number of Unicode code points within the specified row.
in_countThe number of Unicode code points within the given text string to insert into the text.
in_textUTF8-encoded text to insert into the text. This must contain at least in_count Unicode code points.
Returns
A reference to this TextKey.

◆ EditTextByReplacement()

TextKey& HPS::TextKey::EditTextByReplacement ( size_t  in_row,
size_t  in_column,
size_t  in_count,
char const *  in_text 
)

Replaces characters from the text at the specified offset.

Parameters
in_rowThe row offset into a multiline text string. This value must be less than the number of lines in the text string.
in_columnThe column offset in Unicode code points into the specified row in a multiline text string. This value must be less than the number of Unicode code points within the specified row.
in_countThe number of Unicode code points within the given text string to remove.
in_textUTF8-encoded text to perform replacement with. This must contain at least in_count Unicode code points.
Returns
A reference to this TextKey.

◆ ObjectType()

HPS::Type HPS::TextKey::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::GeometryKey.

◆ operator=() [1/2]

TextKey& HPS::TextKey::operator= ( TextKey const &  other)

Associate this TextKey with the same underlying impl as the source TextKey.

Parameters
in_thatThe source TextKey for the assignment.
Returns
A reference to this TextKey.

◆ operator=() [2/2]

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

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

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

◆ Set()

void HPS::TextKey::Set ( TextKit const &  in_kit)

Replace those settings on this TextKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this TextKey.

◆ SetAlignment()

TextKey& HPS::TextKey::SetAlignment ( Text::Alignment  in_alignment,
Text::ReferenceFrame  in_reference_frame = Text::ReferenceFrame::WorldAligned,
Text::Justification  in_justification = Text::Justification::Left 
)

Sets the alignment for the text. No aligment is set on the text by default.

Parameters
in_alignmentThe alignment for the text.
in_reference_frameThe reference frame for the text. Defaults to Text::ReferenceFrame::WorldAligned.
in_justificationThe justification for the text. Defaults to Text::Justification::Left.
Returns
A reference to this TextKey.

◆ SetBackground() [1/3]

TextKey& HPS::TextKey::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]

TextKey& HPS::TextKey::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]

TextKey& HPS::TextKey::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]

TextKey& HPS::TextKey::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]

TextKey& HPS::TextKey::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]

TextKey& HPS::TextKey::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()

TextKey& HPS::TextKey::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()

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

Sets whether the text should be bold. For fonts which do not have a bold variant, this setting will be ignored. No bold setting is set on the text by default.

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

◆ SetColor()

TextKey& HPS::TextKey::SetColor ( RGBAColor const &  in_rgba_color)

Sets the RGBA color of the text. No color is set on the text by default. If the color set is opaque, an RGBColor will be set instead to improve rendering performance.

Parameters
in_rgba_colorThe RGBA color of the text.
Returns
A reference to this TextKey.

◆ SetColorByIndex()

TextKey& HPS::TextKey::SetColorByIndex ( float  in_index)

Sets the material index color for the text. No color is set on the text by default.

Parameters
in_indexThe material index color for the text.
Returns
A reference to this TextKey.

◆ SetExtraSpace() [1/2]

TextKey& HPS::TextKey::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. No extra space is set on the text by default.

Parameters
in_stateWhether to add additional space between characters in a text string.
in_sizeThe size of the additional space to add between characters. Defaults to 0.0f.
in_unitsThe units of the size of the additional space to add between characters. Defaults to Text::SizeUnits::ObjectSpace.
Returns
A reference to this TextKey.

◆ SetExtraSpace() [2/2]

TextKey& HPS::TextKey::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. No extra space is set on the text by default.

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 TextKey.

◆ SetFont()

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

Sets the font to use for the 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. No font is set on the text by default.

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

◆ SetGreeking() [1/2]

TextKey& HPS::TextKey::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 the text. No greeking settings are set on the text by default.

Parameters
in_stateWhether greeking is enabled for this text.
in_sizeThe size below which to draw a simple symbol in place of a character. Defaults to 0.0f.
in_unitsThe units of the size below which to draw a simple glyph in place of a character. Defaults to Text::GreekingUnits::ObjectSpace.
in_modeThe type of symbol to draw for characters which are smaller than the greeking size. Defaults to Text::GreekingMode::Lines.
Returns
A reference to this TextKey.

◆ SetGreeking() [2/2]

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

Sets the greeking settings to use for the text. This function implicitly enables text greeking. No greeking settings are set on the text by default.

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. Defaults to Text::Gree::Lines.
Returns
A reference to this TextKey.

◆ SetItalic()

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

Sets whether the text should be italic. For fonts which do not have an italic variant, this setting will be ignored. No italic setting is set on the text by default.

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

◆ SetLeaderLine()

TextKey& HPS::TextKey::SetLeaderLine ( Point const &  in_position,
Text::LeaderLineSpace  in_space = Text::LeaderLineSpace::Object 
)

Inserts a leader line for this text, with one end specified by in_position and the other end calculated automatically.

Parameters
in_positionthe target position of the leader line.
in_spacethe coordinate space in which in_position is specified.
Returns
A reference to this object.

◆ SetLeaderLines() [1/2]

TextKey& HPS::TextKey::SetLeaderLines ( PointArray const &  in_positions,
Text::LeaderLineSpace  in_space = Text::LeaderLineSpace::Object 
)

Inserts leader lines for this text.

Parameters
in_positionsthe target positions of the leader lines.
in_spacethe coordinate space in which in_positions is specified.
Returns
A reference to this object.

◆ SetLeaderLines() [2/2]

TextKey& HPS::TextKey::SetLeaderLines ( size_t  in_count,
Point const  in_positions[],
Text::LeaderLineSpace  in_space = Text::LeaderLineSpace::Object 
)

Inserts leader lines for this text.

Parameters
in_countthe size of in_positions.
in_positionsthe target positions of the leader lines.
in_spacethe coordinate space in which in_positions is specified.
Returns
A reference to this object.

◆ SetLineSpacing()

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

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

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

◆ SetModellingMatrix()

TextKey& HPS::TextKey::SetModellingMatrix ( MatrixKit const &  in_matrix)

Sets the modelling matrix for the text. No modelling matrix is set on the text by default.

Parameters
in_matrixThe modelling matrix for the text.
Returns
A reference to this TextKey.

◆ SetOverline()

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

Sets whether an overline should be drawn over the text. No overline setting is set on the text by default.

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

◆ SetPath()

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

Sets the path for the text. This setting controls the vector along which a text string will be displayed. No path is set on the text by default.

Parameters
in_pathThe path for the text.
Returns
A reference to this TextKey.
See also
SetRegion

◆ SetPosition()

TextKey& HPS::TextKey::SetPosition ( Point const &  in_position)

Repositions the text in object space. The object-space position for the text.

Returns
A reference to this TextKey.

◆ SetPreference() [1/2]

TextKey& HPS::TextKey::SetPreference ( Text::Preference  in_preference)

Sets the font type preference for the text. This function implicitly sets the same font type for all text sizes. No preference is set on the text by default.

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

◆ SetPreference() [2/2]

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

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

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 TextKey.

◆ SetRegion() [1/2]

TextKey& HPS::TextKey::SetRegion ( PointArray const &  in_region,
Text::RegionAlignment  in_region_alignment,
Text::RegionFitting  in_region_fitting,
bool  in_region_adjust_direction,
bool  in_region_relative_coordinates,
bool  in_region_window_space 
)

Sets the region for the text. This setting forces the text to be rendererd along the vector defined by two object space points. A region additionally allows control over if text should be evenly spaced between those points, or allowed to grow or shrink to avoid stretching or overlapping characters. No region is set on the text by default.

Parameters
in_regionThe points defining the region for the text. This array must be of size 2 or 3. A two point region defines an implicit up vector which is rotated 90 degrees counter-clockwise from the region line. A three point region uses the first two points as the region line and the third point defines the plane in which a vector perpendicular to the region line will be computed for use as the up vector.
in_region_alignmentHow the text will be positioned relative to the region line.
in_region_fittingHow the text is organized within the region.
in_region_adjust_directionWhether to draw text such that it is readable regardless of camera location.
in_region_relative_coordinatesWhether the points defining the region are relative to the insertion point for the text.
in_region_window_spaceWhether the points defining the region are in window space coordinates.
Returns
A reference to this TextKey.
See also
SetPath

◆ SetRegion() [2/2]

TextKey& HPS::TextKey::SetRegion ( size_t  in_region_count,
Point const  in_region[],
Text::RegionAlignment  in_region_alignment,
Text::RegionFitting  in_region_fitting,
bool  in_region_adjust_direction,
bool  in_region_relative_coordinates,
bool  in_region_window_space 
)

Sets the region for the text. This setting forces the text to be rendererd along the vector defined by two object space points. A region additionally allows control over if text should be evenly spaced between those points, or allowed to grow or shrink to avoid stretching or overlapping characters. No region is set on the text by default.

Parameters
in_region_countSize of the following array. This value must be 2 or 3. A two point region defines an implicit up vector which is rotated 90 degrees counter-clockwise from the region line. A three point region uses the first two points as the region line and the third point defines the plane in which a vector perpendicular to the region line will be computed for use as the up vector.
in_regionThe points defining the region for the text.
in_region_alignmentHow the text will be positioned relative to the region line.
in_region_fittingHow the text is organized within the text region.
in_region_adjust_directionWhether to draw text such that it is readable regardless of camera location.
in_region_relative_coordinatesWhether the points defining the region are relative to the insertion point for the text.
in_region_window_spaceWhether the points defining the region are in window space coordinates.
Returns
A reference to this TextKey.
See also
SetPath

◆ SetRenderer()

TextKey& HPS::TextKey::SetRenderer ( Text::Renderer  in_renderer)

Sets the renderer for the text. No renderer is set on the text by default.

Parameters
in_rendererThe renderer for the text.
Returns
A reference to this TextKey.

◆ SetRotation() [1/2]

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

Sets the angle characters should be rotated within the text string. No rotation is set on the text by default.

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

◆ SetRotation() [2/2]

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

Sets the angle characters should be rotated within the text string. This function implicitly sets a rotation state of Text::Rotation::Rotate. No rotation is set on the text by default.

Parameters
in_angleThe angle in degrees to rotate each character within the text string.
Returns
A reference to this TextKey.

◆ SetSize()

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

Sets the font size to use for the text. No size is set on the text by default.

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

◆ SetSizeTolerance() [1/2]

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

Sets the size tolerance settings to use for the 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. No size tolerance is set on the text by default.

Parameters
in_stateWhether a size tolerance is enabled for this text.
in_sizeThe size for the tolerance. Defaults to 50.0f.
in_unitsThe units of the size for the tolerance. Defaults to Text::SizeToleranceUnits::Percent.
Returns
A reference to this TextKey.

◆ SetSizeTolerance() [2/2]

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

Sets the size tolerance settings to use for the 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. No size tolerance is set on the text by default.

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

◆ SetSlant()

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

Sets the slant angle for the 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. No slant angle is set on the text by default.

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

◆ SetSpacing()

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

Sets the spacing multiplier for the 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 the text.
Returns
A reference to this TextKey.

◆ SetStrikethrough()

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

Sets whether a strikethrough should be drawn through the text. No strikethrough setting is set on the text by default.

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

◆ SetText()

TextKey& HPS::TextKey::SetText ( char const *  in_string)

Replaces the contents of the string for the text.

Parameters
in_stringUTF8-encoded string for the text.
Returns
A reference to this TextKey.

◆ SetTextAttribute()

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

Sets the text attributes designated by in_kit on this TextKey.

Parameters
in_kitThe attribute kit from which to get the attributes for this TextKey.

◆ SetTransform()

TextKey& HPS::TextKey::SetTransform ( Text::Transform  in_transform)

Sets the transform state for the text. No transform state is set on the text by default.

Parameters
in_transformThe transform state for the text.
Returns
A reference to this TextKey.

◆ SetUnderline()

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

Sets whether an underline should be drawn under the text. No underline setting is set on the text by default.

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

◆ Show()

void HPS::TextKey::Show ( TextKit out_kit) const

Copy the contents of this TextKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this TextKey.

◆ ShowAlignment()

bool HPS::TextKey::ShowAlignment ( Text::Alignment out_alignment,
Text::ReferenceFrame out_reference_frame,
Text::Justification out_justification 
) const

Shows the alignment for the text.

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

◆ ShowBackground()

bool HPS::TextKey::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::TextKey::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::TextKey::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::TextKey::ShowBold ( bool &  out_state) const

Shows whether the text should be bold.

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

◆ ShowColor()

bool HPS::TextKey::ShowColor ( Material::Type out_type,
RGBAColor out_rgba_color,
float &  out_index 
) const

Shows the color for the text.

Parameters
out_typeThe type of color for the text.
out_rgba_colorThe RGBA color for the text. This is only valid if out_type is Material::Type::RGBAColor.
out_indexThe material index for the text. This is only valid if out_type is Material::Type::MaterialIndex.
Returns
true if a color was set, false otherwise.

◆ ShowExtraSpace()

bool HPS::TextKey::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::TextKey::ShowFont ( UTF8 out_name) const

Shows the font to use for the text.

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

◆ ShowGreeking()

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

Shows the greeking settings to use for the text.

Parameters
out_stateWhether greeking is enabled for this 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::TextKey::ShowItalic ( bool &  out_state) const

Shows whether the text should be italic.

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

◆ ShowLeaderLines()

bool HPS::TextKey::ShowLeaderLines ( PointArray out_positions,
Text::LeaderLineSpace out_space 
) const

Shows the leader lines to be used with text.

Parameters
out_positionsthe target positions of the leader lines.
out_spacethe coordinate space in which the points in out_positions are specified
Returns
true if leader lines were set, false otherwise.

◆ ShowLineSpacing()

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

Shows the line spacing multiplier for the text.

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

◆ ShowModellingMatrix()

bool HPS::TextKey::ShowModellingMatrix ( MatrixKit out_matrix) const

Shows the modelling matrix for the text.

Parameters
out_matrixThe modelling matrix for the text.
Returns
true if a modelling matrix was set, false otherwise.

◆ ShowOverline()

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

Shows whether an overline should be drawn over the text.

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

◆ ShowPath()

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

Shows the path for the text.

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

◆ ShowPosition()

bool HPS::TextKey::ShowPosition ( Point out_position) const

Shows the position for the text.

Parameters
out_positionThe object-space position for the text.
Returns
true if a position was set, false otherwise.

◆ ShowPreference()

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

Shows the preference for the 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.

◆ ShowRegion()

bool HPS::TextKey::ShowRegion ( PointArray out_region,
Text::RegionAlignment out_region_alignment,
Text::RegionFitting out_region_fitting,
bool &  out_region_adjust_direction,
bool &  out_region_relative_coordinates,
bool &  out_region_window_space 
) const

Shows the region for the text.

Parameters
out_regionThe points defining the region for the text.
out_region_alignmentHow the text will be positioned relative to the region line.
out_region_fittingHow the text will be organized within the region.
out_region_adjust_directionWhether to draw text such that it is readable regardless of camera location.
out_region_relative_coordinatesWhether the points defining the region are relative to the insertion point for the text.
out_region_window_spaceWhether the points defining the region are in window space coordinates.
Returns
true if a region was set, false otherwise.

◆ ShowRenderer()

bool HPS::TextKey::ShowRenderer ( Text::Renderer out_renderer) const

Shows the renderer for the text.

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

◆ ShowRotation()

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

Shows the angle characters should be rotated within the text string.

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

◆ ShowSize()

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

Shows the font size to use for the text.

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

◆ ShowSizeTolerance()

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

Shows the size tolerance settings to use for the text.

Parameters
out_stateWhether a size tolerance is enabled for this 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::TextKey::ShowSlant ( float &  out_angle) const

Shows the slant angle for the text.

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

◆ ShowSpacing()

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

Shows the spacing multiplier for the text.

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

◆ ShowStrikethrough()

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

Shows whether a strikethrough should be drawn through the text.

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

◆ ShowText()

bool HPS::TextKey::ShowText ( UTF8 out_string) const

Shows the string for the text.

Parameters
out_stringUTF8-encoded string for the text.
Returns
true if a text string was set, false otherwise.

◆ ShowTextAttribute()

bool HPS::TextKey::ShowTextAttribute ( TextAttributeKit out_kit) const

Sets the text attributes designated by in_kit on this TextKey.

Parameters
out_kitThe attribute kit to populate with the attributes for this TextKey.
Returns
true if the attributes were set, false otherwise.

◆ ShowTransform()

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

Shows the transform state for the text.

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

◆ ShowUnderline()

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

Shows whether an underline should be drawn under the text.

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

◆ UnsetAlignment()

TextKey& HPS::TextKey::UnsetAlignment ( )

Removes the alignment setting from the text.

Returns
A reference to this TextKey.

◆ UnsetBackground()

TextKey& HPS::TextKey::UnsetBackground ( )

Removes the background setting.

Returns
A reference to this object.

◆ UnsetBackgroundMargins()

TextKey& HPS::TextKey::UnsetBackgroundMargins ( )

Removes the background margin setting.

Returns
A reference to this object.

◆ UnsetBackgroundStyle()

TextKey& HPS::TextKey::UnsetBackgroundStyle ( )

Removes the background style setting.

Returns
A reference to this object.

◆ UnsetBold()

TextKey& HPS::TextKey::UnsetBold ( )

Removes the bold setting from the text.

Returns
A reference to this TextKey.

◆ UnsetColor()

TextKey& HPS::TextKey::UnsetColor ( )

Removes the color (RGBA or material index) from the text.

Returns
A reference to this TextKey.

◆ UnsetEverything()

TextKey& HPS::TextKey::UnsetEverything ( )

Removes all settings from this TextKey.

Returns
A reference to this TextKey.

◆ UnsetExtraSpace()

TextKey& HPS::TextKey::UnsetExtraSpace ( )

Removes the extra space setting from the text.

Returns
A reference to this TextKey.

◆ UnsetFont()

TextKey& HPS::TextKey::UnsetFont ( )

Removes the font setting from the text.

Returns
A reference to this TextKey.

◆ UnsetGreeking()

TextKey& HPS::TextKey::UnsetGreeking ( )

Removes the greeking settings from the text.

Returns
A reference to this TextKey.

◆ UnsetItalic()

TextKey& HPS::TextKey::UnsetItalic ( )

Removes the italic setting from the text.

Returns
A reference to this TextKey.

◆ UnsetLeaderLines()

TextKey& HPS::TextKey::UnsetLeaderLines ( )

Removes the leader line setting.

Returns
A reference to this object.

◆ UnsetLineSpacing()

TextKey& HPS::TextKey::UnsetLineSpacing ( )

Removes the line spacing setting from the text.

Returns
A reference to this TextKey.

◆ UnsetModellingMatrix()

TextKey& HPS::TextKey::UnsetModellingMatrix ( )

Removes the modelling matrix from the text.

Returns
A reference to this TextKey.

◆ UnsetOverline()

TextKey& HPS::TextKey::UnsetOverline ( )

Removes the overline setting from the text.

Returns
A reference to this TextKey.

◆ UnsetPath()

TextKey& HPS::TextKey::UnsetPath ( )

Removes the path from the text.

Returns
A reference to this TextKey.

◆ UnsetPreference()

TextKey& HPS::TextKey::UnsetPreference ( )

Removes the font type preference from the text.

Returns
A reference to this TextKey.

◆ UnsetRegion()

TextKey& HPS::TextKey::UnsetRegion ( )

Removes the region from the text.

Returns
A reference to this TextKey.

◆ UnsetRenderer()

TextKey& HPS::TextKey::UnsetRenderer ( )

Removes the renderer setting from the text.

Returns
A reference to this TextKey.

◆ UnsetRotation()

TextKey& HPS::TextKey::UnsetRotation ( )

Removes the rotation setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSize()

TextKey& HPS::TextKey::UnsetSize ( )

Removes the size setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSizeTolerance()

TextKey& HPS::TextKey::UnsetSizeTolerance ( )

Removes the size tolerance setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSlant()

TextKey& HPS::TextKey::UnsetSlant ( )

Removes the slant setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSpacing()

TextKey& HPS::TextKey::UnsetSpacing ( )

Removes the spacing setting from the text.

Returns
A reference to this TextKey.

◆ UnsetStrikethrough()

TextKey& HPS::TextKey::UnsetStrikethrough ( )

Removes the strikethrough setting from the text.

Returns
A reference to this TextKey.

◆ UnsetTransform()

TextKey& HPS::TextKey::UnsetTransform ( )

Removes the transform setting from the text.

Returns
A reference to this TextKey.

◆ UnsetUnderline()

TextKey& HPS::TextKey::UnsetUnderline ( )

Removes the underline setting from the text.

Returns
A reference to this TextKey.

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