The TextKey class is a smart pointer to a database object. It is a handle to text inserted via SegmentKey::InsertText. More...
Public Member Functions | |
override void | Dispose () |
TextKey () | |
The default constructor creates an uninitialized TextKey object. The Type() function will return Type::None. More... | |
TextKey (HPS.Key in_that) | |
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. More... | |
TextKey (HPS.TextKey in_that) | |
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. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Consume (HPS.TextKit in_kit) |
Completely replaces all settings on this TextKey with those set on the specified kit and resets the kit. More... | |
void | Set (HPS.TextKit in_kit) |
Replace those settings on this TextKey with those set on the specified kit. More... | |
void | Show (out HPS.TextKit out_kit) |
Copy the contents of this TextKey into the specified kit. More... | |
HPS.TextKey | SetTextAttributes (HPS.TextAttributeKit in_kit) |
Sets the text attributes designated by in_kit on this TextKey. More... | |
bool | ShowTextAttributes (out HPS.TextAttributeKit out_kit) |
Sets the text attributes designated by in_kit on this TextKey. More... | |
HPS.TextKey | SetPosition (HPS.Point in_position) |
Repositions the text in object space. The object-space position for the text. More... | |
HPS.TextKey | SetText (string in_string) |
Replaces the contents of the string for the text. More... | |
HPS.TextKey | SetColor (HPS.RGBAColor in_rgba_color) |
Sets the RGBA color of the text. No color is set on the text by default. More... | |
HPS.TextKey | SetColorByIndex (float in_index) |
Sets the material index color for the text. No color is set on the text by default. More... | |
HPS.TextKey | SetModellingMatrix (HPS.MatrixKit in_matrix) |
Sets the modelling matrix for the text. No modelling matrix is set on the text by default. More... | |
HPS.TextKey | SetAlignment (HPS.Text.Alignment in_alignment, HPS.Text.ReferenceFrame in_reference_frame, HPS.Text.Justification in_justification) |
Sets the alignment for the text. No aligment is set on the text by default. More... | |
HPS.TextKey | SetAlignment (HPS.Text.Alignment in_alignment, HPS.Text.ReferenceFrame in_reference_frame) |
Sets the alignment for the text. No aligment is set on the text by default. More... | |
HPS.TextKey | SetAlignment (HPS.Text.Alignment in_alignment) |
Sets the alignment for the text. No aligment is set on the text by default. More... | |
HPS.TextKey | SetBold (bool in_state) |
Sets whether the text should be bold. For fonts which do not have a bold variant, this setting will be ignored. No bold setting is set on the text by default. More... | |
HPS.TextKey | SetItalic (bool in_state) |
Sets whether the text should be italic. For fonts which do not have an italic variant, this setting will be ignored. No italic setting is set on the text by default. More... | |
HPS.TextKey | SetOverline (bool in_state) |
Sets whether an overline should be drawn over the text. No overline setting is set on the text by default. More... | |
HPS.TextKey | SetStrikethrough (bool in_state) |
Sets whether a strikethrough should be drawn through the text. No strikethrough setting is set on the text by default. More... | |
HPS.TextKey | SetUnderline (bool in_state) |
Sets whether an underline should be drawn under the text. No underline setting is set on the text by default. More... | |
HPS.TextKey | SetSlant (float in_angle) |
Sets the slant angle for the text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular. No slant angle is set on the text by default. More... | |
HPS.TextKey | SetLineSpacing (float in_multiplier) |
Sets the line spacing multiplier for the text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string. No line spacing is set on the text by default. More... | |
HPS.TextKey | SetRotation (HPS.Text.Rotation in_state, float in_angle) |
Sets the angle characters should be rotated within the text string. No rotation is set on the text by default. More... | |
HPS.TextKey | SetRotation (HPS.Text.Rotation in_state) |
Sets the angle characters should be rotated within the text string. No rotation is set on the text by default. More... | |
HPS.TextKey | SetRotation (float in_angle) |
Sets the angle characters should be rotated within the text string. This function implicitly sets a rotation state of Text::Rotation::Rotate. No rotation is set on the text by default. More... | |
HPS.TextKey | 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. No extra space is set on the text by default. More... | |
HPS.TextKey | SetExtraSpace (bool in_state, float in_size) |
Sets the amount of additional space to add between characters in a text string. No extra space is set on the text by default. More... | |
HPS.TextKey | SetExtraSpace (bool in_state) |
Sets the amount of additional space to add between characters in a text string. No extra space is set on the text by default. More... | |
HPS.TextKey | 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. No extra space is set on the text by default. More... | |
HPS.TextKey | 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. No greeking settings are set on the text by default. More... | |
HPS.TextKey | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default. More... | |
HPS.TextKey | SetGreeking (bool in_state, float in_size) |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default. More... | |
HPS.TextKey | SetGreeking (bool in_state) |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default. More... | |
HPS.TextKey | 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. No greeking settings are set on the text by default. More... | |
HPS.TextKey | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units) |
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. More... | |
HPS.TextKey | 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. No size tolerance is set on the text by default. More... | |
HPS.TextKey | 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. No size tolerance is set on the text by default. More... | |
HPS.TextKey | 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. No size tolerance is set on the text by default. More... | |
HPS.TextKey | 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. No size tolerance is set on the text by default. More... | |
HPS.TextKey | SetSize (float in_size, HPS.Text.SizeUnits in_units) |
Sets the font size to use for the text. No size is set on the text by default. More... | |
HPS.TextKey | 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. No font is set on the text by default. More... | |
HPS.TextKey | SetTransform (HPS.Text.Transform in_transform) |
Sets the transform state for the text. No transform state is set on the text by default. More... | |
HPS.TextKey | SetRenderer (HPS.Text.Renderer in_renderer) |
Sets the renderer for the text. No renderer is set on the text by default. More... | |
HPS.TextKey | SetPreference (HPS.Text.Preference in_preference) |
Sets the font type preference for the text. This function implicitly sets the same font type for all text sizes. No preference is set on the text by default. More... | |
HPS.TextKey | 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. No preference is set on the text by default. More... | |
HPS.TextKey | SetPath (HPS.Vector in_path) |
Sets the path for the text. This setting controls the vector along which a text string will be displayed. No path is set on the text by default. More... | |
HPS.TextKey | SetSpacing (float in_multiplier) |
Sets the spacing multiplier for the text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on. More... | |
HPS.TextKey | 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. More... | |
HPS.TextKey | UnsetColor () |
Removes the color (RGBA or material index) from the text. More... | |
HPS.TextKey | UnsetModellingMatrix () |
Removes the modelling matrix from the text. More... | |
HPS.TextKey | UnsetAlignment () |
Removes the alignment setting from the text. More... | |
HPS.TextKey | UnsetBold () |
Removes the bold setting from the text. More... | |
HPS.TextKey | UnsetItalic () |
Removes the italic setting from the text. More... | |
HPS.TextKey | UnsetOverline () |
Removes the overline setting from the text. More... | |
HPS.TextKey | UnsetStrikethrough () |
Removes the strikethrough setting from the text. More... | |
HPS.TextKey | UnsetUnderline () |
Removes the underline setting from the text. More... | |
HPS.TextKey | UnsetSlant () |
Removes the slant setting from the text. More... | |
HPS.TextKey | UnsetLineSpacing () |
Removes the line spacing setting from the text. More... | |
HPS.TextKey | UnsetRotation () |
Removes the rotation setting from the text. More... | |
HPS.TextKey | UnsetExtraSpace () |
Removes the extra space setting from the text. More... | |
HPS.TextKey | UnsetGreeking () |
Removes the greeking settings from the text. More... | |
HPS.TextKey | UnsetSizeTolerance () |
Removes the size tolerance setting from the text. More... | |
HPS.TextKey | UnsetSize () |
Removes the size setting from the text. More... | |
HPS.TextKey | UnsetFont () |
Removes the font setting from the text. More... | |
HPS.TextKey | UnsetTransform () |
Removes the transform setting from the text. More... | |
HPS.TextKey | UnsetRenderer () |
Removes the renderer setting from the text. More... | |
HPS.TextKey | UnsetPreference () |
Removes the font type preference from the text. More... | |
HPS.TextKey | UnsetPath () |
Removes the path from the text. More... | |
HPS.TextKey | UnsetSpacing () |
Removes the spacing setting from the text. More... | |
HPS.TextKey | UnsetRegion () |
Removes the region from the text. More... | |
HPS.TextKey | UnsetEverything () |
Removes all settings from this TextKey. More... | |
bool | ShowPosition (out HPS.Point out_position) |
Shows the position for the text. More... | |
bool | ShowText (out string out_string) |
Shows the string for the text. 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 | ShowModellingMatrix (out HPS.MatrixKit out_matrix) |
Shows the modelling matrix for the text. More... | |
bool | ShowAlignment (out HPS.Text.Alignment out_alignment, out HPS.Text.ReferenceFrame out_reference_frame, out HPS.Text.Justification out_justification) |
Shows the alignment for the text. More... | |
bool | ShowBold (out bool out_state) |
Shows whether the text should be bold. More... | |
bool | ShowItalic (out bool out_state) |
Shows whether the text should be italic. More... | |
bool | ShowOverline (out bool out_state) |
Shows whether an overline should be drawn over the text. More... | |
bool | ShowStrikethrough (out bool out_state) |
Shows whether a strikethrough should be drawn through the text. More... | |
bool | ShowUnderline (out bool out_state) |
Shows whether an underline should be drawn under the text. More... | |
bool | ShowSlant (out float out_angle) |
Shows the slant angle for the text. More... | |
bool | ShowLineSpacing (out float out_multiplier) |
Shows the line spacing multiplier 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 | 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 | 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 | 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 | ShowSize (out float out_size, out HPS.Text.SizeUnits out_units) |
Shows the font size to use for the text. More... | |
bool | ShowFont (out string out_name) |
Shows the font to use for the text. More... | |
bool | ShowTransform (out HPS.Text.Transform out_trans) |
Shows the transform state for the text. More... | |
bool | ShowRenderer (out HPS.Text.Renderer out_renderer) |
Shows the renderer 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 | ShowPath (out HPS.Vector out_path) |
Shows the path for the text. More... | |
bool | ShowSpacing (out float out_multiplier) |
Shows the spacing multiplier for the text. 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... | |
HPS.TextKey | EditTextByInsertion (ulong in_row, ulong in_column, ulong in_count, string in_text) |
Adds characters to the text at the specified offset. More... | |
HPS.TextKey | EditTextByDeletion (ulong in_row, ulong in_column, ulong in_count) |
Removes characters from the text at the specified offset. More... | |
HPS.TextKey | EditTextByReplacement (ulong in_row, ulong in_column, ulong in_count, string in_text) |
Replaces characters from the text at the specified offset. More... | |
![]() | |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type::None. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More... | |
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More... | |
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
Shows the all the references to this key. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. More... | |
HPS.GeometryKey | UnsetPriority () |
Removes the drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this key. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this key. More... | |
HPS.GeometryKey | UnsetAllUserData () |
Removes all user data from this key. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this key. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this key. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this key. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this key. More... | |
bool | ShowBoundings (out HPS.BoundingKit out_kit) |
Shows the bounding of this geometry. More... | |
![]() | |
Key () | |
An uninitialized key refers to no database object and Type() will return Type::None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
bool | HasOwner () |
| |
HPS.SegmentKey | Up () |
| |
HPS.SegmentKey | Owner () |
| |
void | Delete () |
Removes the database object referred to by this key. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
![]() | |
IntPtr | GetClassID () |
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... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator== (HPS.Key a, HPS.Key b) |
static bool | operator!= (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The TextKey class is a smart pointer to a database object. It is a handle to text inserted via SegmentKey::InsertText.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.GeometryKey.
|
inline |
|
inline |
Sets the alignment for the text. No aligment is set on the text by default.
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>. |
|
inline |
Sets the alignment for the text. No aligment is set on the text by default.
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>. |
|
inline |
Sets the alignment for the text. No aligment is set on the text by default.
in_alignment | The alignment for the text. |
|
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.
in_state | Whether the text should be bold. |
|
inline |
Sets the RGBA color of the text. No color is set on the text by default.
in_rgba_color | The RGBA color of the text. |
|
inline |
Sets the material index color for the text. No color is set on the text by default.
in_index | The material index color for the text. |
|
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.
in_state | Whether to add additional space between characters in a text string. |
in_size | The size of the additional 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>. |
|
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.
in_state | Whether to add additional space between characters in a text string. |
in_size | The size of the additional space to add between characters. Defaults to 0.0f. |
|
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.
in_state | Whether to add additional space between characters in a text string. |
|
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.
in_size | The size of the additional space to add between characters. |
in_units | The units of the size of the additional space to add between characters. |
|
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.
in_name | UTF8-encoded font name to use for the text. |
|
inline |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default.
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>. |
|
inline |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default.
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>. |
|
inline |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default.
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. |
|
inline |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default.
in_state | Whether greeking is enabled for this text. |
|
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.
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. |
|
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.
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. |
|
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.
in_state | Whether the text should be italic. |
|
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.
in_multiplier | The line spacing multiplier for the text. |
|
inline |
Sets the modelling matrix for the text. No modelling matrix is set on the text by default.
in_matrix | The modelling matrix for the text. |
|
inline |
Sets whether an overline should be drawn over the text. No overline setting is set on the text by default.
in_state | Whether an overline should be drawn over the text. |
|
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.
in_path | The path for the text. |
SetRegion
|
inline |
Repositions the text in object space. The object-space position for the text.
|
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.
in_preference | The font type preference for the text. |
|
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.
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. |
|
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.
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
|
inline |
Sets the renderer for the text. No renderer is set on the text by default.
in_renderer | The renderer for the text. |
|
inline |
Sets the angle characters should be rotated within the text string. No rotation is set on the text by default.
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. |
|
inline |
Sets the angle characters should be rotated within the text string. No rotation is set on the text by default.
in_state | Whether and how to rotate the characters within the text string. |
|
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.
in_angle | The angle in degrees to rotate each character within the text string. |
|
inline |
Sets the font size to use for the text. No size is set on the text by default.
in_size | The size for the text. |
in_units | The units of the size for the text. |
|
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.
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>. |
|
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.
in_state | Whether a size tolerance is enabled for this text. |
in_size | The size for the tolerance. Defaults to 50.0f. |
|
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.
in_state | Whether a size tolerance is enabled for this text. |
|
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.
in_size | The size for the tolerance. |
in_units | The units of the size for the tolerance. |
|
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.
in_angle | The angle in degrees to slant the text. This value must be in the range [-75.0f,+75.0f]. |
|
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.
in_multiplier | The spacing multiplier for the text. |
|
inline |
Sets whether a strikethrough should be drawn through the text. No strikethrough setting is set on the text by default.
in_state | Whether a strikethrough should be drawn through the text. |
|
inline |
Replaces the contents of the string for the text.
in_string | UTF8-encoded string for the text. |
|
inline |
|
inline |
Sets the transform state for the text. No transform state is set on the text by default.
in_transform | The transform state for the text. |
|
inline |
Sets whether an underline should be drawn under the text. No underline setting is set on the text by default.
in_state | Whether an underline should be drawn under the text. |
|
inline |
|
inline |
Shows the alignment 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. |
|
inline |
Shows whether the text should be bold.
out_state | Whether the text should be bold. |
|
inline |
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>. |
|
inline |
Shows the amount of additional space to add between characters in a text string.
out_state | Whether to add additional space between characters in a text string. |
out_size | The size of the additional space to add between characters. |
out_units | The units of the size of the additional space to add between characters. |
|
inline |
Shows the font to use for the text.
out_name | UTF8-encoded font name to use for the text. |
|
inline |
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. |
|
inline |
Shows whether the text should be italic.
out_state | Whether the text should be italic. |
|
inline |
Shows the line spacing multiplier for the text.
out_multiplier | The line spacing multiplier for the text. |
|
inline |
Shows the modelling matrix for the text.
out_matrix | The modelling matrix for the text. |
|
inline |
Shows whether an overline should be drawn over the text.
out_state | Whether an overline should be drawn over the text. |
|
inline |
Shows the path for the text.
out_path | The path for the text. |
|
inline |
Shows the position for the text.
out_position | The object-space position for the text. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Shows the renderer for the text.
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Shows the slant angle for the text.
out_angle | The angle in degrees to slant the text. |
|
inline |
Shows the spacing multiplier for the text.
out_multiplier | The spacing multiplier for the text. |
|
inline |
Shows whether a strikethrough should be drawn through the text.
out_state | Whether a strikethrough should be drawn through the text. |
|
inline |
Shows the string for the text.
out_string | UTF8-encoded string for the text. |
|
inline |
|
inline |
Shows the transform state for the text.
|
inline |
Shows whether an underline should be drawn under the text.
out_state | Whether an underline should be drawn under the text. |
|
inline |
Removes the alignment setting from the text.
|
inline |
Removes the bold setting from the text.
|
inline |
Removes the color (RGBA or material index) from the text.
|
inline |
|
inline |
Removes the extra space setting from the text.
|
inline |
Removes the font setting from the text.
|
inline |
Removes the greeking settings from the text.
|
inline |
Removes the italic setting from the text.
|
inline |
Removes the line spacing setting from the text.
|
inline |
Removes the modelling matrix from the text.
|
inline |
Removes the overline setting from the text.
|
inline |
Removes the path from the text.
|
inline |
Removes the font type preference from the text.
|
inline |
Removes the region from the text.
|
inline |
Removes the renderer setting from the text.
|
inline |
Removes the rotation setting from the text.
|
inline |
Removes the size setting from the text.
|
inline |
Removes the size tolerance setting from the text.
|
inline |
Removes the slant setting from the text.
|
inline |
Removes the spacing setting from the text.
|
inline |
Removes the strikethrough setting from the text.
|
inline |
Removes the transform setting from the text.
|
inline |
Removes the underline setting from the text.