VizKit  3.3.5
Public Member Functions | Private Member Functions | Private Attributes
VizKit::TemplateActor Class Reference

A template of a VisualActor. More...

#include <TemplateActor.h>

Inheritance diagram for VizKit::TemplateActor:
VizKit::VisualActor

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

TemplateActiontheTemplateAction
 A pointer to the template action.
VisualItemIdentifier similarArtistsStringRequestId
 Identifier for string request.
VisualImage similarArtistsStringImage
VisualStringstringOfSimilarArtists
std::vector< VisualStringsimilarArtistsStringVector
 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

The constructor.

The destructor.


Member Function Documentation

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:
aNotificationThe notification passed in.

Reimplemented from VizKit::VisualActor.

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:
similarArtistsString with similar artists.
void TemplateActor::show ( const VisualPlayerState visualPlayerState) [virtual]

Performs the show of the template.

Parameters:
visualPlayerStateRead-only access to the VisualPlayerState.

Reimplemented from VizKit::VisualActor.


Member Data Documentation

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

True if similar artists string is currently created.

Identifier for string request.

Vector with lines of similar artists.

A pointer to the template action.


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

Generated on Sun Oct 19 2014 00:33:17 for VizKit by doxygen 1.8.0