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

Public Member Functions

void Consume (HPS.TextKit in_kit)
 
override void Dispose ()
 
HPS.TextKey EditTextByDeletion (ulong in_row, ulong in_column, ulong in_count)
 
HPS.TextKey EditTextByInsertion (ulong in_row, ulong in_column, ulong in_count, string in_text)
 
HPS.TextKey EditTextByReplacement (ulong in_row, ulong in_column, ulong in_count, string in_text)
 
override HPS.Type ObjectType ()
 
void Set (HPS.TextKit in_kit)
 
HPS.TextKey SetAlignment (HPS.Text.Alignment in_alignment, HPS.Text.ReferenceFrame in_reference_frame, HPS.Text.Justification in_justification)
 
HPS.TextKey SetAlignment (HPS.Text.Alignment in_alignment, HPS.Text.ReferenceFrame in_reference_frame)
 
HPS.TextKey SetAlignment (HPS.Text.Alignment in_alignment)
 
HPS.TextKey SetBackground (bool in_state, string in_name)
 
HPS.TextKey SetBackground (string in_name)
 
HPS.TextKey SetBackground (bool in_state)
 
HPS.TextKey SetBackgroundMargins (float in_size, HPS.Text.MarginUnits in_units)
 
HPS.TextKey SetBackgroundMargins (float in_size)
 
HPS.TextKey SetBackgroundMargins (float[] in_sizes, HPS.Text.MarginUnits[] in_units)
 
HPS.TextKey SetBackgroundStyle (string in_name)
 
HPS.TextKey SetBold (bool in_state)
 
HPS.TextKey SetColor (HPS.RGBAColor in_rgba_color)
 
HPS.TextKey SetColorByIndex (float in_index)
 
HPS.TextKey SetExtraSpace (bool in_state, float in_size, HPS.Text.SizeUnits in_units)
 
HPS.TextKey SetExtraSpace (bool in_state, float in_size)
 
HPS.TextKey SetExtraSpace (bool in_state)
 
HPS.TextKey SetExtraSpace (float in_size, HPS.Text.SizeUnits in_units)
 
HPS.TextKey SetFont (string in_name)
 
HPS.TextKey SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode)
 
HPS.TextKey SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units)
 
HPS.TextKey SetGreeking (bool in_state, float in_size)
 
HPS.TextKey SetGreeking (bool in_state)
 
HPS.TextKey SetGreeking (float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode)
 
HPS.TextKey SetGreeking (float in_size, HPS.Text.GreekingUnits in_units)
 
HPS.TextKey SetItalic (bool in_state)
 
HPS.TextKey SetLeaderLine (HPS.Point in_position, HPS.Text.LeaderLineSpace in_space)
 
HPS.TextKey SetLeaderLine (HPS.Point in_position)
 
HPS.TextKey SetLeaderLines (HPS.Point[] in_positions, HPS.Text.LeaderLineSpace in_space)
 
HPS.TextKey SetLeaderLines (HPS.Point[] in_positions)
 
HPS.TextKey SetLineSpacing (float in_multiplier)
 
HPS.TextKey SetModellingMatrix (HPS.MatrixKit in_matrix)
 
HPS.TextKey SetOverline (bool in_state)
 
HPS.TextKey SetPath (HPS.Vector in_path)
 
HPS.TextKey SetPosition (HPS.Point in_position)
 
HPS.TextKey SetPreference (HPS.Text.Preference in_preference)
 
HPS.TextKey SetPreference (float in_cutoff, HPS.Text.SizeUnits in_units, HPS.Text.Preference in_smaller, HPS.Text.Preference in_larger)
 
HPS.TextKey SetRegion (HPS.Point[] in_region, HPS.Text.RegionAlignment in_region_alignment, HPS.Text.RegionFitting in_region_fitting, bool in_region_adjust_direction, bool in_region_relative_coordinates, bool in_region_window_space)
 
HPS.TextKey SetRenderer (HPS.Text.Renderer in_renderer)
 
HPS.TextKey SetRotation (HPS.Text.Rotation in_state, float in_angle)
 
HPS.TextKey SetRotation (HPS.Text.Rotation in_state)
 
HPS.TextKey SetRotation (float in_angle)
 
HPS.TextKey SetSize (float in_size, HPS.Text.SizeUnits in_units)
 
HPS.TextKey SetSizeTolerance (bool in_state, float in_size, HPS.Text.SizeToleranceUnits in_units)
 
HPS.TextKey SetSizeTolerance (bool in_state, float in_size)
 
HPS.TextKey SetSizeTolerance (bool in_state)
 
HPS.TextKey SetSizeTolerance (float in_size, HPS.Text.SizeToleranceUnits in_units)
 
HPS.TextKey SetSlant (float in_angle)
 
HPS.TextKey SetSpacing (float in_multiplier)
 
HPS.TextKey SetStrikethrough (bool in_state)
 
HPS.TextKey SetText (string in_string)
 
HPS.TextKey SetTextAttribute (HPS.TextAttributeKit in_kit)
 
HPS.TextKey SetTransform (HPS.Text.Transform in_transform)
 
HPS.TextKey SetUnderline (bool in_state)
 
void Show (out HPS.TextKit out_kit)
 
bool ShowAlignment (out HPS.Text.Alignment out_alignment, out HPS.Text.ReferenceFrame out_reference_frame, out HPS.Text.Justification out_justification)
 
bool ShowBackground (out bool out_state, out string out_name)
 
bool ShowBackgroundMargins (out float[] out_size, out HPS.Text.MarginUnits[] out_units)
 
bool ShowBackgroundStyle (out string out_name)
 
bool ShowBold (out bool out_state)
 
bool ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index)
 
bool ShowExtraSpace (out bool out_state, out float out_size, out HPS.Text.SizeUnits out_units)
 
bool ShowFont (out string out_name)
 
bool ShowGreeking (out bool out_state, out float out_size, out HPS.Text.GreekingUnits out_units, out HPS.Text.GreekingMode out_mode)
 
bool ShowItalic (out bool out_state)
 
bool ShowLeaderLines (out HPS.Point[] out_positions, out HPS.Text.LeaderLineSpace out_space)
 
bool ShowLineSpacing (out float out_multiplier)
 
bool ShowModellingMatrix (out HPS.MatrixKit out_matrix)
 
bool ShowOverline (out bool out_state)
 
bool ShowPath (out HPS.Vector out_path)
 
bool ShowPosition (out HPS.Point out_position)
 
bool ShowPreference (out float out_cutoff, out HPS.Text.SizeUnits out_units, out HPS.Text.Preference out_smaller, out HPS.Text.Preference out_larger)
 
bool ShowRegion (out HPS.Point[] out_region, out HPS.Text.RegionAlignment out_region_alignment, out HPS.Text.RegionFitting out_region_fitting, out bool out_region_adjust_direction, out bool out_region_relative_coordinates, out bool out_region_window_space)
 
bool ShowRenderer (out HPS.Text.Renderer out_renderer)
 
bool ShowRotation (out HPS.Text.Rotation out_rot, out float out_angle)
 
bool ShowSize (out float out_size, out HPS.Text.SizeUnits out_units)
 
bool ShowSizeTolerance (out bool out_state, out float out_size, out HPS.Text.SizeToleranceUnits out_units)
 
bool ShowSlant (out float out_angle)
 
bool ShowSpacing (out float out_multiplier)
 
bool ShowStrikethrough (out bool out_state)
 
bool ShowText (out string out_string)
 
bool ShowTextAttribute (out HPS.TextAttributeKit out_kit)
 
bool ShowTransform (out HPS.Text.Transform out_trans)
 
bool ShowUnderline (out bool out_state)
 
 TextKey ()
 
 TextKey (HPS.Key in_that)
 
 TextKey (HPS.TextKey in_that)
 
HPS.TextKey UnsetAlignment ()
 
HPS.TextKey UnsetBackground ()
 
HPS.TextKey UnsetBackgroundMargins ()
 
HPS.TextKey UnsetBackgroundStyle ()
 
HPS.TextKey UnsetBold ()
 
HPS.TextKey UnsetColor ()
 
HPS.TextKey UnsetEverything ()
 
HPS.TextKey UnsetExtraSpace ()
 
HPS.TextKey UnsetFont ()
 
HPS.TextKey UnsetGreeking ()
 
HPS.TextKey UnsetItalic ()
 
HPS.TextKey UnsetLeaderLines ()
 
HPS.TextKey UnsetLineSpacing ()
 
HPS.TextKey UnsetModellingMatrix ()
 
HPS.TextKey UnsetOverline ()
 
HPS.TextKey UnsetPath ()
 
HPS.TextKey UnsetPreference ()
 
HPS.TextKey UnsetRegion ()
 
HPS.TextKey UnsetRenderer ()
 
HPS.TextKey UnsetRotation ()
 
HPS.TextKey UnsetSize ()
 
HPS.TextKey UnsetSizeTolerance ()
 
HPS.TextKey UnsetSlant ()
 
HPS.TextKey UnsetSpacing ()
 
HPS.TextKey UnsetStrikethrough ()
 
HPS.TextKey UnsetTransform ()
 
HPS.TextKey UnsetUnderline ()
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
HPS.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/3]

HPS.TextKey.TextKey ( )
inline

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

◆ TextKey() [2/3]

HPS.TextKey.TextKey ( HPS.Key  in_that)
inline

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.

◆ TextKey() [3/3]

HPS.TextKey.TextKey ( HPS.TextKey  in_that)
inline

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

Parameters
in_thatThe source TextKey to copy.

Member Function Documentation

◆ Consume()

void HPS.TextKey.Consume ( HPS.TextKit  in_kit)
inline

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()

HPS.TextKey HPS.TextKey.EditTextByDeletion ( ulong  in_row,
ulong  in_column,
ulong  in_count 
)
inline

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()

HPS.TextKey HPS.TextKey.EditTextByInsertion ( ulong  in_row,
ulong  in_column,
ulong  in_count,
string  in_text 
)
inline

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()

HPS.TextKey HPS.TextKey.EditTextByReplacement ( ulong  in_row,
ulong  in_column,
ulong  in_count,
string  in_text 
)
inline

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()

override HPS.Type HPS.TextKey.ObjectType ( )
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.

◆ Set()

void HPS.TextKey.Set ( HPS.TextKit  in_kit)
inline

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() [1/3]

HPS.TextKey HPS.TextKey.SetAlignment ( HPS.Text.Alignment  in_alignment,
HPS.Text.ReferenceFrame  in_reference_frame,
HPS.Text.Justification  in_justification 
)
inline

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.

◆ SetAlignment() [2/3]

HPS.TextKey HPS.TextKey.SetAlignment ( HPS.Text.Alignment  in_alignment,
HPS.Text.ReferenceFrame  in_reference_frame 
)
inline

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.
Returns
A reference to this TextKey.

◆ SetAlignment() [3/3]

HPS.TextKey HPS.TextKey.SetAlignment ( HPS.Text.Alignment  in_alignment)
inline

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

Parameters
in_alignmentThe alignment for the text.
Returns
A reference to this TextKey.

◆ SetBackground() [1/3]

HPS.TextKey HPS.TextKey.SetBackground ( bool  in_state,
string  in_name 
)
inline

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]

HPS.TextKey HPS.TextKey.SetBackground ( string  in_name)
inline

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]

HPS.TextKey HPS.TextKey.SetBackground ( bool  in_state)
inline

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]

HPS.TextKey HPS.TextKey.SetBackgroundMargins ( float  in_size,
HPS.Text.MarginUnits  in_units 
)
inline

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]

HPS.TextKey HPS.TextKey.SetBackgroundMargins ( float  in_size)
inline

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

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

◆ SetBackgroundMargins() [3/3]

HPS.TextKey HPS.TextKey.SetBackgroundMargins ( float []  in_sizes,
HPS.Text.MarginUnits []  in_units 
)
inline

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.

◆ SetBackgroundStyle()

HPS.TextKey HPS.TextKey.SetBackgroundStyle ( string  in_name)
inline

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()

HPS.TextKey HPS.TextKey.SetBold ( bool  in_state)
inline

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()

HPS.TextKey HPS.TextKey.SetColor ( HPS.RGBAColor  in_rgba_color)
inline

Sets the RGBA color of the text. No color is set on the text by default.

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

◆ SetColorByIndex()

HPS.TextKey HPS.TextKey.SetColorByIndex ( float  in_index)
inline

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/4]

HPS.TextKey HPS.TextKey.SetExtraSpace ( bool  in_state,
float  in_size,
HPS.Text.SizeUnits  in_units 
)
inline

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/4]

HPS.TextKey HPS.TextKey.SetExtraSpace ( bool  in_state,
float  in_size 
)
inline

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.
Returns
A reference to this TextKey.

◆ SetExtraSpace() [3/4]

HPS.TextKey HPS.TextKey.SetExtraSpace ( bool  in_state)
inline

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.
Returns
A reference to this TextKey.

◆ SetExtraSpace() [4/4]

HPS.TextKey HPS.TextKey.SetExtraSpace ( float  in_size,
HPS.Text.SizeUnits  in_units 
)
inline

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()

HPS.TextKey HPS.TextKey.SetFont ( string  in_name)
inline

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/6]

HPS.TextKey HPS.TextKey.SetGreeking ( bool  in_state,
float  in_size,
HPS.Text.GreekingUnits  in_units,
HPS.Text.GreekingMode  in_mode 
)
inline

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/6]

HPS.TextKey HPS.TextKey.SetGreeking ( bool  in_state,
float  in_size,
HPS.Text.GreekingUnits  in_units 
)
inline

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.
Returns
A reference to this TextKey.

◆ SetGreeking() [3/6]

HPS.TextKey HPS.TextKey.SetGreeking ( bool  in_state,
float  in_size 
)
inline

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.
Returns
A reference to this TextKey.

◆ SetGreeking() [4/6]

HPS.TextKey HPS.TextKey.SetGreeking ( bool  in_state)
inline

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.
Returns
A reference to this TextKey.

◆ SetGreeking() [5/6]

HPS.TextKey HPS.TextKey.SetGreeking ( float  in_size,
HPS.Text.GreekingUnits  in_units,
HPS.Text.GreekingMode  in_mode 
)
inline

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.

◆ SetGreeking() [6/6]

HPS.TextKey HPS.TextKey.SetGreeking ( float  in_size,
HPS.Text.GreekingUnits  in_units 
)
inline

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.
Returns
A reference to this TextKey.

◆ SetItalic()

HPS.TextKey HPS.TextKey.SetItalic ( bool  in_state)
inline

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() [1/2]

HPS.TextKey HPS.TextKey.SetLeaderLine ( HPS.Point  in_position,
HPS.Text.LeaderLineSpace  in_space 
)
inline

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.

◆ SetLeaderLine() [2/2]

HPS.TextKey HPS.TextKey.SetLeaderLine ( HPS.Point  in_position)
inline

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.
Returns
A reference to this object.

◆ SetLeaderLines() [1/2]

HPS.TextKey HPS.TextKey.SetLeaderLines ( HPS.Point []  in_positions,
HPS.Text.LeaderLineSpace  in_space 
)
inline

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]

HPS.TextKey HPS.TextKey.SetLeaderLines ( HPS.Point []  in_positions)
inline

Inserts leader lines for this text.

Parameters
in_positionsthe target positions of the leader lines.
Returns
A reference to this object.

◆ SetLineSpacing()

HPS.TextKey HPS.TextKey.SetLineSpacing ( float  in_multiplier)
inline

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()

HPS.TextKey HPS.TextKey.SetModellingMatrix ( HPS.MatrixKit  in_matrix)
inline

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()

HPS.TextKey HPS.TextKey.SetOverline ( bool  in_state)
inline

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()

HPS.TextKey HPS.TextKey.SetPath ( HPS.Vector  in_path)
inline

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()

HPS.TextKey HPS.TextKey.SetPosition ( HPS.Point  in_position)
inline

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

Returns
A reference to this TextKey.

◆ SetPreference() [1/2]

HPS.TextKey HPS.TextKey.SetPreference ( HPS.Text.Preference  in_preference)
inline

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]

HPS.TextKey HPS.TextKey.SetPreference ( float  in_cutoff,
HPS.Text.SizeUnits  in_units,
HPS.Text.Preference  in_smaller,
HPS.Text.Preference  in_larger 
)
inline

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()

HPS.TextKey HPS.TextKey.SetRegion ( HPS.Point []  in_region,
HPS.Text.RegionAlignment  in_region_alignment,
HPS.Text.RegionFitting  in_region_fitting,
bool  in_region_adjust_direction,
bool  in_region_relative_coordinates,
bool  in_region_window_space 
)
inline

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

◆ SetRenderer()

HPS.TextKey HPS.TextKey.SetRenderer ( HPS.Text.Renderer  in_renderer)
inline

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/3]

HPS.TextKey HPS.TextKey.SetRotation ( HPS.Text.Rotation  in_state,
float  in_angle 
)
inline

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/3]

HPS.TextKey HPS.TextKey.SetRotation ( HPS.Text.Rotation  in_state)
inline

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.
Returns
A reference to this TextKey.

◆ SetRotation() [3/3]

HPS.TextKey HPS.TextKey.SetRotation ( float  in_angle)
inline

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()

HPS.TextKey HPS.TextKey.SetSize ( float  in_size,
HPS.Text.SizeUnits  in_units 
)
inline

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/4]

HPS.TextKey HPS.TextKey.SetSizeTolerance ( bool  in_state,
float  in_size,
HPS.Text.SizeToleranceUnits  in_units 
)
inline

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/4]

HPS.TextKey HPS.TextKey.SetSizeTolerance ( bool  in_state,
float  in_size 
)
inline

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.
Returns
A reference to this TextKey.

◆ SetSizeTolerance() [3/4]

HPS.TextKey HPS.TextKey.SetSizeTolerance ( bool  in_state)
inline

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.
Returns
A reference to this TextKey.

◆ SetSizeTolerance() [4/4]

HPS.TextKey HPS.TextKey.SetSizeTolerance ( float  in_size,
HPS.Text.SizeToleranceUnits  in_units 
)
inline

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()

HPS.TextKey HPS.TextKey.SetSlant ( float  in_angle)
inline

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()

HPS.TextKey HPS.TextKey.SetSpacing ( float  in_multiplier)
inline

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()

HPS.TextKey HPS.TextKey.SetStrikethrough ( bool  in_state)
inline

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()

HPS.TextKey HPS.TextKey.SetText ( string  in_string)
inline

Replaces the contents of the string for the text.

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

◆ SetTextAttribute()

HPS.TextKey HPS.TextKey.SetTextAttribute ( HPS.TextAttributeKit  in_kit)
inline

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()

HPS.TextKey HPS.TextKey.SetTransform ( HPS.Text.Transform  in_transform)
inline

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()

HPS.TextKey HPS.TextKey.SetUnderline ( bool  in_state)
inline

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 ( out HPS.TextKit  out_kit)
inline

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 ( out HPS.Text.Alignment  out_alignment,
out HPS.Text.ReferenceFrame  out_reference_frame,
out HPS.Text.Justification  out_justification 
)
inline

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 ( out bool  out_state,
out string  out_name 
)
inline

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 ( out float []  out_size,
out HPS.Text.MarginUnits []  out_units 
)
inline

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 ( out string  out_name)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_rgba_color,
out float  out_index 
)
inline

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 ( out bool  out_state,
out float  out_size,
out HPS.Text.SizeUnits  out_units 
)
inline

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 ( out string  out_name)
inline

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 ( out bool  out_state,
out float  out_size,
out HPS.Text.GreekingUnits  out_units,
out HPS.Text.GreekingMode  out_mode 
)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Point []  out_positions,
out HPS.Text.LeaderLineSpace  out_space 
)
inline

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 ( out float  out_multiplier)
inline

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 ( out HPS.MatrixKit  out_matrix)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Vector  out_path)
inline

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 ( out HPS.Point  out_position)
inline

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 ( out float  out_cutoff,
out HPS.Text.SizeUnits  out_units,
out HPS.Text.Preference  out_smaller,
out HPS.Text.Preference  out_larger 
)
inline

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 ( out HPS.Point []  out_region,
out HPS.Text.RegionAlignment  out_region_alignment,
out HPS.Text.RegionFitting  out_region_fitting,
out bool  out_region_adjust_direction,
out bool  out_region_relative_coordinates,
out bool  out_region_window_space 
)
inline

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 ( out HPS.Text.Renderer  out_renderer)
inline

Shows the renderer for the text.

Returns
true if a renderer was set, false otherwise.

◆ ShowRotation()

bool HPS.TextKey.ShowRotation ( out HPS.Text.Rotation  out_rot,
out float  out_angle 
)
inline

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 ( out float  out_size,
out HPS.Text.SizeUnits  out_units 
)
inline

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 ( out bool  out_state,
out float  out_size,
out HPS.Text.SizeToleranceUnits  out_units 
)
inline

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 ( out float  out_angle)
inline

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 ( out float  out_multiplier)
inline

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 ( out bool  out_state)
inline

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 ( out string  out_string)
inline

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 ( out HPS.TextAttributeKit  out_kit)
inline

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 ( out HPS.Text.Transform  out_trans)
inline

Shows the transform state for the text.

Returns
true if a transform state was set, false otherwise.

◆ ShowUnderline()

bool HPS.TextKey.ShowUnderline ( out bool  out_state)
inline

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()

HPS.TextKey HPS.TextKey.UnsetAlignment ( )
inline

Removes the alignment setting from the text.

Returns
A reference to this TextKey.

◆ UnsetBackground()

HPS.TextKey HPS.TextKey.UnsetBackground ( )
inline

Removes the background setting.

Returns
A reference to this object.

◆ UnsetBackgroundMargins()

HPS.TextKey HPS.TextKey.UnsetBackgroundMargins ( )
inline

Removes the background margin setting.

Returns
A reference to this object.

◆ UnsetBackgroundStyle()

HPS.TextKey HPS.TextKey.UnsetBackgroundStyle ( )
inline

Removes the background style setting.

Returns
A reference to this object.

◆ UnsetBold()

HPS.TextKey HPS.TextKey.UnsetBold ( )
inline

Removes the bold setting from the text.

Returns
A reference to this TextKey.

◆ UnsetColor()

HPS.TextKey HPS.TextKey.UnsetColor ( )
inline

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

Returns
A reference to this TextKey.

◆ UnsetEverything()

HPS.TextKey HPS.TextKey.UnsetEverything ( )
inline

Removes all settings from this TextKey.

Returns
A reference to this TextKey.

◆ UnsetExtraSpace()

HPS.TextKey HPS.TextKey.UnsetExtraSpace ( )
inline

Removes the extra space setting from the text.

Returns
A reference to this TextKey.

◆ UnsetFont()

HPS.TextKey HPS.TextKey.UnsetFont ( )
inline

Removes the font setting from the text.

Returns
A reference to this TextKey.

◆ UnsetGreeking()

HPS.TextKey HPS.TextKey.UnsetGreeking ( )
inline

Removes the greeking settings from the text.

Returns
A reference to this TextKey.

◆ UnsetItalic()

HPS.TextKey HPS.TextKey.UnsetItalic ( )
inline

Removes the italic setting from the text.

Returns
A reference to this TextKey.

◆ UnsetLeaderLines()

HPS.TextKey HPS.TextKey.UnsetLeaderLines ( )
inline

Removes the leader line setting.

Returns
A reference to this object.

◆ UnsetLineSpacing()

HPS.TextKey HPS.TextKey.UnsetLineSpacing ( )
inline

Removes the line spacing setting from the text.

Returns
A reference to this TextKey.

◆ UnsetModellingMatrix()

HPS.TextKey HPS.TextKey.UnsetModellingMatrix ( )
inline

Removes the modelling matrix from the text.

Returns
A reference to this TextKey.

◆ UnsetOverline()

HPS.TextKey HPS.TextKey.UnsetOverline ( )
inline

Removes the overline setting from the text.

Returns
A reference to this TextKey.

◆ UnsetPath()

HPS.TextKey HPS.TextKey.UnsetPath ( )
inline

Removes the path from the text.

Returns
A reference to this TextKey.

◆ UnsetPreference()

HPS.TextKey HPS.TextKey.UnsetPreference ( )
inline

Removes the font type preference from the text.

Returns
A reference to this TextKey.

◆ UnsetRegion()

HPS.TextKey HPS.TextKey.UnsetRegion ( )
inline

Removes the region from the text.

Returns
A reference to this TextKey.

◆ UnsetRenderer()

HPS.TextKey HPS.TextKey.UnsetRenderer ( )
inline

Removes the renderer setting from the text.

Returns
A reference to this TextKey.

◆ UnsetRotation()

HPS.TextKey HPS.TextKey.UnsetRotation ( )
inline

Removes the rotation setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSize()

HPS.TextKey HPS.TextKey.UnsetSize ( )
inline

Removes the size setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSizeTolerance()

HPS.TextKey HPS.TextKey.UnsetSizeTolerance ( )
inline

Removes the size tolerance setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSlant()

HPS.TextKey HPS.TextKey.UnsetSlant ( )
inline

Removes the slant setting from the text.

Returns
A reference to this TextKey.

◆ UnsetSpacing()

HPS.TextKey HPS.TextKey.UnsetSpacing ( )
inline

Removes the spacing setting from the text.

Returns
A reference to this TextKey.

◆ UnsetStrikethrough()

HPS.TextKey HPS.TextKey.UnsetStrikethrough ( )
inline

Removes the strikethrough setting from the text.

Returns
A reference to this TextKey.

◆ UnsetTransform()

HPS.TextKey HPS.TextKey.UnsetTransform ( )
inline

Removes the transform setting from the text.

Returns
A reference to this TextKey.

◆ UnsetUnderline()

HPS.TextKey HPS.TextKey.UnsetUnderline ( )
inline

Removes the underline setting from the text.

Returns
A reference to this TextKey.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.TextKey.cs