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

cellWidth	maximum width of a character cell in the text box
cellHeight	height of a character cell in the text box
cellYScale	unused
shadow	true if text box has shadow enabled
shadowOffset	offset for shadow
shadowColor	color of shadow in text box
underlineOffset	offset of underline
underlineSize	size of underline
halo	true if text box has halo enabled
haloOffset	offset for halo
haloColor	color of halo in text box
leftToRight	true 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.

Post Process the given character attributes

Parameters

charAttr	attributes in question
c	the character code to process.
cellX	x coord of character cell
charY	y coord of character cell
cellWidth	the width of the current character
endOfLine	true if character was the end of the current line

Pre Process the given character attributes

Parameters

charAttr	attributes in question
c	the character code to process.
cellX	x coord of character cell
charY	y 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: