Handles the TKE_Text_Font opcode. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
float | GetExtraSpace () const |
int | GetExtraSpaceUnits () const |
float | GetGreekingLimit () const |
int | GetGreekingLimitUnits () const |
int | GetGreekingMode () const |
int | GetLayout () const |
float | GetLineSpacing () const |
int | GetMask () const |
char const * | GetNames () const |
char * | GetNames () |
int | GetPreference () const |
float | GetPreferenceCutoff () const |
int | GetPreferenceCutoffUnits () const |
int const * | GetPreferences () const |
int | GetRenderer () const |
float | GetRendererCutoff () const |
int | GetRendererCutoffUnits () const |
int const * | GetRenderers () const |
float | GetRotation () const |
float | GetSize () const |
int | GetSizeUnits () const |
float | GetSlant () const |
float | GetTolerance () const |
int | GetToleranceUnits () const |
int | GetTransforms () const |
int | GetValue () const |
float | GetWidthScale () const |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
void | Reset () |
void | SetExtraSpace (float s) |
void | SetExtraSpaceUnits (int u) |
void | SetGreekingLimit (float s) |
void | SetGreekingLimitUnits (int u) |
void | SetGreekingMode (int m) |
void | SetLayout (int l) |
void | SetLineSpacing (float s) |
void | SetMask (int m) |
void | SetNames (char const *names) |
void | SetNames (int length) |
void | SetPreference (int r) |
void | SetPreferenceCutoff (float s) |
void | SetPreferenceCutoffUnits (int u) |
void | SetPreferences (int r1, int r2) |
void | SetRenderer (int r) |
void | SetRendererCutoff (float s) |
void | SetRendererCutoffUnits (int u) |
void | SetRenderers (int r1, int r2) |
void | SetRotation (float r) |
void | SetSize (float s) |
void | SetSizeUnits (int u) |
void | SetSlant (float s) |
void | SetTolerance (float t) |
void | SetToleranceUnits (int u) |
void | SetTransforms (int t) |
void | SetValue (int v) |
void | SetWidthScale (float s) |
TK_Text_Font () | |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. | |
Protected Member Functions | |
void | set_names (int length) |
for internal use only | |
void | set_names (char const *names) |
for internal use only | |
Protected Attributes | |
float | m_extra_space |
for internal use only | |
float | m_greeking_limit |
for internal use only | |
unsigned char | m_greeking_mode |
for internal use only | |
unsigned char | m_greeking_units |
for internal use only | |
unsigned char | m_layout |
for internal use only | |
float | m_line_spacing |
for internal use only | |
int | m_mask |
specifies which rendering options are active (and hence, which are valid). For internal use only. | |
char * | m_names |
for internal use only | |
int | m_names_length |
for internal use only | |
float | m_preference_cutoff |
for internal use only | |
unsigned char | m_preference_cutoff_units |
for internal use only | |
int | m_preferences [2] |
for internal use only | |
float | m_renderer_cutoff |
for internal use only | |
unsigned char | m_renderer_cutoff_units |
for internal use only | |
int | m_renderers [2] |
for internal use only | |
float | m_rotation |
for internal use only | |
float | m_size |
for internal use only | |
unsigned char | m_size_units |
for internal use only | |
float | m_slant |
for internal use only | |
unsigned char | m_space_units |
for internal use only | |
float | m_tolerance |
for internal use only | |
unsigned char | m_tolerance_units |
for internal use only | |
unsigned char | m_transforms |
for internal use only | |
int | m_value |
specifies what values to set for boolean options. For internal use only. | |
float | m_width_scale |
for internal use only |
Handles the TKE_Text_Font opcode.
TK_Text_Font provides support for writing/reading the TKE_Text_Font opcode object to/from an HSF file.
The HOOPS/3dGS scene-graph supports various text attributes. Text_Font contains information about the font, including name, size, size units, spacing, spacing units, tolerance, tolerance units, slant, transforms, rotation and width scaling.
TK_Text_Font::TK_Text_Font | ( | ) | [inline] |
constructor
TK_Status TK_Text_Font::Clone | ( | BStreamFileToolkit & | tk, |
BBaseOpcodeHandler ** | handler | ||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. |
handler | A pointer to the opcode handler object. Passed by reference. |
Reimplemented from BBaseOpcodeHandler.
float TK_Text_Font::GetExtraSpace | ( | ) | const [inline] |
Returns the amount of extra space inserted between characters
int TK_Text_Font::GetExtraSpaceUnits | ( | ) | const [inline] |
Returns the units used to interpret the extra space. Units are defined in #TKO_Font_Size_Units.
float TK_Text_Font::GetGreekingLimit | ( | ) | const [inline] |
Returns the greeking limit
int TK_Text_Font::GetGreekingLimitUnits | ( | ) | const [inline] |
Returns the units used to interpret the greeking limit. Units are defined in #TKO_Font_Size_Units.
int TK_Text_Font::GetGreekingMode | ( | ) | const [inline] |
Returns the method used for handling greeked text.
int TK_Text_Font::GetLayout | ( | ) | const [inline] |
Returns the layout. Layouts are defined in TKO_Font_Layout.
float TK_Text_Font::GetLineSpacing | ( | ) | const [inline] |
Returns the spacing between lines of multi-line strings
int TK_Text_Font::GetMask | ( | ) | const [inline] |
Returns the mask indicating which font options are specified. Options are defined in TKO_Font_Options.
char const* TK_Text_Font::GetNames | ( | ) | const [inline] |
Returns the font names string
char* TK_Text_Font::GetNames | ( | ) | [inline] |
Returns the font names string buffer, which may be modified directly
int TK_Text_Font::GetPreference | ( | ) | const [inline] |
Returns which types of fonts may be used. Preferences are defined in TKO_Font_Preferences.
float TK_Text_Font::GetPreferenceCutoff | ( | ) | const [inline] |
Returns the preference cutoff limit
int TK_Text_Font::GetPreferenceCutoffUnits | ( | ) | const [inline] |
Returns the units used to interpret the preference cutoff. Units are defined in #TKO_Font_Size_Units.
int const* TK_Text_Font::GetPreferences | ( | ) | const [inline] |
Returns which types of fonts may be used. Preferences are defined in TKO_Font_Preferences.
int TK_Text_Font::GetRenderer | ( | ) | const [inline] |
Returns which types of fonts may be used. Renderers are defined in TKO_Font_Renderers.
float TK_Text_Font::GetRendererCutoff | ( | ) | const [inline] |
Returns the renderer cutoff limit
int TK_Text_Font::GetRendererCutoffUnits | ( | ) | const [inline] |
Returns the units used to interpret the renderer cutoff. Units are defined in #TKO_Font_Size_Units.
int const* TK_Text_Font::GetRenderers | ( | ) | const [inline] |
Returns which types of fonts may be used. Renderers are defined in TKO_Font_Renderers.
float TK_Text_Font::GetRotation | ( | ) | const [inline] |
Returns the rotation angle of characters
float TK_Text_Font::GetSize | ( | ) | const [inline] |
Returns the text size
int TK_Text_Font::GetSizeUnits | ( | ) | const [inline] |
Returns the units used to interpret the size. Units are defined in #TKO_Font_Size_Units.
float TK_Text_Font::GetSlant | ( | ) | const [inline] |
Returns the slant factor applied to characters
float TK_Text_Font::GetTolerance | ( | ) | const [inline] |
Returns the text size tolerance
int TK_Text_Font::GetToleranceUnits | ( | ) | const [inline] |
Returns the units used to interpret the size tolerance. Units are defined in #TKO_Font_Size_Units.
int TK_Text_Font::GetTransforms | ( | ) | const [inline] |
Returns how the string is affected by any modeling transforms. Transforms are defined in TKO_Font_Transforms.
int TK_Text_Font::GetValue | ( | ) | const [inline] |
Returns the mask indicating which font options are on/active. Options are defined in TKO_Font_Options.
float TK_Text_Font::GetWidthScale | ( | ) | const [inline] |
Returns the horizontal scaling applied to characters
TK_Status TK_Text_Font::Read | ( | BStreamFileToolkit & | tk | ) | [virtual] |
Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
void TK_Text_Font::Reset | ( | ) | [virtual] |
Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.
Reimplemented from BBaseOpcodeHandler.
void TK_Text_Font::SetExtraSpace | ( | float | s | ) | [inline] |
Sets the amount of extra space inserted between characters
void TK_Text_Font::SetExtraSpaceUnits | ( | int | u | ) | [inline] |
Sets the units used to interpret the extra space. Units are defined in #TKO_Font_Size_Units.
void TK_Text_Font::SetGreekingLimit | ( | float | s | ) | [inline] |
Sets the limit below which text drawing will be "greeked" (not drawn or drawn as simple geometry)
void TK_Text_Font::SetGreekingLimitUnits | ( | int | u | ) | [inline] |
Sets the units used to interpret the greeking limit. Units are defined in #TKO_Font_Size_Units.
void TK_Text_Font::SetGreekingMode | ( | int | m | ) | [inline] |
Sets the method used for handling greeked text.
void TK_Text_Font::SetLayout | ( | int | l | ) | [inline] |
Sets the layout. Layouts are defined in TKO_Font_Layout.
void TK_Text_Font::SetLineSpacing | ( | float | s | ) | [inline] |
Sets the spacing between lines of multi-line strings
void TK_Text_Font::SetMask | ( | int | m | ) | [inline] |
Sets the mask indicating which font options are specified. Options are defined in TKO_Font_Options.
References TKO_Font_Extended, TKO_Font_Extended2, and TKO_Font_Extended2_Mask.
void TK_Text_Font::SetNames | ( | char const * | names | ) | [inline] |
Sets the font names. Allocates the buffer and copies the names string
void TK_Text_Font::SetNames | ( | int | length | ) | [inline] |
Sets the font names buffer. Allocates a buffer large enough to hold a string of 'length' characters
void TK_Text_Font::SetPreference | ( | int | r | ) | [inline] |
Sets which drawing modes may be used. Preferences are defined in TKO_Font_Preferences.
void TK_Text_Font::SetPreferenceCutoff | ( | float | s | ) | [inline] |
Sets the limit below which text drawing will use the "lower" preference
void TK_Text_Font::SetPreferenceCutoffUnits | ( | int | u | ) | [inline] |
Sets the units used to interpret the preference cutoff. Units are defined in #TKO_Font_Size_Units.
void TK_Text_Font::SetPreferences | ( | int | r1, |
int | r2 | ||
) | [inline] |
Sets which drawing modes may be used. Preferences are defined in TKO_Font_Preferences.
void TK_Text_Font::SetRenderer | ( | int | r | ) | [inline] |
Sets which types of fonts may be used. Renderers are defined in TKO_Font_Renderers.
void TK_Text_Font::SetRendererCutoff | ( | float | s | ) | [inline] |
Sets the limit below which text drawing will use the "lower" renderer
void TK_Text_Font::SetRendererCutoffUnits | ( | int | u | ) | [inline] |
Sets the units used to interpret the renderer cutoff. Units are defined in #TKO_Font_Size_Units.
void TK_Text_Font::SetRenderers | ( | int | r1, |
int | r2 | ||
) | [inline] |
Sets which types of fonts may be used. Renderers are defined in TKO_Font_Renderers.
void TK_Text_Font::SetRotation | ( | float | r | ) | [inline] |
Sets the rotation angle of characters
void TK_Text_Font::SetSize | ( | float | s | ) | [inline] |
Sets the text size
void TK_Text_Font::SetSizeUnits | ( | int | u | ) | [inline] |
Sets the units used to interpret the size. Units are defined in #TKO_Font_Size_Units.
void TK_Text_Font::SetSlant | ( | float | s | ) | [inline] |
Sets the slant factor applied to characters
void TK_Text_Font::SetTolerance | ( | float | t | ) | [inline] |
Sets the text size tolerance
void TK_Text_Font::SetToleranceUnits | ( | int | u | ) | [inline] |
Sets the units used to interpret the size tolerance. Units are defined in #TKO_Font_Size_Units.
void TK_Text_Font::SetTransforms | ( | int | t | ) | [inline] |
Sets how the string is affected by any modeling transforms. Transforms are defined in TKO_Font_Transforms.
void TK_Text_Font::SetValue | ( | int | v | ) | [inline] |
Sets the mask indicating which font options are on/active. Options are defined in TKO_Font_Options.
void TK_Text_Font::SetWidthScale | ( | float | s | ) | [inline] |
Sets the horizontal scaling applied to characters
TK_Status TK_Text_Font::Write | ( | BStreamFileToolkit & | tk | ) | [virtual] |
Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.