|
override void | Dispose () |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.TextAttributeKit in_kit) |
|
override int | GetHashCode () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.TextAttributeKit in_kit) |
|
HPS.TextAttributeKit | SetAlignment (HPS.Text.Alignment in_align, HPS.Text.ReferenceFrame in_ref, HPS.Text.Justification in_justify) |
|
HPS.TextAttributeKit | SetAlignment (HPS.Text.Alignment in_align, HPS.Text.ReferenceFrame in_ref) |
|
HPS.TextAttributeKit | SetAlignment (HPS.Text.Alignment in_align) |
|
HPS.TextAttributeKit | SetBackground (bool in_state, string in_name) |
|
HPS.TextAttributeKit | SetBackground (string in_name) |
|
HPS.TextAttributeKit | SetBackground (bool in_state) |
|
HPS.TextAttributeKit | SetBackgroundMargins (float in_size, HPS.Text.MarginUnits in_units) |
|
HPS.TextAttributeKit | SetBackgroundMargins (float in_size) |
|
HPS.TextAttributeKit | SetBackgroundMargins (float[] in_sizes, HPS.Text.MarginUnits[] in_units) |
|
HPS.TextAttributeKit | SetBackgroundStyle (string in_name) |
|
HPS.TextAttributeKit | SetBold (bool in_state) |
|
HPS.TextAttributeKit | SetExtraSpace (bool in_state, float in_size, HPS.Text.SizeUnits in_units) |
|
HPS.TextAttributeKit | SetExtraSpace (bool in_state, float in_size) |
|
HPS.TextAttributeKit | SetExtraSpace (bool in_state) |
|
HPS.TextAttributeKit | SetExtraSpace (float in_size, HPS.Text.SizeUnits in_units) |
|
HPS.TextAttributeKit | SetFont (string in_name) |
|
HPS.TextAttributeKit | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
|
HPS.TextAttributeKit | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units) |
|
HPS.TextAttributeKit | SetGreeking (bool in_state, float in_size) |
|
HPS.TextAttributeKit | SetGreeking (bool in_state) |
|
HPS.TextAttributeKit | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
|
HPS.TextAttributeKit | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units) |
|
HPS.TextAttributeKit | SetGreeking (float in_size) |
|
HPS.TextAttributeKit | SetItalic (bool in_state) |
|
HPS.TextAttributeKit | SetLineSpacing (float in_multiplier) |
|
HPS.TextAttributeKit | SetOverline (bool in_state) |
|
HPS.TextAttributeKit | SetPath (HPS.Vector in_path) |
|
HPS.TextAttributeKit | SetPreference (HPS.Text.Preference in_pref) |
|
HPS.TextAttributeKit | SetPreference (float in_cutoff, HPS.Text.SizeUnits in_units, HPS.Text.Preference in_smaller, HPS.Text.Preference in_larger) |
|
HPS.TextAttributeKit | SetRenderer (HPS.Text.Renderer in_rend) |
|
HPS.TextAttributeKit | SetRotation (HPS.Text.Rotation in_state, float in_angle) |
|
HPS.TextAttributeKit | SetRotation (HPS.Text.Rotation in_state) |
|
HPS.TextAttributeKit | SetRotation (float in_angle) |
|
HPS.TextAttributeKit | SetSize (float in_size, HPS.Text.SizeUnits in_units) |
|
HPS.TextAttributeKit | SetSizeTolerance (bool in_state, float in_size, HPS.Text.SizeToleranceUnits in_units) |
|
HPS.TextAttributeKit | SetSizeTolerance (bool in_state, float in_size) |
|
HPS.TextAttributeKit | SetSizeTolerance (bool in_state) |
|
HPS.TextAttributeKit | SetSizeTolerance (float in_size, HPS.Text.SizeToleranceUnits in_units) |
|
HPS.TextAttributeKit | SetSlant (float in_angle) |
|
HPS.TextAttributeKit | SetSpacing (float in_multiplier) |
|
HPS.TextAttributeKit | SetStrikethrough (bool in_state) |
|
HPS.TextAttributeKit | SetTransform (HPS.Text.Transform in_trans) |
|
HPS.TextAttributeKit | SetUnderline (bool in_state) |
|
void | Show (out HPS.TextAttributeKit out_kit) |
|
bool | ShowAlignment (out HPS.Text.Alignment out_align, out HPS.Text.ReferenceFrame out_ref, out HPS.Text.Justification out_justify) |
|
bool | ShowBackground (out bool out_state, out string out_name) |
|
bool | ShowBackgroundMargins (out float[] out_size, out HPS.Text.MarginUnits[] out_units) |
|
bool | ShowBackgroundStyle (out string out_name) |
|
bool | ShowBold (out bool out_state) |
|
bool | ShowExtraSpace (out bool out_state, out float out_size, out HPS.Text.SizeUnits out_units) |
|
bool | ShowFont (out string out_name) |
|
bool | ShowGreeking (out bool out_state, out float out_size, out HPS.Text.GreekingUnits out_units, out HPS.Text.GreekingMode out_mode) |
|
bool | ShowItalic (out bool out_state) |
|
bool | ShowLineSpacing (out float out_multiplier) |
|
bool | ShowOverline (out bool out_state) |
|
bool | ShowPath (out HPS.Vector out_path) |
|
bool | ShowPreference (out float out_cutoff, out HPS.Text.SizeUnits out_units, out HPS.Text.Preference out_smaller, out HPS.Text.Preference out_larger) |
|
bool | ShowRenderer (out HPS.Text.Renderer out_rend) |
|
bool | ShowRotation (out HPS.Text.Rotation out_rot, out float out_angle) |
|
bool | ShowSize (out float out_size, out HPS.Text.SizeUnits out_units) |
|
bool | ShowSizeTolerance (out bool out_state, out float out_size, out HPS.Text.SizeToleranceUnits out_units) |
|
bool | ShowSlant (out float out_angle) |
|
bool | ShowSpacing (out float out_multiplier) |
|
bool | ShowStrikethrough (out bool out_state) |
|
bool | ShowTransform (out HPS.Text.Transform out_trans) |
|
bool | ShowUnderline (out bool out_state) |
|
| TextAttributeKit () |
|
| TextAttributeKit (HPS.TextAttributeKit in_kit) |
|
HPS.TextAttributeKit | UnsetAlignment () |
|
HPS.TextAttributeKit | UnsetBackground () |
|
HPS.TextAttributeKit | UnsetBackgroundMargins () |
|
HPS.TextAttributeKit | UnsetBackgroundStyle () |
|
HPS.TextAttributeKit | UnsetBold () |
|
HPS.TextAttributeKit | UnsetEverything () |
|
HPS.TextAttributeKit | UnsetExtraSpace () |
|
HPS.TextAttributeKit | UnsetFont () |
|
HPS.TextAttributeKit | UnsetGreeking () |
|
HPS.TextAttributeKit | UnsetItalic () |
|
HPS.TextAttributeKit | UnsetLineSpacing () |
|
HPS.TextAttributeKit | UnsetOverline () |
|
HPS.TextAttributeKit | UnsetPath () |
|
HPS.TextAttributeKit | UnsetPreference () |
|
HPS.TextAttributeKit | UnsetRenderer () |
|
HPS.TextAttributeKit | UnsetRotation () |
|
HPS.TextAttributeKit | UnsetSize () |
|
HPS.TextAttributeKit | UnsetSizeTolerance () |
|
HPS.TextAttributeKit | UnsetSlant () |
|
HPS.TextAttributeKit | UnsetSpacing () |
|
HPS.TextAttributeKit | UnsetStrikethrough () |
|
HPS.TextAttributeKit | UnsetTransform () |
|
HPS.TextAttributeKit | UnsetUnderline () |
|
| Kit (HPS.Kit in_that) |
|
override HPS.Type | Type () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.TextAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.TextAttributeKit.GetDefault() will return a kit with values found in this table.
◆ TextAttributeKit() [1/2]
HPS.TextAttributeKit.TextAttributeKit |
( |
| ) |
|
|
inline |
Initializes an empty kit.
◆ TextAttributeKit() [2/2]
The copy constructor creates a new TextAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
◆ Empty()
override bool HPS.TextAttributeKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source TextAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
Creates a TextAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A TextAttributeKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.TextAttributeKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
◆ Set()
Copies all settings from the source TextAttributeKit into this object.
- Parameters
-
◆ SetAlignment() [1/3]
Sets the alignment for text.
- Returns
- A reference to this object.
◆ SetAlignment() [2/3]
Sets the alignment for text.
- Returns
- A reference to this object.
◆ SetAlignment() [3/3]
Sets the alignment for text.
- Returns
- A reference to this object.
◆ SetBackground() [1/3]
Sets the background to be used with text.
- Parameters
-
in_state | Whether a background is drawn for text. |
in_name | The name of a shape definition. |
- Returns
- A reference to this object.
◆ SetBackground() [2/3]
Sets the background to be used with text. The state is implicitly on.
- Parameters
-
in_name | The name of a shape definition. |
- Returns
- A reference to this object.
◆ SetBackground() [3/3]
Sets the background to be used with text.
- Parameters
-
in_state | Whether a background is drawn for text. |
- Returns
- A reference to this object.
◆ SetBackgroundMargins() [1/3]
Sets the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
in_size | The size of the margins. |
in_units | The units of the size. |
- Returns
- A reference to this object.
◆ SetBackgroundMargins() [2/3]
Sets the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
in_size | The size of the margins. |
- Returns
- A reference to this object.
◆ SetBackgroundMargins() [3/3]
Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines.
- Parameters
-
in_sizes | The size of the margins. |
in_units | The units of the size. |
- Returns
- A reference to this object.
◆ SetBackgroundStyle()
Allows specifying a named style to be used in the drawing of text backgrounds. If no style is specified, backgrounds inherit the face and edge attributes from the containing segment.
- Parameters
-
in_name | The name of a style, defined in a portfolio that is accessible. |
- Returns
- A reference to this object.
◆ SetBold()
Sets whether text should be bold. For fonts which do not have a bold variant, this setting will be ignored.
- Parameters
-
in_state | Whether text should be bold. |
- Returns
- A reference to this object.
◆ SetExtraSpace() [1/4]
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
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. |
in_units | The units of the size of the additional space to add between characters. |
- Returns
- A reference to this object.
◆ SetExtraSpace() [2/4]
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
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. |
- Returns
- A reference to this object.
◆ SetExtraSpace() [3/4]
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
in_state | Whether to add additional space between characters in a text string. |
- Returns
- A reference to this object.
◆ SetExtraSpace() [4/4]
Sets the amount of additional space to add between characters in a text string. This function implicitly enables the addition of extra space.
- Parameters
-
in_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. |
- Returns
- A reference to this object.
◆ SetFont()
Sets the font to use for text. This must either be a builtin font or a font Visualize can locate in the directories specified by World.SetFontDirectories. If the requested font cannot be found, the stroked font will be used.
- Parameters
-
in_name | UTF8-encoded font name to use for text. |
- Returns
- A reference to this TextKey.
- See also
- World.SetFontDirectories
◆ SetGreeking() [1/7]
Sets the greeking settings to use for text.
- Parameters
-
in_state | Whether greeking is enabled for text. |
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. |
- Returns
- A reference to this object.
◆ SetGreeking() [2/7]
Sets the greeking settings to use for text.
- Parameters
-
in_state | Whether greeking is enabled for text. |
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. |
- Returns
- A reference to this object.
◆ SetGreeking() [3/7]
Sets the greeking settings to use for text.
- Parameters
-
in_state | Whether greeking is enabled for text. |
in_size | The size below which to draw a simple symbol in place of a character. |
- Returns
- A reference to this object.
◆ SetGreeking() [4/7]
Sets the greeking settings to use for text.
- Parameters
-
in_state | Whether greeking is enabled for text. |
- Returns
- A reference to this object.
◆ SetGreeking() [5/7]
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
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. |
- Returns
- A reference to this object.
◆ SetGreeking() [6/7]
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
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. |
- Returns
- A reference to this object.
◆ SetGreeking() [7/7]
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
in_size | The size below which to draw a simple symbol in place of a character. |
- Returns
- A reference to this object.
◆ SetItalic()
Sets whether text should be italic. For fonts which do not have an italic variant, this setting will be ignored.
- Parameters
-
in_state | Whether text should be italic. |
- Returns
- A reference to this object.
◆ SetLineSpacing()
Sets the line spacing multiplier for text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string.
- Parameters
-
in_multiplier | The line spacing multiplier for text. |
- Returns
- A reference to this object.
◆ SetOverline()
Sets whether an overline should be drawn over text.
- Parameters
-
in_state | Whether an overline should be drawn over text. |
- Returns
- A reference to this object.
◆ SetPath()
Sets the path for text. This setting controls the vector along which text strings will be displayed.
- Parameters
-
in_path | The path for text. |
- Returns
- A reference to this object.
◆ SetPreference() [1/2]
Sets the font type preference for text. This function implicitly sets the same font type for all text sizes.
- Returns
- A reference to this object.
◆ SetPreference() [2/2]
Sets the preference for text. This setting controls which font type is used for text for "large" and "small" sizes and the cutoff at which this distinction is made.
- Parameters
-
in_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. |
- Returns
- A reference to this object.
◆ SetRenderer()
Sets the renderer for text.
- Returns
- A reference to this object.
◆ SetRotation() [1/3]
Sets the angle characters should be rotated within text strings. To rotate the text as a block (instead of each individual character) use SetPath with SetRotation(HPS.Text.Rotation.FollowPath), or use a modelling matrix rotation.
- Parameters
-
in_state | Whether and how to rotate the characters within text string. |
in_angle | The angle in degrees to rotate each character within text strings. This is only relevant if in_state is Text.Rotation.Rotate. |
- Returns
- A reference to this object.
◆ SetRotation() [2/3]
Sets the angle characters should be rotated within text strings. To rotate the text as a block (instead of each individual character) use SetPath with SetRotation(HPS.Text.Rotation.FollowPath), or use a modelling matrix rotation.
- Parameters
-
in_state | Whether and how to rotate the characters within text string. |
- Returns
- A reference to this object.
◆ SetRotation() [3/3]
Sets the angle characters should be rotated within text strings. To rotate the text as a block (instead of each individual character) use SetPath with SetRotation(HPS.Text.Rotation.FollowPath), or use a modelling matrix rotation. This function implicitly sets a rotation state of Text.Rotation.Rotate.
- Parameters
-
in_angle | The angle in degrees to rotate each character within text strings. |
- Returns
- A reference to this object.
◆ SetSize()
Sets the font size to use for text.
- Parameters
-
in_size | The size for text. |
in_units | The units of the size for text. |
- Returns
- A reference to this object.
◆ SetSizeTolerance() [1/4]
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state | Whether a size tolerance is enabled for text. |
in_size | The size for the tolerance. |
in_units | The units of the size for the tolerance. |
- Returns
- A reference to this object.
◆ SetSizeTolerance() [2/4]
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state | Whether a size tolerance is enabled for text. |
in_size | The size for the tolerance. |
- Returns
- A reference to this object.
◆ SetSizeTolerance() [3/4]
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state | Whether a size tolerance is enabled for text. |
- Returns
- A reference to this object.
◆ SetSizeTolerance() [4/4]
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. This function implicitly enables a size tolerance.
- Parameters
-
in_size | The size for the tolerance. |
in_units | The units of the size for the tolerance. |
- Returns
- A reference to this object.
◆ SetSlant()
Sets the slant angle for text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular.
- Parameters
-
in_angle | The angle in degrees to slant text. This value must be in the range [-75.0f,+75.0f]. |
- Returns
- A reference to this object.
◆ SetSpacing()
Sets the spacing multiplier for text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on.
- Parameters
-
in_multiplier | The spacing multiplier for text. |
- Returns
- A reference to this object.
◆ SetStrikethrough()
Sets whether a strikethrough should be drawn through text.
- Parameters
-
in_state | Whether a strikethrough should be drawn through text. |
- Returns
- A reference to this object.
◆ SetTransform()
Sets the transform behavior for text.
- Returns
- A reference to this object.
◆ SetUnderline()
Sets whether an underline should be drawn under text.
- Parameters
-
in_state | Whether an underline should be drawn under text. |
- Returns
- A reference to this object.
◆ Show()
◆ ShowAlignment()
Shows the alignment for text.
- Returns
- true if an alignment was set, false otherwise.
◆ ShowBackground()
bool HPS.TextAttributeKit.ShowBackground |
( |
out bool |
out_state, |
|
|
out string |
out_name |
|
) |
| |
|
inline |
Shows the background to be used with text.
- Parameters
-
out_state | Whether a background is drawn for text. |
out_name | The name of a shape definition. |
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowBackgroundMargins()
bool HPS.TextAttributeKit.ShowBackgroundMargins |
( |
out float [] |
out_size, |
|
|
out HPS.Text.MarginUnits [] |
out_units |
|
) |
| |
|
inline |
Shows the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
out_size | The size of the margins. |
out_units | The units of the sizes. |
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowBackgroundStyle()
bool HPS.TextAttributeKit.ShowBackgroundStyle |
( |
out string |
out_name | ) |
|
|
inline |
Shows the named style to be used in the drawing of text backgrounds.
- Parameters
-
out_name | The name of a style, defined in a portfolio that is accessible. |
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowBold()
bool HPS.TextAttributeKit.ShowBold |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether text should be bold.
- Parameters
-
out_state | Whether text should be bold. |
- Returns
- true if a bold setting was set, false otherwise.
◆ ShowExtraSpace()
bool HPS.TextAttributeKit.ShowExtraSpace |
( |
out bool |
out_state, |
|
|
out float |
out_size, |
|
|
out HPS.Text.SizeUnits |
out_units |
|
) |
| |
|
inline |
Shows the amount of additional space to add between characters in a text string.
- Parameters
-
out_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. |
- Returns
- true if an extra space setting was set, false otherwise.
◆ ShowFont()
bool HPS.TextAttributeKit.ShowFont |
( |
out string |
out_name | ) |
|
|
inline |
Shows the font to use for text.
- Parameters
-
out_name | UTF8-encoded font name to use for text. |
- Returns
- true if a font was set, false otherwise.
◆ ShowGreeking()
Shows the greeking settings to use for text.
- Parameters
-
out_state | Whether greeking is enabled for 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. |
- Returns
- true if greeking settings were set, false otherwise.
◆ ShowItalic()
bool HPS.TextAttributeKit.ShowItalic |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether text should be italic.
- Parameters
-
out_state | Whether text should be italic. |
- Returns
- true if an italic setting was set, false otherwise.
◆ ShowLineSpacing()
bool HPS.TextAttributeKit.ShowLineSpacing |
( |
out float |
out_multiplier | ) |
|
|
inline |
Shows the line spacing multiplier for text.
- Parameters
-
out_multiplier | The line spacing multiplier for text. |
- Returns
- true if a line space multiplier was set, false otherwise.
◆ ShowOverline()
bool HPS.TextAttributeKit.ShowOverline |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether an overline should be drawn over text.
- Parameters
-
out_state | Whether an overline should be drawn over text. |
- Returns
- true if an overline setting was set, false otherwise.
◆ ShowPath()
bool HPS.TextAttributeKit.ShowPath |
( |
out HPS.Vector |
out_path | ) |
|
|
inline |
Shows the path for text.
- Parameters
-
out_path | The path for text. |
- Returns
- true if a path was set, false otherwise.
◆ ShowPreference()
Shows the preference for text.
- Parameters
-
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. |
- Returns
- true if a preference was set, false otherwise.
◆ ShowRenderer()
Shows the renderer for text.
- Returns
- true if a renderer was set, false otherwise.
◆ ShowRotation()
bool HPS.TextAttributeKit.ShowRotation |
( |
out HPS.Text.Rotation |
out_rot, |
|
|
out float |
out_angle |
|
) |
| |
|
inline |
Shows the angle characters should be rotated within text strings.
- Parameters
-
out_rot | Whether to rotate the characters within text strings, and if so, what the angle should be measured with repect to. |
out_angle | The angle in degrees to rotate each character within text strings. |
- Returns
- true if a rotation setting was set, false otherwise.
◆ ShowSize()
bool HPS.TextAttributeKit.ShowSize |
( |
out float |
out_size, |
|
|
out HPS.Text.SizeUnits |
out_units |
|
) |
| |
|
inline |
Shows the font size to use for text.
- Parameters
-
out_size | The size for text. |
out_units | The units of the size for text. |
- Returns
- true if a size was set, false otherwise.
◆ ShowSizeTolerance()
Shows the size tolerance settings to use for text.
- Parameters
-
out_state | Whether a size tolerance is enabled for text. |
out_size | The size for the tolerance. |
out_units | The units of the size for the tolerance. |
- Returns
- true if a size tolerance was set, false otherwise.
◆ ShowSlant()
bool HPS.TextAttributeKit.ShowSlant |
( |
out float |
out_angle | ) |
|
|
inline |
Shows the slant angle for text.
- Parameters
-
out_angle | The angle in degrees to slant text. |
- Returns
- true if a slang angle was set, false otherwise.
◆ ShowSpacing()
bool HPS.TextAttributeKit.ShowSpacing |
( |
out float |
out_multiplier | ) |
|
|
inline |
Shows the spacing multiplier for text.
- Parameters
-
out_multiplier | The spacing multiplier for text. |
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowStrikethrough()
bool HPS.TextAttributeKit.ShowStrikethrough |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether a strikethrough should be drawn through text.
- Parameters
-
out_state | Whether a strikethrough should be drawn through text. |
- Returns
- true if a strikethrough setting was set, false otherwise.
◆ ShowTransform()
Shows the transform state for text.
- Returns
- true if a transform state was set, false otherwise.
◆ ShowUnderline()
bool HPS.TextAttributeKit.ShowUnderline |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether an underline should be drawn under text.
- Parameters
-
out_state | Whether an underline should be drawn under text. |
- Returns
- true if an underline setting was set, false otherwise.
◆ UnsetAlignment()
Removes the alignment setting.
- Returns
- A reference to this object.
◆ UnsetBackground()
Removes the background setting.
- Returns
- A reference to this object.
◆ UnsetBackgroundMargins()
Removes the background margin setting.
- Returns
- A reference to this object.
◆ UnsetBackgroundStyle()
Removes the background style setting.
- Returns
- A reference to this object.
◆ UnsetBold()
Removes the bold setting.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetExtraSpace()
Removes the extra space setting.
- Returns
- A reference to this object.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this object.
◆ UnsetGreeking()
Removes the greeking setting.
- Returns
- A reference to this object.
◆ UnsetItalic()
Removes the italic setting.
- Returns
- A reference to this object.
◆ UnsetLineSpacing()
Removes the line spacing setting.
- Returns
- A reference to this object.
◆ UnsetOverline()
Removes the overline setting.
- Returns
- A reference to this object.
◆ UnsetPath()
Removes the path setting.
- Returns
- A reference to this object.
◆ UnsetPreference()
Removes the preference setting.
- Returns
- A reference to this object.
◆ UnsetRenderer()
Removes the renderer setting.
- Returns
- A reference to this object.
◆ UnsetRotation()
Removes the rotation setting.
- Returns
- A reference to this object.
◆ UnsetSize()
Removes the size setting.
- Returns
- A reference to this object.
◆ UnsetSizeTolerance()
Removes the size tolerance setting.
- Returns
- A reference to this object.
◆ UnsetSlant()
Removes the slant setting.
- Returns
- A reference to this object.
◆ UnsetSpacing()
Removes the spacing setting.
- Returns
- A reference to this object.
◆ UnsetStrikethrough()
Removes the strikethrough setting.
- Returns
- A reference to this object.
◆ UnsetTransform()
Removes the transform setting.
- Returns
- A reference to this object.
◆ UnsetUnderline()
Removes the underline setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TextAttributeKit.cs