VizKit::CoverArt Class Reference

The cover artwork image is displayed. More...

#include <CoverArt.h>

List of all members.

Public Member Functions
	CoverArt ()
	The constructor.
	~CoverArt ()
	The destructor.
void	prepareCoverAction (void)
	Prepares the action of the cover art.
void	showCover ()
	Shows the cover art.
void	finishCoverAction (void)
	Finishes the action of the cover art.
void	setAlbumCoverArtWorkImage (VisualImage &albumCoverArtworkImage)
	Sets the image with the artwork of the album cover.
void	reshape (void)
	Calculates the screen position of the cover art.
void	fadeIn (uint32 durationInMilliseconds)
	Starts fading in the texture of the album cover artwork.
void	fadeOut (uint32 durationInMilliseconds, double stopValue=0.0)
	Starts fading out the texture of the album cover artwork.
void	rotate (void)
	Starts rotating the texture of the album cover artwork.
double	calcCoordDepth (void)
	Calculates the coord depth.
void	scaleSize (uint32 durationInMilliseconds, double from, double to)
	Scales the cover art by multiplying with the provided scaleFactor.
void	clear (void)
	Clears the memory allocated for the album cover artwork.
Private Attributes
VisualAsset	coverArtAsset
	The asset of the cover art (contains texture and position, too).
VisualItemIdentifier	vertexChainId
	Identifier of the vertex chain (the vertices used for display of the album cover artwork texture).

---

Detailed Description

The cover artwork image is displayed.

CoverArt performs the action of the CoverArtActor.

---

Constructor & Destructor Documentation

CoverArt::CoverArt

(

)

The constructor.

CoverArt::~CoverArt

(

)

The destructor.

---

Member Function Documentation

double CoverArt::calcCoordDepth

(

void

)

Calculates the coord depth.

void CoverArt::clear

(

void

)

Clears the memory allocated for the album cover artwork.

void CoverArt::fadeIn

(

uint32

durationInMilliseconds

)

Starts fading in the texture of the album cover artwork.

Parameters:

durationInMilliseconds

The duration of the animation measured in milliseconds.

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

Starts fading out the texture of the album cover artwork.

Parameters:

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

void CoverArt::finishCoverAction

(

void

)

Finishes the action of the cover art.

void CoverArt::prepareCoverAction

(

void

)

Prepares the action of the cover art.

void CoverArt::reshape

(

void

)

Calculates the screen position of the cover art.

void CoverArt::rotate

(

void

)

Starts rotating the texture of the album cover artwork.

void CoverArt::scaleSize	(	uint32	durationInMilliseconds,
		double	from,
		double	to
	)

Scales the cover art by multiplying with the provided scaleFactor.

Parameters:

durationInMilliseconds	The duration of the animation measured in milliseconds.
from	The start scale factor of the animation.
to	The end scale factor of the animation.

void CoverArt::setAlbumCoverArtWorkImage

(

VizKit::VisualImage &

albumCoverArtworkImage

)

Sets the image with the artwork of the album cover.

Parameters:

albumCoverArtworkImage

The image with the artwork of the album cover.

void CoverArt::showCover

(

)

Shows the cover art.

---

Member Data Documentation

VisualAsset VizKit::CoverArt::coverArtAsset [private]

The asset of the cover art (contains texture and position, too).

VisualItemIdentifier VizKit::CoverArt::vertexChainId [private]

Identifier of the vertex chain (the vertices used for display of the album cover artwork texture).

---

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

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