VizKit::TemplateActor Class Reference

A template of a VisualActor. More...

#include <TemplateActor.h>

Inheritance diagram for VizKit::TemplateActor:

List of all members.

Public Member Functions
	TemplateActor ()
	The constructor.
	~TemplateActor ()
	The destructor.
virtual void	init (void)
	Initialization.
virtual void	show (const VisualPlayerState &visualPlayerState)
	Performs the show of the template.
virtual void	handleNotification (VisualNotification &aNotification)
	The actor receives a notification about an event that occured.
void	handleSimilarArtistsStringCompleted ()
	Notification call when string data is completely loaded and constructed.
Private Member Functions
void	createStringOfSimilarArtists (void)
	Initiates the creation of the string of similar artists by using URL request.
void	setStringOfSimilarArtists (const VisualString &similarArtists)
	Sets the similar artists and creates the bitmap image of the string.
Private Attributes
TemplateAction *	theTemplateAction
	A pointer to the template action.
VisualItemIdentifier	similarArtistsStringRequestId
	Identifier for string request.
VisualImage	similarArtistsStringImage
VisualString *	stringOfSimilarArtists
std::vector< VisualString >	similarArtistsStringVector
	Vector with lines of similar artists.
bool	similarArtistsStringCreationInProgress
	True if similar artists string is currently created.
VisualItemIdentifier	similarArtistsCurrentTrackIdentifier
	Identifier of the current audio track for which simolar artists are queried.

---

Detailed Description

A template of a VisualActor.

A copy of header and implementation file can be made to create a new concrete subclass of VisualActor.

---

Constructor & Destructor Documentation

TemplateActor::TemplateActor

(

)

The constructor.

TemplateActor::~TemplateActor

(

)

The destructor.

---

Member Function Documentation

void TemplateActor::createStringOfSimilarArtists

(

void

)

[private]

Initiates the creation of the string of similar artists by using URL request.

void TemplateActor::handleNotification

(

VisualNotification &

aNotification

)

[virtual]

The actor receives a notification about an event that occured.

Parameters:

aNotification

The notification passed in.

Reimplemented from VizKit::VisualActor.

void TemplateActor::handleSimilarArtistsStringCompleted

(

)

Notification call when string data is completely loaded and constructed.

void TemplateActor::init

(

void

)

[virtual]

Initialization.

Reimplemented from VizKit::VisualActor.

void TemplateActor::setStringOfSimilarArtists

(

const VisualString &

similarArtists

)

[private]

Sets the similar artists and creates the bitmap image of the string.

Parameters:

similarArtists

String with similar artists.

void TemplateActor::show

(

const VisualPlayerState &

visualPlayerState

)

[virtual]

Performs the show of the template.

Parameters:

visualPlayerState

Read-only access to the VisualPlayerState.

Reimplemented from VizKit::VisualActor.

---

Member Data Documentation

VisualItemIdentifier VizKit::TemplateActor::similarArtistsCurrentTrackIdentifier [private]

Identifier of the current audio track for which simolar artists are queried.

bool VizKit::TemplateActor::similarArtistsStringCreationInProgress [private]

True if similar artists string is currently created.

VisualImage VizKit::TemplateActor::similarArtistsStringImage [private]

VisualItemIdentifier VizKit::TemplateActor::similarArtistsStringRequestId [private]

Identifier for string request.

std::vector<VisualString> VizKit::TemplateActor::similarArtistsStringVector [private]

Vector with lines of similar artists.

VisualString* VizKit::TemplateActor::stringOfSimilarArtists [private]

TemplateAction* VizKit::TemplateActor::theTemplateAction [private]

A pointer to the template action.

---

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

• vizkit/source/Actors/TemplateActor.h
• vizkit/source/Actors/TemplateActor.cpp