GL Studio API
Public Member Functions | List of all members
GlsTextBox::UnderlineStrikeThruHelper Class Reference

Public Member Functions

 UnderlineStrikeThruHelper (float cellWidth, float cellHeight, float cellYScale, bool shadow, const Vector &shadowOffset, const glsColor &shadowColor, float underlineOffset, float underlineSize, bool halo, float haloOffset, glsColor haloColor, bool leftToRight)
 
void NewRow (void)
 
void PreProcessCharacter (const CharAttr_t &charAttr, const Char_t &c, float cellX, float charY)
 
void PostProcessCharacter (const CharAttr_t &charAttr, const Char_t &c, float cellX, float charY, float cellWidth, bool endOfLine)
 
void RenderLineSegments (void)
 

Constructor & Destructor Documentation

UnderlineStrikeThruHelper ( float  cellWidth,
float  cellHeight,
float  cellYScale,
bool  shadow,
const Vector shadowOffset,
const glsColor shadowColor,
float  underlineOffset,
float  underlineSize,
bool  halo,
float  haloOffset,
glsColor  haloColor,
bool  leftToRight 
)
Parameters
cellWidthmaximum width of a character cell in the text box
cellHeightheight of a character cell in the text box
cellYScaleunused
shadowtrue if text box has shadow enabled
shadowOffsetoffset for shadow
shadowColorcolor of shadow in text box
underlineOffsetoffset of underline
underlineSizesize of underline
halotrue if text box has halo enabled
haloOffsetoffset for halo
haloColorcolor of halo in text box
leftToRighttrue if text flows left to right else false for right to left

Member Function Documentation

void NewRow ( void  )

Setup to process a new row in the text box.

void PostProcessCharacter ( const CharAttr_t charAttr,
const Char_t &  c,
float  cellX,
float  charY,
float  cellWidth,
bool  endOfLine 
)

Post Process the given character attributes

Parameters
charAttrattributes in question
cthe character code to process.
cellXx coord of character cell
charYy coord of character cell
cellWidththe width of the current character
endOfLinetrue if character was the end of the current line
void PreProcessCharacter ( const CharAttr_t charAttr,
const Char_t &  c,
float  cellX,
float  charY 
)

Pre Process the given character attributes

Parameters
charAttrattributes in question
cthe character code to process.
cellXx coord of character cell
charYy coord of character
void RenderLineSegments ( void  )

Render the line segments for the underline / strikethru


The documentation for this class was generated from the following file: