VizKit::TrackLyrics Class Reference

Shows the lyrics of the current audio track. More...

#include <TrackLyrics.h>

List of all members.

Public Member Functions
	TrackLyrics ()
	The constructor.
	~TrackLyrics ()
	The destructor.
void	show (uint32 anElapsedAudioTime, uint32 aRemainingAudioTime)
	Shows the track lyrics action.
VisualStringStyle	getTrackLyricsStringStyle (void)
	Returns the current string style of the track lyrics string.
void	setTrackLyricsString (VisualStyledString &aTrackLyricsString)
	Sets the track lyrics string.
void	refresh (void)
	Refreshes the layout based on current canvas size.
void	fadeIn (uint32 durationInMilliseconds, bool startWithCurrentOpacityValue)
	Starts fading in the texture of the track lyrics.
void	fadeOut (uint32 durationInMilliseconds, double stopValue=0.0)
	Starts fading out the texture of the track lyrics.
void	clear (void)
	Clears the memory allocated for the track lyrics action.
Static Private Member Functions
static void	animateOpacity (double currentPosition, void *userData)
	Callback of the opacity animation.
Private Attributes
VisualTextAutoScrollView *	trackLyricsAutoScrollView
	The VisualTextAutoScrollView of the track lyrics action.
VisualItemIdentifier	vertexChainId
	Identifier of the vertex chain (the vertices used for display of the track lyrics string texture).
VisualItemIdentifier	opacityAnimationIdentifier
	Identifier of the fade in and fade out animation.

---

Detailed Description

Shows the lyrics of the current audio track.

TrackLyrics performs the action of the TrackLyricsActor.

---

Constructor & Destructor Documentation

TrackLyrics::TrackLyrics

(

)

The constructor.

TrackLyrics::~TrackLyrics

(

)

The destructor.

---

Member Function Documentation

void TrackLyrics::animateOpacity	(	double	currentPosition,
		void *	userData
	)		[static, private]

Callback of the opacity animation.

void TrackLyrics::clear

(

void

)

Clears the memory allocated for the track lyrics action.

void TrackLyrics::fadeIn	(	uint32	durationInMilliseconds,
		bool	startWithCurrentOpacityValue
	)

Starts fading in the texture of the track lyrics.

Parameters:

durationInMilliseconds	The duration of the animation measured in milliseconds.
startWithCurrentOpacityValue	If yes, the animation starts with the current opacity value. If no, the animation starts with 0 opacity.

void TrackLyrics::fadeOut	(	uint32	durationInMilliseconds,
		double	stopValue = 0.0
	)

Starts fading out the texture of the track lyrics.

Parameters:

durationInMilliseconds	The duration of the animation measured in milliseconds.
stopValue	The stop value of the fade out process (default = 0.0f).

VisualStringStyle TrackLyrics::getTrackLyricsStringStyle

(

void

)

Returns the current string style of the track lyrics string.

Returns:

The current string style of the track lyrics string.

void TrackLyrics::refresh

(

void

)

Refreshes the layout based on current canvas size.

void TrackLyrics::setTrackLyricsString

(

VisualStyledString &

aTrackLyricsString

)

Sets the track lyrics string.

Parameters:

aTrackLyricsString

The styled track lyrics string.

void TrackLyrics::show	(	uint32	anElapsedAudioTime,
		uint32	aRemainingAudioTime
	)

Shows the track lyrics action.

Parameters:

anElapsedAudioTime	The elapsed audio time.
aRemainingAudioTime	The remaining audio time.

---

Member Data Documentation

VisualItemIdentifier VizKit::TrackLyrics::opacityAnimationIdentifier [private]

Identifier of the fade in and fade out animation.

VisualTextAutoScrollView* VizKit::TrackLyrics::trackLyricsAutoScrollView [private]

The VisualTextAutoScrollView of the track lyrics action.

VisualItemIdentifier VizKit::TrackLyrics::vertexChainId [private]

Identifier of the vertex chain (the vertices used for display of the track lyrics string texture).

---

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

• vizkit/source/Actions/TrackLyrics.h
• vizkit/source/Actions/TrackLyrics.cpp