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	ProcessCharacter (const CharAttr_t &charAttr, float cellX, float nextCellX, float charY, bool endOfLine)

void	RenderLineSegments (void)

Detailed Description

helper class for processing underline and strike-thru when drawing text grid

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	width of a character cell in the text grid
cellHeight	height of a character cell in the text grid
cellYScale	unused
shadow	true if text grid has shadow enabled
shadowOffset	offset for shadow
shadowColor	color of shadow in text grid
underlineOffset	offset of underline
underlineSize	size of underline
halo	true if text grid has halo enabled
haloOffset	offset for halo
haloColor	color of halo in text grid
leftToRight	true if text flows left to right else false for right to left

void NewRow ( void )

Setup to process a new row in the text grid

Pre Process the given character attributes

Parameters

charAttr	attributes in question
cellX	x coord of character cell
nextCellX	x coord of character cell one past the given character
charY	y coord of character
endOfLine	true if character was the end of the current line

void RenderLineSegments ( void )

Render the line segments for the underline / strikethru

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