REFERENCE MANUAL
The TextKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.TextKit in_kit) |
Copies the source TextKit into this TextKit and resets the source kit. More... | |
override void | Dispose () |
HPS.TextKit | EditTextByDeletion (ulong in_row, ulong in_column, ulong in_count) |
Removes characters from the text at the specified offset. More... | |
HPS.TextKit | EditTextByInsertion (ulong in_row, ulong in_column, ulong in_count, string in_text) |
Adds characters to the text at the specified offset. More... | |
HPS.TextKit | EditTextByReplacement (ulong in_row, ulong in_column, ulong in_count, string in_text) |
Replaces characters from the text at the specified offset. More... | |
override bool | Empty () |
Indicates whether this TextKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.TextKit in_kit) |
Check if the source TextKit is equivalent to this TextKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.TextKit in_kit) |
Copies the source TextKit into this TextKit. More... | |
HPS.TextKit | SetAlignment (HPS.Text.Alignment in_alignment, HPS.Text.ReferenceFrame in_reference_frame, HPS.Text.Justification in_justification) |
Sets the alignment for the text. More... | |
HPS.TextKit | SetAlignment (HPS.Text.Alignment in_alignment, HPS.Text.ReferenceFrame in_reference_frame) |
Sets the alignment for the text. More... | |
HPS.TextKit | SetAlignment (HPS.Text.Alignment in_alignment) |
Sets the alignment for the text. More... | |
HPS.TextKit | SetBold (bool in_state) |
Sets whether the text should be bold. More... | |
HPS.TextKit | SetColor (HPS.RGBAColor in_rgba_color) |
Sets the RGBA color of the text. More... | |
HPS.TextKit | SetColorByIndex (float in_index) |
Sets the material index color for the text. More... | |
HPS.TextKit | SetExtraSpace (bool in_state, float in_size, HPS.Text.SizeUnits in_units) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextKit | SetExtraSpace (bool in_state, float in_size) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextKit | SetExtraSpace (bool in_state) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextKit | SetExtraSpace (float in_size, HPS.Text.SizeUnits in_units) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextKit | SetFont (string in_name) |
Sets the font to use for the text. More... | |
HPS.TextKit | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
Sets the greeking settings to use for the text. More... | |
HPS.TextKit | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for the text. More... | |
HPS.TextKit | SetGreeking (bool in_state, float in_size) |
Sets the greeking settings to use for the text. More... | |
HPS.TextKit | SetGreeking (bool in_state) |
Sets the greeking settings to use for the text. More... | |
HPS.TextKit | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
Sets the greeking settings to use for the text. More... | |
HPS.TextKit | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for the text. More... | |
HPS.TextKit | SetItalic (bool in_state) |
Sets whether the text should be italic. More... | |
HPS.TextKit | SetLineSpacing (float in_multiplier) |
Sets the line spacing multiplier for the text. More... | |
HPS.TextKit | SetModellingMatrix (HPS.MatrixKit in_matrix) |
Sets the modelling matrix for the text. More... | |
HPS.TextKit | SetOverline (bool in_state) |
Sets whether an overline should be drawn over the text. More... | |
HPS.TextKit | SetPath (HPS.Vector in_path) |
Sets the path for the text. More... | |
HPS.TextKit | SetPosition (HPS.Point in_position) |
Sets the position of the text in object space. More... | |
HPS.TextKit | SetPreference (HPS.Text.Preference in_pref) |
Sets the font type preference for the text. More... | |
HPS.TextKit | SetPreference (float in_cutoff, HPS.Text.SizeUnits in_units, HPS.Text.Preference in_smaller, HPS.Text.Preference in_larger) |
Sets the preference for the text. More... | |
HPS.TextKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the TextKit. More... | |
HPS.TextKit | SetRegion (HPS.Point[] in_region, HPS.Text.RegionAlignment in_region_alignment, bool in_region_fitting, bool in_region_adjust_direction, bool in_region_relative_coordinates, bool in_region_window_space) |
Sets the region for the text. More... | |
HPS.TextKit | SetRenderer (HPS.Text.Renderer in_rend) |
Sets the renderer for the text. More... | |
HPS.TextKit | SetRotation (HPS.Text.Rotation in_state, float in_angle) |
Sets the angle characters should be rotated within the text string. More... | |
HPS.TextKit | SetRotation (HPS.Text.Rotation in_state) |
Sets the angle characters should be rotated within the text string. More... | |
HPS.TextKit | SetRotation (float in_angle) |
Sets the angle characters should be rotated within the text string. More... | |
HPS.TextKit | SetSize (float in_size, HPS.Text.SizeUnits in_units) |
Sets the font size to use for the text. More... | |
HPS.TextKit | SetSizeTolerance (bool in_state, float in_size, HPS.Text.SizeToleranceUnits in_units) |
Sets the size tolerance settings to use for the text. More... | |
HPS.TextKit | SetSizeTolerance (bool in_state, float in_size) |
Sets the size tolerance settings to use for the text. More... | |
HPS.TextKit | SetSizeTolerance (bool in_state) |
Sets the size tolerance settings to use for the text. More... | |
HPS.TextKit | SetSizeTolerance (float in_size, HPS.Text.SizeToleranceUnits in_units) |
Sets the size tolerance settings to use for the text. More... | |
HPS.TextKit | SetSlant (float in_angle) |
Sets the slant angle for the text. More... | |
HPS.TextKit | SetSpacing (float in_multiplier) |
Sets the spacing multiplier for the text. More... | |
HPS.TextKit | SetStrikethrough (bool in_state) |
Sets whether a strikethrough should be drawn through the text. More... | |
HPS.TextKit | SetText (string in_string) |
Sets the contents of the string for the text. More... | |
HPS.TextKit | SetTransform (HPS.Text.Transform in_trans) |
Sets the transform behavior for the text. More... | |
HPS.TextKit | SetUnderline (bool in_state) |
Sets whether an underline should be drawn under the text. More... | |
HPS.TextKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.TextKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.TextKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.TextKit out_kit) |
Copies this TextKit into the given TextKit. More... | |
bool | ShowAlignment (out HPS.Text.Alignment out_alignment, out HPS.Text.ReferenceFrame out_reference_frame, out HPS.Text.Justification out_justification) |
Shows the aligment for the text. More... | |
bool | ShowBold (out bool out_state) |
Shows whether the text should be bold. More... | |
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index) |
Shows the color for the text. More... | |
bool | ShowExtraSpace (out bool out_state, out float out_size, out HPS.Text.SizeUnits out_units) |
Shows the amount of additional space to add between characters in a text string. More... | |
bool | ShowFont (out string out_name) |
Shows the font to use for the text. More... | |
bool | ShowGreeking (out bool out_state, out float out_size, out HPS.Text.GreekingUnits out_units, out HPS.Text.GreekingMode out_mode) |
Shows the greeking settings to use for the text. More... | |
bool | ShowItalic (out bool out_state) |
Shows whether the text should be italic. More... | |
bool | ShowLineSpacing (out float out_multiplier) |
Shows the line spacing multiplier for the text. More... | |
bool | ShowModellingMatrix (out HPS.MatrixKit out_matrix) |
Shows the modelling matrix for the text. More... | |
bool | ShowOverline (out bool out_state) |
Shows whether an overline should be drawn over the text. More... | |
bool | ShowPath (out HPS.Vector out_path) |
Shows the path for the text. More... | |
bool | ShowPosition (out HPS.Point out_position) |
Shows the position for the text. More... | |
bool | ShowPreference (out float out_cutoff, out HPS.Text.SizeUnits out_units, out HPS.Text.Preference out_smaller, out HPS.Text.Preference out_larger) |
Shows the preference for the text. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowRegion (out HPS.Point[] out_region, out HPS.Text.RegionAlignment out_region_alignment, out bool out_region_fitting, out bool out_region_adjust_direction, out bool out_region_relative_coordinates, out bool out_region_window_space) |
Shows the region for the text. More... | |
bool | ShowRenderer (out HPS.Text.Renderer out_renderer) |
Shows the renderer for the text. More... | |
bool | ShowRotation (out HPS.Text.Rotation out_rot, out float out_angle) |
Shows the angle characters should be rotated within the text string. More... | |
bool | ShowSize (out float out_size, out HPS.Text.SizeUnits out_units) |
Shows the font size to use for the text. More... | |
bool | ShowSizeTolerance (out bool out_state, out float out_size, out HPS.Text.SizeToleranceUnits out_units) |
Shows the size tolerance settings to use for the text. More... | |
bool | ShowSlant (out float out_angle) |
Shows the slant angle for the text. More... | |
bool | ShowSpacing (out float out_multiplier) |
Shows the spacing multiplier for the text. More... | |
bool | ShowStrikethrough (out bool out_state) |
Shows whether a strikethrough should be drawn through the text. More... | |
bool | ShowText (out string out_string) |
Shows the string for the text. More... | |
bool | ShowTransform (out HPS.Text.Transform out_trans) |
Shows the transform state for the text. More... | |
bool | ShowUnderline (out bool out_state) |
Shows whether an underline should be drawn under the text. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this kit. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this kit. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this kit. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this kit. More... | |
TextKit () | |
The default constructor creates an empty TextKit object. More... | |
TextKit (HPS.TextKit in_kit) | |
The copy constructor creates a new TextKit object that contains the same settings as the source TextKit. More... | |
HPS.TextKit | UnsetAlignment () |
Removes the alignment setting from the text. More... | |
HPS.TextKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.TextKit | UnsetBold () |
Removes the bold setting from the text. More... | |
HPS.TextKit | UnsetColor () |
Removes the color (RGBA or material index) from the text. More... | |
HPS.TextKit | UnsetEverything () |
Removes all settings from this TextKit. More... | |
HPS.TextKit | UnsetExtraSpace () |
Removes the extra space setting from the text. More... | |
HPS.TextKit | UnsetFont () |
Removes the font setting from the text. More... | |
HPS.TextKit | UnsetGreeking () |
Removes the greeking settings from the text. More... | |
HPS.TextKit | UnsetItalic () |
Removes the italic setting from the text. More... | |
HPS.TextKit | UnsetLineSpacing () |
Removes the line spacing setting from the text. More... | |
HPS.TextKit | UnsetModellingMatrix () |
Removes the modelling matrix from the text. More... | |
HPS.TextKit | UnsetOverline () |
Removes the overline setting from the text. More... | |
HPS.TextKit | UnsetPath () |
Removes the path from the text. More... | |
HPS.TextKit | UnsetPosition () |
Removes the text position. More... | |
HPS.TextKit | UnsetPreference () |
Removes the font type preference from the text. More... | |
HPS.TextKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.TextKit | UnsetRegion () |
Removes the region setting from the text. More... | |
HPS.TextKit | UnsetRenderer () |
Removes the renderer setting from the text. More... | |
HPS.TextKit | UnsetRotation () |
Removes the rotation setting from the text. More... | |
HPS.TextKit | UnsetSize () |
Removes the size setting from the text. More... | |
HPS.TextKit | UnsetSizeTolerance () |
Removes the size tolerance setting from the text. More... | |
HPS.TextKit | UnsetSlant () |
Removes the slant setting from the text. More... | |
HPS.TextKit | UnsetSpacing () |
Removes the spacing setting from the text. More... | |
HPS.TextKit | UnsetStrikethrough () |
Removes the strikethrough setting from the text. More... | |
HPS.TextKit | UnsetText () |
Removes the text string. More... | |
HPS.TextKit | UnsetTransform () |
Removes the transform setting from the text. More... | |
HPS.TextKit | UnsetUnderline () |
Removes the underline setting from the text. More... | |
HPS.TextKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.TextKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.TextKit a, HPS.TextKit b) |
static bool | operator== (HPS.TextKit a, HPS.TextKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
HPS.TextKit.TextKit | ( | ) |
The default constructor creates an empty TextKit object.
HPS.TextKit.TextKit | ( | HPS.TextKit | in_kit | ) |
void HPS.TextKit.Consume | ( | HPS.TextKit | in_kit | ) |
HPS.TextKit HPS.TextKit.EditTextByDeletion | ( | ulong | in_row, |
ulong | in_column, | ||
ulong | in_count | ||
) |
Removes characters from the text at the specified offset.
in_row | The row offset into a multiline text string. This value must be less than the number of lines in the text string. |
in_column | The 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_count | The number of Unicode code points within the given text string to remove. |
HPS.TextKit HPS.TextKit.EditTextByInsertion | ( | ulong | in_row, |
ulong | in_column, | ||
ulong | in_count, | ||
string | in_text | ||
) |
Adds characters to the text at the specified offset.
in_row | The row offset into a multiline text string. This value must be less than the number of lines in the text string. |
in_column | The 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_count | The number of Unicode code points within the given text string to insert into the text. |
in_text | UTF8-encoded text to insert into the text. This must contain at least in_count Unicode code points. |
HPS.TextKit HPS.TextKit.EditTextByReplacement | ( | ulong | in_row, |
ulong | in_column, | ||
ulong | in_count, | ||
string | in_text | ||
) |
Replaces characters from the text at the specified offset.
in_row | The row offset into a multiline text string. This value must be less than the number of lines in the text string. |
in_column | The 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_count | The number of Unicode code points within the given text string to remove. |
|
virtual |
Indicates whether this TextKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.TextKit.Equals | ( | HPS.TextKit | in_kit | ) |
Check if the source TextKit is equivalent to this TextKit.
in_kit | The source <ref refid="class_h_p_s_1_1_text_kit" kindref="compound">TextKit</ref> to compare to this <ref refid="class_h_p_s_1_1_text_kit" kindref="compound">TextKit</ref>. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.TextKit.Set | ( | HPS.TextKit | in_kit | ) |
HPS.TextKit HPS.TextKit.SetAlignment | ( | HPS.Text.Alignment | in_alignment, |
HPS.Text.ReferenceFrame | in_reference_frame, | ||
HPS.Text.Justification | in_justification | ||
) |
Sets the alignment for the text.
in_alignment | The alignment for the text. |
in_reference_frame | The reference frame for the text. Defaults to <ref refid="class_h_p_s_1_1_text_1abd28ea8a54c1c456573cf11cfa8a3fc6a637abbad09c25566da0f7ccf9aa3a11e" kindref="member">Text::ReferenceFrame::WorldAligned</ref>. |
in_justification | The justification for the text. Defaults to <ref refid="class_h_p_s_1_1_text_1a28dbb0f621add4aec04d25ea1fa419a4a8c1c4189f7585d1594863b4e37a08b12" kindref="member">Text::Justification::LeftJustified</ref>. |
HPS.TextKit HPS.TextKit.SetAlignment | ( | HPS.Text.Alignment | in_alignment, |
HPS.Text.ReferenceFrame | in_reference_frame | ||
) |
Sets the alignment for the text.
in_alignment | The alignment for the text. |
in_reference_frame | The reference frame for the text. Defaults to <ref refid="class_h_p_s_1_1_text_1abd28ea8a54c1c456573cf11cfa8a3fc6a637abbad09c25566da0f7ccf9aa3a11e" kindref="member">Text::ReferenceFrame::WorldAligned</ref>. |
HPS.TextKit HPS.TextKit.SetAlignment | ( | HPS.Text.Alignment | in_alignment | ) |
Sets the alignment for the text.
in_alignment | The alignment for the text. |
HPS.TextKit HPS.TextKit.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.
in_state | Whether the text should be bold. |
HPS.TextKit HPS.TextKit.SetColor | ( | HPS.RGBAColor | in_rgba_color | ) |
Sets the RGBA color of the text.
in_rgba_color | The RGBA color of the text. |
HPS.TextKit HPS.TextKit.SetColorByIndex | ( | float | in_index | ) |
Sets the material index color for the text.
in_index | The material index color for the text. |
HPS.TextKit HPS.TextKit.SetExtraSpace | ( | bool | in_state, |
float | in_size, | ||
HPS.Text.SizeUnits | in_units | ||
) |
Sets the amount of additional space to add between characters in a text string.
in_state | Whether to add addtional space between characters in a text string. |
in_size | The size of the addtional space to add between characters. Defaults to 0.0f. |
in_units | The units of the size of the additional space to add between characters. Defaults to <ref refid="class_h_p_s_1_1_text_1a6c8c5195a51732a2f502012b9ce2f849aee691325995b67cdd70b3f1946442523" kindref="member">Text::SizeUnits::ObjectSpace</ref>. |
HPS.TextKit HPS.TextKit.SetExtraSpace | ( | bool | in_state, |
float | in_size | ||
) |
Sets the amount of additional space to add between characters in a text string.
in_state | Whether to add addtional space between characters in a text string. |
in_size | The size of the addtional space to add between characters. Defaults to 0.0f. |
HPS.TextKit HPS.TextKit.SetExtraSpace | ( | bool | in_state | ) |
Sets the amount of additional space to add between characters in a text string.
in_state | Whether to add addtional space between characters in a text string. |
HPS.TextKit HPS.TextKit.SetExtraSpace | ( | float | in_size, |
HPS.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.
in_size | The size of the addtional space to add between characters. |
in_units | The units of the size of the additional space to add between characters. |
HPS.TextKit HPS.TextKit.SetFont | ( | string | 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.
in_name | UTF8-encoded font name to use for the text. |
HPS.TextKit HPS.TextKit.SetGreeking | ( | bool | in_state, |
float | in_size, | ||
HPS.Text.GreekingUnits | in_units, | ||
HPS.Text.GreekingMode | in_mode | ||
) |
Sets the greeking settings to use for the text.
in_state | Whether greeking is enabled for this text. |
in_size | The size below which to draw a simple symbol in place of a character. Defaults to 0.0f. |
in_units | The units of the size below which to draw a simple glyph in place of a character. Defaults to <ref refid="class_h_p_s_1_1_text_1aab471ab51f62767b561a48ce770718fdaee691325995b67cdd70b3f1946442523" kindref="member">Text::GreekingUnits::ObjectSpace</ref>. |
in_mode | The type of symbol to draw for characters which are smaller than the greeking size. Defaults to <ref refid="class_h_p_s_1_1_text_1a0cdab239a3c363270d2a9cc95c734688aa0b0293a2db49f5f93c15a62e095c819" kindref="member">Text::GreekingMode::Lines</ref>. |
HPS.TextKit HPS.TextKit.SetGreeking | ( | bool | in_state, |
float | in_size, | ||
HPS.Text.GreekingUnits | in_units | ||
) |
Sets the greeking settings to use for the text.
in_state | Whether greeking is enabled for this text. |
in_size | The size below which to draw a simple symbol in place of a character. Defaults to 0.0f. |
in_units | The units of the size below which to draw a simple glyph in place of a character. Defaults to <ref refid="class_h_p_s_1_1_text_1aab471ab51f62767b561a48ce770718fdaee691325995b67cdd70b3f1946442523" kindref="member">Text::GreekingUnits::ObjectSpace</ref>. |
HPS.TextKit HPS.TextKit.SetGreeking | ( | bool | in_state, |
float | in_size | ||
) |
Sets the greeking settings to use for the text.
in_state | Whether greeking is enabled for this text. |
in_size | The size below which to draw a simple symbol in place of a character. Defaults to 0.0f. |
HPS.TextKit HPS.TextKit.SetGreeking | ( | bool | in_state | ) |
Sets the greeking settings to use for the text.
in_state | Whether greeking is enabled for this text. |
HPS.TextKit HPS.TextKit.SetGreeking | ( | float | in_size, |
HPS.Text.GreekingUnits | in_units, | ||
HPS.Text.GreekingMode | in_mode | ||
) |
Sets the greeking settings to use for the text.
This function implicitly enables text greeking.
in_size | The size below which to draw a simple symbol in place of a character. |
in_units | The units of the size below which to draw a simple glyph in place of a character. |
in_mode | The type of symbol to draw for characters which are smaller than the greeking size. Defaults to Text::Gree::Lines. |
HPS.TextKit HPS.TextKit.SetGreeking | ( | float | in_size, |
HPS.Text.GreekingUnits | in_units | ||
) |
Sets the greeking settings to use for the text.
This function implicitly enables text greeking.
in_size | The size below which to draw a simple symbol in place of a character. |
in_units | The units of the size below which to draw a simple glyph in place of a character. |
HPS.TextKit HPS.TextKit.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.
in_state | Whether the text should be italic. |
HPS.TextKit HPS.TextKit.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.
in_multiplier | The line spacing multiplier for the text. |
HPS.TextKit HPS.TextKit.SetModellingMatrix | ( | HPS.MatrixKit | in_matrix | ) |
Sets the modelling matrix for the text.
in_matrix | The modelling matrix for the text. |
HPS.TextKit HPS.TextKit.SetOverline | ( | bool | in_state | ) |
Sets whether an overline should be drawn over the text.
in_state | Whether an overline should be drawn over the text. |
HPS.TextKit HPS.TextKit.SetPath | ( | HPS.Vector | in_path | ) |
Sets the path for the text.
This setting controls the vector along which a text string will be displayed.
in_path | The path for the text. |
HPS.TextKit HPS.TextKit.SetPosition | ( | HPS.Point | in_position | ) |
Sets the position of the text in object space.
The object-space position for the text.
HPS.TextKit HPS.TextKit.SetPreference | ( | HPS.Text.Preference | in_pref | ) |
Sets the font type preference for the text.
This function implicitly sets the same font type for all text sizes.
HPS.TextKit HPS.TextKit.SetPreference | ( | float | in_cutoff, |
HPS.Text.SizeUnits | in_units, | ||
HPS.Text.Preference | in_smaller, | ||
HPS.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.
in_cutoff | The font size below which the smaller preference is used and above which the larger preference is used. |
in_units | The units for the font size below which the smaller preference is used and above which the larger preference is used. |
in_smaller | The font type preference for strings below the cutoff size. |
in_larger | The font type preference for strings above the cutoff size. |
HPS.TextKit HPS.TextKit.SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the TextKit.
It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
HPS.TextKit HPS.TextKit.SetRegion | ( | HPS.Point[] | in_region, |
HPS.Text.RegionAlignment | in_region_alignment, | ||
bool | 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.
in_region_count | Size 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_region | The points defining the region for the text. |
in_region_alignment | How the text will be positioned relative to the region line. |
in_region_fitting | Whether characters should be streched or overlapping to fit within the end points of the region line. |
in_region_adjust_direction | Whether to draw text such that it is readable regardless of camera location. |
in_region_relative_coordinates | Whether the points defining the region are relative to the insertion point for the text. |
in_region_window_space | Whether the points defining the region are in window space coordinates. |
SetPath
HPS.TextKit HPS.TextKit.SetRenderer | ( | HPS.Text.Renderer | in_rend | ) |
Sets the renderer for the text.
HPS.TextKit HPS.TextKit.SetRotation | ( | HPS.Text.Rotation | in_state, |
float | in_angle | ||
) |
Sets the angle characters should be rotated within the text string.
in_state | Whether and how to rotate the characters within the text string. |
in_angle | The angle in degrees to rotate each character within the text string. This is only relevant if in_state is <ref refid="class_h_p_s_1_1_text_1af7d3ca00dd1173d8b8db7e1ba23dbda0a8d2de5368588552fbae54044ac5c7b3d" kindref="member">Text::Rotation::Rotate</ref>. Defaults to 0.0f. |
HPS.TextKit HPS.TextKit.SetRotation | ( | HPS.Text.Rotation | in_state | ) |
Sets the angle characters should be rotated within the text string.
in_state | Whether and how to rotate the characters within the text string. |
HPS.TextKit HPS.TextKit.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.
in_angle | The angle in degrees to rotate each character within the text string. |
HPS.TextKit HPS.TextKit.SetSize | ( | float | in_size, |
HPS.Text.SizeUnits | in_units | ||
) |
Sets the font size to use for the text.
in_size | The size for the text. |
in_units | The units of the size for the text. |
HPS.TextKit HPS.TextKit.SetSizeTolerance | ( | bool | in_state, |
float | in_size, | ||
HPS.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.
in_state | Whether a size tolerance is enabled for this text. |
in_size | The size for the tolerance. Defaults to 50.0f. |
in_units | The units of the size for the tolerance. Defaults to <ref refid="class_h_p_s_1_1_text_1a863f435cfa84e75d30a3295b3c8442deaadaaee4b22041c27198d410c68d952c9" kindref="member">Text::SizeToleranceUnits::Percent</ref>. |
HPS.TextKit HPS.TextKit.SetSizeTolerance | ( | bool | in_state, |
float | in_size | ||
) |
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.
in_state | Whether a size tolerance is enabled for this text. |
in_size | The size for the tolerance. Defaults to 50.0f. |
HPS.TextKit HPS.TextKit.SetSizeTolerance | ( | bool | in_state | ) |
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.
in_state | Whether a size tolerance is enabled for this text. |
HPS.TextKit HPS.TextKit.SetSizeTolerance | ( | float | in_size, |
HPS.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.
in_size | The size for the tolerance. |
in_units | The units of the size for the tolerance. |
HPS.TextKit HPS.TextKit.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.
in_angle | The angle in degrees to slant the text. This value must be in the range [-75.0f,+75.0f]. |
HPS.TextKit HPS.TextKit.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.
in_multiplier | The spacing multiplier for the text. |
HPS.TextKit HPS.TextKit.SetStrikethrough | ( | bool | in_state | ) |
Sets whether a strikethrough should be drawn through the text.
in_state | Whether a strikethrough should be drawn through the text. |
HPS.TextKit HPS.TextKit.SetText | ( | string | in_string | ) |
Sets the contents of the string for the text.
in_string | UTF8-encoded string for the text. |
HPS.TextKit HPS.TextKit.SetTransform | ( | HPS.Text.Transform | in_trans | ) |
Sets the transform behavior for the text.
HPS.TextKit HPS.TextKit.SetUnderline | ( | bool | in_state | ) |
Sets whether an underline should be drawn under the text.
in_state | Whether an underline should be drawn under the text. |
HPS.TextKit HPS.TextKit.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_bytes | The number of bytes of user data to set. |
in_data | The bytes of user data to set. |
HPS.TextKit HPS.TextKit.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
HPS.TextKit HPS.TextKit.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this kit.
in_data | An array of bytes of user data to set. |
void HPS.TextKit.Show | ( | out HPS.TextKit | out_kit | ) |
bool HPS.TextKit.ShowAlignment | ( | out HPS.Text.Alignment | out_alignment, |
out HPS.Text.ReferenceFrame | out_reference_frame, | ||
out HPS.Text.Justification | out_justification | ||
) |
Shows the aligment for the text.
out_alignment | The alignment for the text. |
out_reference_frame | The reference frame for the text. |
out_justification | The justification for the text. |
bool HPS.TextKit.ShowBold | ( | out bool | out_state | ) |
Shows whether the text should be bold.
out_state | Whether the text should be bold. |
bool HPS.TextKit.ShowColor | ( | out HPS.Material.Type | out_type, |
out HPS.RGBAColor | out_rgba_color, | ||
out float | out_index | ||
) |
Shows the color for the text.
out_type | The type of color for the text. |
out_rgba_color | The RGBA color for the text. This is only valid if out_type is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da5769501214f669cb063fd410bb5eb822" kindref="member">Material::Type::ExplicitRGBAColor</ref>. |
out_index | The material index for the text. This is only valid if out_type is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>. |
bool HPS.TextKit.ShowExtraSpace | ( | out bool | out_state, |
out float | out_size, | ||
out HPS.Text.SizeUnits | out_units | ||
) |
Shows the amount of additional space to add between characters in a text string.
out_state | Whether to add addtional space between characters in a text string. |
out_size | The size of the addtional space to add between characters. |
out_units | The units of the size of the additional space to add between characters. |
bool HPS.TextKit.ShowFont | ( | out string | out_name | ) |
Shows the font to use for the text.
out_name | UTF8-encoded font name to use for the text. |
bool HPS.TextKit.ShowGreeking | ( | out bool | out_state, |
out float | out_size, | ||
out HPS.Text.GreekingUnits | out_units, | ||
out HPS.Text.GreekingMode | out_mode | ||
) |
Shows the greeking settings to use for the text.
out_state | Whether greeking is enabled for this text. |
out_size | The size below which to draw a simple symbol in place of a character. |
out_units | The units of the size below which to draw a simple glyph in place of a character. |
out_mode | The type of symbol to draw for characters which are smaller than the greeking size. |
bool HPS.TextKit.ShowItalic | ( | out bool | out_state | ) |
Shows whether the text should be italic.
out_state | Whether the text should be italic. |
bool HPS.TextKit.ShowLineSpacing | ( | out float | out_multiplier | ) |
Shows the line spacing multiplier for the text.
out_multiplier | The line spacing multiplier for the text. |
bool HPS.TextKit.ShowModellingMatrix | ( | out HPS.MatrixKit | out_matrix | ) |
Shows the modelling matrix for the text.
out_matrix | The modelling matrix for the text. |
bool HPS.TextKit.ShowOverline | ( | out bool | out_state | ) |
Shows whether an overline should be drawn over the text.
out_state | Whether an overline should be drawn over the text. |
bool HPS.TextKit.ShowPath | ( | out HPS.Vector | out_path | ) |
Shows the path for the text.
out_path | The path for the text. |
bool HPS.TextKit.ShowPosition | ( | out HPS.Point | out_position | ) |
Shows the position for the text.
out_position | The object-space position for the text. |
bool HPS.TextKit.ShowPreference | ( | out float | out_cutoff, |
out HPS.Text.SizeUnits | out_units, | ||
out HPS.Text.Preference | out_smaller, | ||
out HPS.Text.Preference | out_larger | ||
) |
Shows the preference for the text.
out_cutoff | The font size below which the smaller preference is used and above which the larger preference is used. |
out_units | The units for the font size below which the smaller preference is used and above which the larger preference is used. |
out_smaller | The font type preference for strings below the cutoff size. |
out_larger | The font type preference for strings above the cutoff size. |
bool HPS.TextKit.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS.TextKit.ShowRegion | ( | out HPS.Point[] | out_region, |
out HPS.Text.RegionAlignment | out_region_alignment, | ||
out bool | out_region_fitting, | ||
out bool | out_region_adjust_direction, | ||
out bool | out_region_relative_coordinates, | ||
out bool | out_region_window_space | ||
) |
Shows the region for the text.
out_region | The points defining the region for the text. |
out_region_alignment | How the text will be positioned relative to the region line. |
out_region_fitting | Whether characters should be streched or overlapping to fit within the end points of the region line. |
out_region_adjust_direction | Whether to draw text such that it is readable regardless of camera location. |
out_region_relative_coordinates | Whether the points defining the region are relative to the insertion point for the text. |
out_region_window_space | Whether the points defining the region are in window space coordinates. |
bool HPS.TextKit.ShowRenderer | ( | out HPS.Text.Renderer | out_renderer | ) |
Shows the renderer for the text.
bool HPS.TextKit.ShowRotation | ( | out HPS.Text.Rotation | out_rot, |
out float | out_angle | ||
) |
Shows the angle characters should be rotated within the text string.
out_angle | The angle in degrees to rotate each character within the text string. |
bool HPS.TextKit.ShowSize | ( | out float | out_size, |
out HPS.Text.SizeUnits | out_units | ||
) |
Shows the font size to use for the text.
out_size | The size for the text. |
out_units | The units of the size for the text. |
bool HPS.TextKit.ShowSizeTolerance | ( | out bool | out_state, |
out float | out_size, | ||
out HPS.Text.SizeToleranceUnits | out_units | ||
) |
Shows the size tolerance settings to use for the text.
out_state | Whether a size tolerance is enabled for this text. |
out_size | The size for the tolerance. |
out_units | The units of the size for the tolerance. |
bool HPS.TextKit.ShowSlant | ( | out float | out_angle | ) |
Shows the slant angle for the text.
out_angle | The angle in degrees to slant the text. |
bool HPS.TextKit.ShowSpacing | ( | out float | out_multiplier | ) |
Shows the spacing multiplier for the text.
out_multiplier | The spacing multiplier for the text. |
bool HPS.TextKit.ShowStrikethrough | ( | out bool | out_state | ) |
Shows whether a strikethrough should be drawn through the text.
out_state | Whether a strikethrough should be drawn through the text. |
bool HPS.TextKit.ShowText | ( | out string | out_string | ) |
Shows the string for the text.
out_string | UTF8-encoded string for the text. |
bool HPS.TextKit.ShowTransform | ( | out HPS.Text.Transform | out_trans | ) |
Shows the transform state for the text.
bool HPS.TextKit.ShowUnderline | ( | out bool | out_state | ) |
Shows whether an underline should be drawn under the text.
out_state | Whether an underline should be drawn under the text. |
bool HPS.TextKit.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool HPS.TextKit.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
ulong HPS.TextKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.TextKit.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
HPS.TextKit HPS.TextKit.UnsetAlignment | ( | ) |
Removes the alignment setting from the text.
HPS.TextKit HPS.TextKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.TextKit HPS.TextKit.UnsetBold | ( | ) |
Removes the bold setting from the text.
HPS.TextKit HPS.TextKit.UnsetColor | ( | ) |
Removes the color (RGBA or material index) from the text.
HPS.TextKit HPS.TextKit.UnsetEverything | ( | ) |
HPS.TextKit HPS.TextKit.UnsetExtraSpace | ( | ) |
Removes the extra space setting from the text.
HPS.TextKit HPS.TextKit.UnsetFont | ( | ) |
Removes the font setting from the text.
HPS.TextKit HPS.TextKit.UnsetGreeking | ( | ) |
Removes the greeking settings from the text.
HPS.TextKit HPS.TextKit.UnsetItalic | ( | ) |
Removes the italic setting from the text.
HPS.TextKit HPS.TextKit.UnsetLineSpacing | ( | ) |
Removes the line spacing setting from the text.
HPS.TextKit HPS.TextKit.UnsetModellingMatrix | ( | ) |
Removes the modelling matrix from the text.
HPS.TextKit HPS.TextKit.UnsetOverline | ( | ) |
Removes the overline setting from the text.
HPS.TextKit HPS.TextKit.UnsetPath | ( | ) |
Removes the path from the text.
HPS.TextKit HPS.TextKit.UnsetPosition | ( | ) |
Removes the text position.
HPS.TextKit HPS.TextKit.UnsetPreference | ( | ) |
Removes the font type preference from the text.
HPS.TextKit HPS.TextKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.TextKit HPS.TextKit.UnsetRegion | ( | ) |
Removes the region setting from the text.
HPS.TextKit HPS.TextKit.UnsetRenderer | ( | ) |
Removes the renderer setting from the text.
HPS.TextKit HPS.TextKit.UnsetRotation | ( | ) |
Removes the rotation setting from the text.
HPS.TextKit HPS.TextKit.UnsetSize | ( | ) |
Removes the size setting from the text.
HPS.TextKit HPS.TextKit.UnsetSizeTolerance | ( | ) |
Removes the size tolerance setting from the text.
HPS.TextKit HPS.TextKit.UnsetSlant | ( | ) |
Removes the slant setting from the text.
HPS.TextKit HPS.TextKit.UnsetSpacing | ( | ) |
Removes the spacing setting from the text.
HPS.TextKit HPS.TextKit.UnsetStrikethrough | ( | ) |
Removes the strikethrough setting from the text.
HPS.TextKit HPS.TextKit.UnsetText | ( | ) |
Removes the text string.
HPS.TextKit HPS.TextKit.UnsetTransform | ( | ) |
Removes the transform setting from the text.
HPS.TextKit HPS.TextKit.UnsetUnderline | ( | ) |
Removes the underline setting from the text.
HPS.TextKit HPS.TextKit.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
HPS.TextKit HPS.TextKit.UnsetUserData | ( | IntPtr[] | in_indices | ) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |