#include <hps.h>
Public Member Functions | |
TextKey () | |
TextKey (Key const &in_that) | |
TextKey (TextKey const &in_that) | |
TextKey & | operator= (TextKey const &other) |
TextKey (TextKey &&in_that) | |
TextKey & | operator= (TextKey &&in_that) |
HPS::Type | ObjectType () const |
void | Consume (TextKit &in_kit) |
void | Set (TextKit const &in_kit) |
void | Show (TextKit &out_kit) const |
TextKey & | SetTextAttributes (TextAttributeKit const &in_kit) |
bool | ShowTextAttributes (TextAttributeKit &out_kit) const |
TextKey & | SetPosition (Point const &in_position) |
TextKey & | SetText (char const *in_string) |
TextKey & | SetColor (RGBAColor const &in_rgba_color) |
TextKey & | SetColorByIndex (float in_index) |
TextKey & | SetModellingMatrix (MatrixKit const &in_matrix) |
TextKey & | SetAlignment (Text::Alignment in_alignment, Text::ReferenceFrame in_reference_frame=Text::ReferenceFrame::WorldAligned, Text::Justification in_justification=Text::Justification::LeftJustified) |
TextKey & | SetBold (bool in_state) |
TextKey & | SetItalic (bool in_state) |
TextKey & | SetOverline (bool in_state) |
TextKey & | SetStrikethrough (bool in_state) |
TextKey & | SetUnderline (bool in_state) |
TextKey & | SetSlant (float in_angle) |
TextKey & | SetLineSpacing (float in_multiplier) |
TextKey & | SetRotation (Text::Rotation in_state, float in_angle=0.0f) |
TextKey & | SetRotation (float in_angle) |
TextKey & | SetExtraSpace (bool in_state, float in_size=0.0f, Text::SizeUnits in_units=Text::SizeUnits::ObjectSpace) |
TextKey & | SetExtraSpace (float in_size, Text::SizeUnits in_units) |
TextKey & | SetGreeking (bool in_state, float in_size=0.0f, Text::GreekingUnits in_units=Text::GreekingUnits::ObjectSpace, Text::GreekingMode in_mode=Text::GreekingMode::Lines) |
TextKey & | SetGreeking (float in_size, Text::GreekingUnits in_units, Text::GreekingMode in_mode=Text::GreekingMode::Lines) |
TextKey & | SetSizeTolerance (bool in_state, float in_size=50.0f, Text::SizeToleranceUnits in_units=Text::SizeToleranceUnits::Percent) |
TextKey & | SetSizeTolerance (float in_size, Text::SizeToleranceUnits in_units) |
TextKey & | SetSize (float in_size, Text::SizeUnits in_units) |
TextKey & | SetFont (char const *in_name) |
TextKey & | SetTransform (Text::Transform in_transform) |
TextKey & | SetRenderer (Text::Renderer in_renderer) |
TextKey & | SetPreference (Text::Preference in_preference) |
TextKey & | SetPreference (float in_cutoff, Text::SizeUnits in_units, Text::Preference in_smaller, Text::Preference in_larger) |
TextKey & | SetPath (Vector const &in_path) |
TextKey & | SetSpacing (float in_multiplier) |
TextKey & | SetRegion (PointArray &in_region, Text::RegionAlignment in_region_alignment, bool in_region_fitting, bool in_region_adjust_direction, bool in_region_relative_coordinates, bool in_region_window_space) |
TextKey & | SetRegion (size_t in_region_count, Point const in_region[], Text::RegionAlignment in_region_alignment, bool in_region_fitting, bool in_region_adjust_direction, bool in_region_relative_coordinates, bool in_region_window_space) |
TextKey & | UnsetColor () |
TextKey & | UnsetModellingMatrix () |
TextKey & | UnsetAlignment () |
TextKey & | UnsetBold () |
TextKey & | UnsetItalic () |
TextKey & | UnsetOverline () |
TextKey & | UnsetStrikethrough () |
TextKey & | UnsetUnderline () |
TextKey & | UnsetSlant () |
TextKey & | UnsetLineSpacing () |
TextKey & | UnsetRotation () |
TextKey & | UnsetExtraSpace () |
TextKey & | UnsetGreeking () |
TextKey & | UnsetSizeTolerance () |
TextKey & | UnsetSize () |
TextKey & | UnsetFont () |
TextKey & | UnsetTransform () |
TextKey & | UnsetRenderer () |
TextKey & | UnsetPreference () |
TextKey & | UnsetPath () |
TextKey & | UnsetSpacing () |
TextKey & | UnsetRegion () |
TextKey & | UnsetEverything () |
bool | ShowPosition (Point &out_position) const |
bool | ShowText (UTF8 &out_string) const |
bool | ShowColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_index) const |
bool | ShowModellingMatrix (MatrixKit &out_matrix) const |
bool | ShowAlignment (Text::Alignment &out_alignment, Text::ReferenceFrame &out_reference_frame, Text::Justification &out_justification) const |
bool | ShowBold (bool &out_state) const |
bool | ShowItalic (bool &out_state) const |
bool | ShowOverline (bool &out_state) const |
bool | ShowStrikethrough (bool &out_state) const |
bool | ShowUnderline (bool &out_state) const |
bool | ShowSlant (float &out_angle) const |
bool | ShowLineSpacing (float &out_multiplier) const |
bool | ShowRotation (Text::Rotation &out_rot, float &out_angle) const |
bool | ShowExtraSpace (bool &out_state, float &out_size, Text::SizeUnits &out_units) const |
bool | ShowGreeking (bool &out_state, float &out_size, Text::GreekingUnits &out_units, Text::GreekingMode &out_mode) const |
bool | ShowSizeTolerance (bool &out_state, float &out_size, Text::SizeToleranceUnits &out_units) const |
bool | ShowSize (float &out_size, Text::SizeUnits &out_units) const |
bool | ShowFont (UTF8 &out_name) const |
bool | ShowTransform (Text::Transform &out_trans) const |
bool | ShowRenderer (Text::Renderer &out_renderer) const |
bool | ShowPreference (float &out_cutoff, Text::SizeUnits &out_units, Text::Preference &out_smaller, Text::Preference &out_larger) const |
bool | ShowPath (Vector &out_path) const |
bool | ShowSpacing (float &out_multiplier) const |
bool | ShowRegion (PointArray &out_region, Text::RegionAlignment &out_region_alignment, bool &out_region_fitting, bool &out_region_adjust_direction, bool &out_region_relative_coordinates, bool &out_region_window_space) const |
TextKey & | EditTextByInsertion (size_t in_row, size_t in_column, size_t in_count, char const *in_text) |
TextKey & | EditTextByDeletion (size_t in_row, size_t in_column, size_t in_count) |
TextKey & | EditTextByReplacement (size_t in_row, size_t in_column, size_t in_count, char const *in_text) |
![]() | |
GeometryKey () | |
GeometryKey (Key const &in_that) | |
GeometryKey (GeometryKey const &in_that) | |
GeometryKey & | operator= (GeometryKey const &in_that) |
GeometryKey (GeometryKey &&in_that) | |
GeometryKey & | operator= (GeometryKey &&in_that) |
size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
size_t | ShowReferrers (ReferenceKeyArray &out_references) const |
GeometryKey & | SetPriority (int in_priority) |
GeometryKey & | UnsetPriority () |
bool | ShowPriority (int &out_priority) const |
GeometryKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
GeometryKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
GeometryKey & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
GeometryKey & | UnsetUserData (intptr_t in_index) |
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
GeometryKey & | UnsetAllUserData () |
size_t | ShowUserDataCount () const |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
bool | ShowBoundings (BoundingKit &out_kit) const |
![]() | |
Key () | |
Key (Key const &in_that) | |
Key (Control const &in_control) | |
Key (Key &&in_that) | |
Key & | operator= (Key &&in_that) |
virtual | ~Key () |
bool | HasOwner () const |
SegmentKey | Up () const |
SegmentKey | Owner () const |
void | Delete () |
void | MoveTo (SegmentKey const &in_new_owner) |
Key | CopyTo (SegmentKey const &in_destination) const |
Key & | operator= (Key const &in_that) |
virtual void | Assign (Key const &in_that) |
bool | Equals (Key const &in_that) const |
bool | operator!= (Key const &in_that) const |
bool | operator== (Key const &in_that) const |
size_t | GetHash () const |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The TextKey class is a smart pointer to a database object. It is a handle to text inserted via SegmentKey::InsertText.
HPS::TextKey::TextKey | ( | ) |
|
explicit |
This constructor creates an TextKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a text key. Otherwise the copy will fail and the resulting TextKey will be invalid.
in_key | The source Key to copy. |
HPS::TextKey::TextKey | ( | TextKey const & | in_that | ) |
HPS::TextKey::TextKey | ( | TextKey && | in_that | ) |
void HPS::TextKey::Consume | ( | TextKit & | in_kit | ) |
TextKey& HPS::TextKey::EditTextByDeletion | ( | size_t | in_row, |
size_t | in_column, | ||
size_t | in_count | ||
) |
Removes characters from the text at the specified offset.
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. |
TextKey& HPS::TextKey::EditTextByInsertion | ( | size_t | in_row, |
size_t | in_column, | ||
size_t | in_count, | ||
char const * | in_text | ||
) |
Adds characters to the text at the specified offset.
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. |
TextKey& HPS::TextKey::EditTextByReplacement | ( | size_t | in_row, |
size_t | in_column, | ||
size_t | in_count, | ||
char const * | in_text | ||
) |
Replaces characters from the text at the specified offset.
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.
void HPS::TextKey::Set | ( | TextKit const & | in_kit | ) |
TextKey& HPS::TextKey::SetAlignment | ( | Text::Alignment | in_alignment, |
Text::ReferenceFrame | in_reference_frame = Text::ReferenceFrame::WorldAligned , |
||
Text::Justification | in_justification = Text::Justification::LeftJustified |
||
) |
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 Text::ReferenceFrame::WorldAligned. |
in_justification | The justification for the text. Defaults to Text::Justification::LeftJustified. |
TextKey& HPS::TextKey::SetBold | ( | bool | in_state | ) |
Sets whether the text should be bold. For fonts which do not have a bold variant, this setting will be ignored. No bold setting is set on the text by default.
in_state | Whether the text should be bold. |
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. |
TextKey& HPS::TextKey::SetColorByIndex | ( | float | in_index | ) |
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. |
TextKey& HPS::TextKey::SetExtraSpace | ( | bool | in_state, |
float | in_size = 0.0f , |
||
Text::SizeUnits | in_units = Text::SizeUnits::ObjectSpace |
||
) |
Sets the amount of additional space to add between characters in a text string. No extra space is set on the text by default.
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 Text::SizeUnits::ObjectSpace. |
TextKey& HPS::TextKey::SetExtraSpace | ( | float | in_size, |
Text::SizeUnits | in_units | ||
) |
Sets the amount of additional space to add between characters in a text string. This function implicitly enables the addition of extra space. No extra space is set on the text by default.
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. |
TextKey& HPS::TextKey::SetFont | ( | char const * | in_name | ) |
Sets the font to use for the text. This must either be a builtin font or a font Visualize can locate in the directories specified by World::SetFontDirectories. If the requested font cannot be found, the stroked font will be used. No font is set on the text by default.
in_name | UTF8-encoded font name to use for the text. |
TextKey& HPS::TextKey::SetGreeking | ( | bool | in_state, |
float | in_size = 0.0f , |
||
Text::GreekingUnits | in_units = Text::GreekingUnits::ObjectSpace , |
||
Text::GreekingMode | in_mode = Text::GreekingMode::Lines |
||
) |
Sets the greeking settings to use for the text. No greeking settings are set on the text by default.
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 Text::GreekingUnits::ObjectSpace. |
in_mode | The type of symbol to draw for characters which are smaller than the greeking size. Defaults to Text::GreekingMode::Lines. |
TextKey& HPS::TextKey::SetGreeking | ( | float | in_size, |
Text::GreekingUnits | in_units, | ||
Text::GreekingMode | in_mode = Text::GreekingMode::Lines |
||
) |
Sets the greeking settings to use for the text. This function implicitly enables text greeking. No greeking settings are set on the text by default.
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. |
TextKey& HPS::TextKey::SetItalic | ( | bool | in_state | ) |
Sets whether the text should be italic. For fonts which do not have an italic variant, this setting will be ignored. No italic setting is set on the text by default.
in_state | Whether the text should be italic. |
TextKey& HPS::TextKey::SetLineSpacing | ( | float | in_multiplier | ) |
Sets the line spacing multiplier for the text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string. No line spacing is set on the text by default.
in_multiplier | The line spacing multiplier for the text. |
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. |
TextKey& HPS::TextKey::SetOverline | ( | bool | in_state | ) |
Sets whether an overline should be drawn over the text. No overline setting is set on the text by default.
in_state | Whether an overline should be drawn over the text. |
Repositions the text in object space. The object-space position for the text.
TextKey& HPS::TextKey::SetPreference | ( | Text::Preference | in_preference | ) |
Sets the font type preference for the text. This function implicitly sets the same font type for all text sizes. No preference is set on the text by default.
in_preference | The font type preference for the text. |
TextKey& HPS::TextKey::SetPreference | ( | float | in_cutoff, |
Text::SizeUnits | in_units, | ||
Text::Preference | in_smaller, | ||
Text::Preference | in_larger | ||
) |
Sets the preference for the text. This setting controls which font type is used for the text for "large" and "small" sizes and the cutoff at which this distinction is made. No preference is set on the text by default.
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. |
TextKey& HPS::TextKey::SetRegion | ( | PointArray & | in_region, |
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 | The points defining the region for the text. This array must be of size 2 or 3. A two point region defines an implicit up vector which is rotated 90 degrees counter-clockwise from the region line. A three point region uses the first two points as the region line and the third point defines the plane in which a vector perpendicular to the region line will be computed for use as the up vector. |
in_region_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. |
TextKey& HPS::TextKey::SetRegion | ( | size_t | in_region_count, |
Point const | in_region[], | ||
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. |
TextKey& HPS::TextKey::SetRenderer | ( | Text::Renderer | in_renderer | ) |
Sets the renderer for the text. No renderer is set on the text by default.
in_renderer | The renderer for the text. |
TextKey& HPS::TextKey::SetRotation | ( | Text::Rotation | in_state, |
float | in_angle = 0.0f |
||
) |
Sets the angle characters should be rotated within the text string. No rotation is set on the text by default.
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 Text::Rotation::Rotate. Defaults to 0.0f. |
TextKey& HPS::TextKey::SetRotation | ( | float | in_angle | ) |
Sets the angle characters should be rotated within the text string. This function implicitly sets a rotation state of Text::Rotation::Rotate. No rotation is set on the text by default.
in_angle | The angle in degrees to rotate each character within the text string. |
TextKey& HPS::TextKey::SetSize | ( | float | in_size, |
Text::SizeUnits | in_units | ||
) |
Sets the font size to use for the text. No size is set on the text by default.
in_size | The size for the text. |
in_units | The units of the size for the text. |
TextKey& HPS::TextKey::SetSizeTolerance | ( | bool | in_state, |
float | in_size = 50.0f , |
||
Text::SizeToleranceUnits | in_units = Text::SizeToleranceUnits::Percent |
||
) |
Sets the size tolerance settings to use for the text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. No size tolerance is set on the text by default.
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 Text::SizeToleranceUnits::Percent. |
TextKey& HPS::TextKey::SetSizeTolerance | ( | float | in_size, |
Text::SizeToleranceUnits | in_units | ||
) |
Sets the size tolerance settings to use for the text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. This function implicitly enables a size tolerance. No size tolerance is set on the text by default.
in_size | The size for the tolerance. |
in_units | The units of the size for the tolerance. |
TextKey& HPS::TextKey::SetSlant | ( | float | in_angle | ) |
Sets the slant angle for the text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular. No slant angle is set on the text by default.
in_angle | The angle in degrees to slant the text. This value must be in the range [-75.0f,+75.0f]. |
TextKey& HPS::TextKey::SetSpacing | ( | float | in_multiplier | ) |
Sets the spacing multiplier for the text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on.
in_multiplier | The spacing multiplier for the text. |
TextKey& HPS::TextKey::SetStrikethrough | ( | bool | in_state | ) |
Sets whether a strikethrough should be drawn through the text. No strikethrough setting is set on the text by default.
in_state | Whether a strikethrough should be drawn through the text. |
TextKey& HPS::TextKey::SetText | ( | char const * | in_string | ) |
Replaces the contents of the string for the text.
in_string | UTF8-encoded string for the text. |
TextKey& HPS::TextKey::SetTextAttributes | ( | TextAttributeKit const & | in_kit | ) |
TextKey& HPS::TextKey::SetTransform | ( | Text::Transform | in_transform | ) |
Sets the transform state for the text. No transform state is set on the text by default.
in_transform | The transform state for the text. |
TextKey& HPS::TextKey::SetUnderline | ( | bool | in_state | ) |
Sets whether an underline should be drawn under the text. No underline setting is set on the text by default.
in_state | Whether an underline should be drawn under the text. |
void HPS::TextKey::Show | ( | TextKit & | out_kit | ) | const |
bool HPS::TextKey::ShowAlignment | ( | Text::Alignment & | out_alignment, |
Text::ReferenceFrame & | out_reference_frame, | ||
Text::Justification & | out_justification | ||
) | const |
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. |
bool HPS::TextKey::ShowBold | ( | bool & | out_state | ) | const |
Shows whether the text should be bold.
out_state | Whether the text should be bold. |
bool HPS::TextKey::ShowColor | ( | Material::Type & | out_type, |
RGBAColor & | out_rgba_color, | ||
float & | out_index | ||
) | const |
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 Material::Type::ExplicitRGBAColor. |
out_index | The material index for the text. This is only valid if out_type is Material::Type::MaterialIndex. |
bool HPS::TextKey::ShowExtraSpace | ( | bool & | out_state, |
float & | out_size, | ||
Text::SizeUnits & | out_units | ||
) | const |
Shows the amount of additional space to add between characters in a text string.
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. |
bool HPS::TextKey::ShowFont | ( | UTF8 & | out_name | ) | const |
Shows the font to use for the text.
out_name | UTF8-encoded font name to use for the text. |
bool HPS::TextKey::ShowGreeking | ( | bool & | out_state, |
float & | out_size, | ||
Text::GreekingUnits & | out_units, | ||
Text::GreekingMode & | out_mode | ||
) | const |
Shows the greeking settings to use for the text.
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::TextKey::ShowItalic | ( | bool & | out_state | ) | const |
Shows whether the text should be italic.
out_state | Whether the text should be italic. |
bool HPS::TextKey::ShowLineSpacing | ( | float & | out_multiplier | ) | const |
Shows the line spacing multiplier for the text.
out_multiplier | The line spacing multiplier for the text. |
bool HPS::TextKey::ShowModellingMatrix | ( | MatrixKit & | out_matrix | ) | const |
Shows the modelling matrix for the text.
out_matrix | The modelling matrix for the text. |
bool HPS::TextKey::ShowOverline | ( | bool & | out_state | ) | const |
Shows whether an overline should be drawn over the text.
out_state | Whether an overline should be drawn over the text. |
bool HPS::TextKey::ShowPath | ( | Vector & | out_path | ) | const |
Shows the path for the text.
out_path | The path for the text. |
bool HPS::TextKey::ShowPosition | ( | Point & | out_position | ) | const |
Shows the position for the text.
out_position | The object-space position for the text. |
bool HPS::TextKey::ShowPreference | ( | float & | out_cutoff, |
Text::SizeUnits & | out_units, | ||
Text::Preference & | out_smaller, | ||
Text::Preference & | out_larger | ||
) | const |
Shows the preference for the text.
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::TextKey::ShowRegion | ( | PointArray & | out_region, |
Text::RegionAlignment & | out_region_alignment, | ||
bool & | out_region_fitting, | ||
bool & | out_region_adjust_direction, | ||
bool & | out_region_relative_coordinates, | ||
bool & | out_region_window_space | ||
) | const |
Shows the region for the text.
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::TextKey::ShowRenderer | ( | Text::Renderer & | out_renderer | ) | const |
Shows the renderer for the text.
in_renderer | The renderer for the text. |
bool HPS::TextKey::ShowRotation | ( | Text::Rotation & | out_rot, |
float & | out_angle | ||
) | const |
Shows the angle characters should be rotated within the text string.
out_rot | Whether to rotate the characters within the text string, and if so, what the angle should be measured with repect to. |
out_angle | The angle in degrees to rotate each character within the text string. |
bool HPS::TextKey::ShowSize | ( | float & | out_size, |
Text::SizeUnits & | out_units | ||
) | const |
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::TextKey::ShowSizeTolerance | ( | bool & | out_state, |
float & | out_size, | ||
Text::SizeToleranceUnits & | out_units | ||
) | const |
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::TextKey::ShowSlant | ( | float & | out_angle | ) | const |
Shows the slant angle for the text.
out_angle | The angle in degrees to slant the text. |
bool HPS::TextKey::ShowSpacing | ( | float & | out_multiplier | ) | const |
Shows the spacing multiplier for the text.
out_multiplier | The spacing multiplier for the text. |
bool HPS::TextKey::ShowStrikethrough | ( | bool & | out_state | ) | const |
Shows whether a strikethrough should be drawn through the text.
out_state | Whether a strikethrough should be drawn through the text. |
bool HPS::TextKey::ShowText | ( | UTF8 & | out_string | ) | const |
Shows the string for the text.
out_string | UTF8-encoded string for the text. |
bool HPS::TextKey::ShowTextAttributes | ( | TextAttributeKit & | out_kit | ) | const |
bool HPS::TextKey::ShowTransform | ( | Text::Transform & | out_trans | ) | const |
Shows the transform state for the text.
out_transform | The transform state for the text. |
bool HPS::TextKey::ShowUnderline | ( | bool & | out_state | ) | const |
Shows whether an underline should be drawn under the text.
out_state | Whether an underline should be drawn under the text. |
TextKey& HPS::TextKey::UnsetAlignment | ( | ) |
Removes the alignment setting from the text.
TextKey& HPS::TextKey::UnsetBold | ( | ) |
Removes the bold setting from the text.
TextKey& HPS::TextKey::UnsetColor | ( | ) |
Removes the color (RGBA or material index) from the text.
TextKey& HPS::TextKey::UnsetEverything | ( | ) |
TextKey& HPS::TextKey::UnsetExtraSpace | ( | ) |
Removes the extra space setting from the text.
TextKey& HPS::TextKey::UnsetFont | ( | ) |
Removes the font setting from the text.
TextKey& HPS::TextKey::UnsetGreeking | ( | ) |
Removes the greeking settings from the text.
TextKey& HPS::TextKey::UnsetItalic | ( | ) |
Removes the italic setting from the text.
TextKey& HPS::TextKey::UnsetLineSpacing | ( | ) |
Removes the line spacing setting from the text.
TextKey& HPS::TextKey::UnsetModellingMatrix | ( | ) |
Removes the modelling matrix from the text.
TextKey& HPS::TextKey::UnsetOverline | ( | ) |
Removes the overline setting from the text.
TextKey& HPS::TextKey::UnsetPath | ( | ) |
Removes the path from the text.
TextKey& HPS::TextKey::UnsetPreference | ( | ) |
Removes the font type preference from the text.
TextKey& HPS::TextKey::UnsetRegion | ( | ) |
Removes the region from the text.
TextKey& HPS::TextKey::UnsetRenderer | ( | ) |
Removes the renderer setting from the text.
TextKey& HPS::TextKey::UnsetRotation | ( | ) |
Removes the rotation setting from the text.
TextKey& HPS::TextKey::UnsetSize | ( | ) |
Removes the size setting from the text.
TextKey& HPS::TextKey::UnsetSizeTolerance | ( | ) |
Removes the size tolerance setting from the text.
TextKey& HPS::TextKey::UnsetSlant | ( | ) |
Removes the slant setting from the text.
TextKey& HPS::TextKey::UnsetSpacing | ( | ) |
Removes the spacing setting from the text.
TextKey& HPS::TextKey::UnsetStrikethrough | ( | ) |
Removes the strikethrough setting from the text.
TextKey& HPS::TextKey::UnsetTransform | ( | ) |
Removes the transform setting from the text.
TextKey& HPS::TextKey::UnsetUnderline | ( | ) |
Removes the underline setting from the text.