VizKit::TrackTitle Class Reference

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

#include <TrackTitle.h>

List of all members.

Public Member Functions
	TrackTitle ()
	The constructor.
	~TrackTitle ()
	The destructor.
void	show (void)
	Shows the track title action.
VisualStringStyle	getTrackInfoStringStyle (void)
	Returns the current string style of the track info string.
void	setTrackInfoImage (VisualImage &styledTrackInfoStringImage)
	Sets the image with the track info string.
uint16	getTrackInfoTextureHeightInPixels (void)
	Returns the height of the track title texture in pixels.
void	reshape (void)
	Calculates the screen position of the track title texture.
void	fadeIn (uint32 durationInMilliseconds)
	Starts fading in the texture of the track title.
void	fadeOut (uint32 durationInMilliseconds)
	Starts fading out the texture of the track title.
void	pulsate (void)
	Starts pulsating the texture (fade in / fade out) of the track title.
void	clear (void)
	Clears the memory allocated for the track title action.
void	addMoveAnimation (void)
	Adds a move animation to the asset.
Private Attributes
VisualAsset	trackInfoAsset
	The asset of the track info action (contains texture and position too).
VisualItemIdentifier	vertexChainId
	Identifier of the vertex chain (the vertices used for display of the track info string texture).

---

Detailed Description

Shows the title of the current audio track.

TrackTitle performs the action of the TrackTitleActor.

---

Constructor & Destructor Documentation

TrackTitle::TrackTitle

(

)

The constructor.

TrackTitle::~TrackTitle

(

)

The destructor.

---

Member Function Documentation

void TrackTitle::addMoveAnimation

(

void

)

Adds a move animation to the asset.

void TrackTitle::clear

(

void

)

Clears the memory allocated for the track title action.

void TrackTitle::fadeIn

(

uint32

durationInMilliseconds

)

Starts fading in the texture of the track title.

Parameters:

durationInMilliseconds

The duration of the animation measured in milliseconds.

void TrackTitle::fadeOut

(

uint32

durationInMilliseconds

)

Starts fading out the texture of the track title.

Parameters:

durationInMilliseconds

The duration of the animation measured in milliseconds.

VisualStringStyle TrackTitle::getTrackInfoStringStyle

(

void

)

Returns the current string style of the track info string.

Returns:

The current string style of the track info string.

uint16 TrackTitle::getTrackInfoTextureHeightInPixels

(

void

)

Returns the height of the track title texture in pixels.

Returns:

The height of the track title texture in pixels.

void TrackTitle::pulsate

(

void

)

Starts pulsating the texture (fade in / fade out) of the track title.

void TrackTitle::reshape

(

void

)

Calculates the screen position of the track title texture.

void TrackTitle::setTrackInfoImage

(

VisualImage &

styledTrackInfoStringImage

)

Sets the image with the track info string.

Parameters:

styledTrackInfoStringImage

The image with the track info string.

void TrackTitle::show

(

void

)

Shows the track title action.

---

Member Data Documentation

VisualAsset VizKit::TrackTitle::trackInfoAsset [private]

The asset of the track info action (contains texture and position too).

VisualItemIdentifier VizKit::TrackTitle::vertexChainId [private]

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

---

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

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