A VisualTextAutoScrollView displays rendered text. More...

#include <VisualTextAutoScrollView.h>

Inheritance diagram for VizKit::VisualTextAutoScrollView:

Classes
class	VisualTextAutoScrollViewTextLineImageRecord
Public Member Functions
	VisualTextAutoScrollView ()
	The constructor.
	~VisualTextAutoScrollView ()
	The destructor.
	VisualTextAutoScrollView (const VisualTextAutoScrollView &other)
	Copy constructor.
VisualTextAutoScrollView &	operator= (const VisualTextAutoScrollView &other)
	Assignment operator.
bool	operator< (const VisualTextAutoScrollView &other) const
	Less than operator.
bool	operator== (const VisualTextAutoScrollView &other) const
	Equality operator.
bool	operator!= (const VisualTextAutoScrollView &other) const
	Inequality operator.
virtual VisualTextAutoScrollView *	clone (void) const
	Copies the current VisualTextAutoScrollView and returns a pointer to a new VisualTextAutoScrollView.
void	setStyledString (VisualStyledString &aStyledString)
	Sets the visual string.
const VisualStyledString *const	getStyledString (void)
	Returns the styled string.
void	setStringStyle (VisualStringStyle aStringStyle)
	Sets the style of the visual string.
VisualStringStyle	getStringStyle (void)
	Returns the current string style.
void	draw (float aCurrAudioPlayProgressValue)
	Draws the visual string.
void	refreshLayout (void)
	Refreshes the layout based on current canvas size.
PixelRect	getViewRect (void)
	Returns the pixel rect of the view.
void	setDisplayedPixelHeight (size_t aDisplayedPixelHeight)
	Sets the height of the displayed view in pixels inside which the content is clipped.
Private Member Functions
void	copy (const VisualTextAutoScrollView &other)
	Copy method for assignment operator and copy constructor.
void	refreshTextlineImageData (float aProgressValue)
	Loads as much image data as necessary.
void	calculateFirstAndLastTextLineIndexToShow (float aProgressValue)
	Calculates the first and the last index of text lines to show.
float	convertProgressValueToInternalProgressValue (float aCurrAudioPlayProgressValue)
	Converts the passed-in progress values of audio play progress to the internally used progress value for auto-scrolling.
size_t	completeTextLinesPixelHeight (void)
	The pixel height of all text lines summed up.
Private Attributes
VisualStyledString *	textScrollViewStyledString
	The styled string to be displayed in the scroll view.
std::vector < VisualTextAutoScrollViewTextLineImageRecord * >	textScrollViewImageVector
	The vector with image data per text line.
size_t	firstTextLineIndexToShow
	The index of the first text line that needs to be shown (and needs to be loaded as image).
size_t	lastTextLineIndexToShow
	The index of the last text line that needs to be shown (and needs to be loaded as image).
size_t	longestTextLinePixelWidth
	The pixel width of the longest text line image.
size_t	displayedPixelHeight
	The maximum number of vertically displayed pixels.

Detailed Description

A VisualTextAutoScrollView displays rendered text.

Text that does not fit inside the view bounds is scrolled in automatically. Scrolling speed and scrolling position depends on the auto play position that is passed in with the draw method. Only text lines currently being displayed are rendered into images.

Constructor & Destructor Documentation

VisualTextAutoScrollView::VisualTextAutoScrollView ( )

The constructor.

VisualTextAutoScrollView::~VisualTextAutoScrollView ( )

The destructor.

VisualTextAutoScrollView::VisualTextAutoScrollView ( const VisualTextAutoScrollView & other )

Copy constructor.

Parameters:

other Reference to another VisualTextAutoScrollView.

Member Function Documentation

void VisualTextAutoScrollView::calculateFirstAndLastTextLineIndexToShow ( float aProgressValue ) [private]

Calculates the first and the last index of text lines to show.

Parameters:

aProgressValue Progress of the scrolling (range: 0.0 to 1.0).

VisualTextAutoScrollView * VisualTextAutoScrollView::clone ( void ) const [virtual]

Copies the current VisualTextAutoScrollView and returns a pointer to a new VisualTextAutoScrollView.

Implements VizKit::VisualObject.

size_t VisualTextAutoScrollView::completeTextLinesPixelHeight ( void ) [private]

The pixel height of all text lines summed up.

float VisualTextAutoScrollView::convertProgressValueToInternalProgressValue ( float aCurrAudioPlayProgressValue ) [private]

Converts the passed-in progress values of audio play progress to the internally used progress value for auto-scrolling.

Parameters:

aCurrAudioPlayProgressValue Progress of the audio track (range: 0.0 to 1.0).

void VisualTextAutoScrollView::copy ( const VisualTextAutoScrollView & other ) [private]

Copy method for assignment operator and copy constructor.

Parameters:

other Another VisualTextAutoScrollView.

void VisualTextAutoScrollView::draw ( float aCurrAudioPlayProgressValue )

Draws the visual string.

Parameters:

aCurrAudioPlayProgressValue Progress of the audio track (range: 0.0 to 1.0).

VisualStringStyle VisualTextAutoScrollView::getStringStyle ( void )

Returns the current string style.

Returns:: The current string style.

const VisualStyledString *const VisualTextAutoScrollView::getStyledString ( void )

Returns the styled string.

Returns:: The styled string.

PixelRect VisualTextAutoScrollView::getViewRect ( void )

Returns the pixel rect of the view.

bool VisualTextAutoScrollView::operator!= ( const VisualTextAutoScrollView & other ) const

Inequality operator.

Parameters:

other Another VisualTextAutoScrollView.

bool VisualTextAutoScrollView::operator< ( const VisualTextAutoScrollView & other ) const

Less than operator.

Parameters:

other Another VisualTextAutoScrollView.

Remarks:: The less than operator is used by std::map for find() and sorting (if VisualTextAutoScrollView is used as key_type).

VisualTextAutoScrollView & VisualTextAutoScrollView::operator= ( const VisualTextAutoScrollView & other )

Assignment operator.

Parameters:

other Reference to another VisualTextAutoScrollView.

bool VisualTextAutoScrollView::operator== ( const VisualTextAutoScrollView & other ) const

Equality operator.

Parameters:

other Another VisualTextAutoScrollView.

void VisualTextAutoScrollView::refreshLayout ( void )

Refreshes the layout based on current canvas size.

void VisualTextAutoScrollView::refreshTextlineImageData ( float aProgressValue ) [private]

Loads as much image data as necessary.

Parameters:

aProgressValue Progress of the scrolling (range: 0.0 to 1.0).

void VisualTextAutoScrollView::setDisplayedPixelHeight ( size_t aDisplayedPixelHeight )

Sets the height of the displayed view in pixels inside which the content is clipped.

Parameters:

aDisplayedPixelHeight The maximum pixel height of the view content.

void VisualTextAutoScrollView::setStringStyle ( VisualStringStyle aStringStyle )

Sets the style of the visual string.

Parameters:

aStringStyle A string style.

void VisualTextAutoScrollView::setStyledString ( VisualStyledString & aStyledString )

Sets the visual string.

Parameters:

aStyledString Reference to a styled string.

Member Data Documentation

size_t VizKit::VisualTextAutoScrollView::displayedPixelHeight [private]

The maximum number of vertically displayed pixels.

size_t VizKit::VisualTextAutoScrollView::firstTextLineIndexToShow [private]

The index of the first text line that needs to be shown (and needs to be loaded as image).

size_t VizKit::VisualTextAutoScrollView::lastTextLineIndexToShow [private]

The index of the last text line that needs to be shown (and needs to be loaded as image).

size_t VizKit::VisualTextAutoScrollView::longestTextLinePixelWidth [private]

The pixel width of the longest text line image.

std::vector<VisualTextAutoScrollViewTextLineImageRecord *> VizKit::VisualTextAutoScrollView::textScrollViewImageVector [private]

The vector with image data per text line.

VisualStyledString* VizKit::VisualTextAutoScrollView::textScrollViewStyledString [private]

The styled string to be displayed in the scroll view.

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

vizkit/source/VisualTextAutoScrollView.h
vizkit/source/VisualTextAutoScrollView.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation