iso::flock::PoemManager Class Reference

#include <iso_flock_poem_manager.h>

Collaboration diagram for iso::flock::PoemManager:

[legend]List of all members.

Public Member Functions
void	destroy ()
	destroy poem manager singleton instance
void	setGLPanel (GLPanel *pGLPanel)
	set flock display
void	setFont (const base::String &pFontPath)
	set default font for rendering poem texts
void	addPoem (Poem *pPoem)
	add poem
void	addPoem (const base::String &pText, real pFontSize, real pFontHSpacingCorrection, const math::Vector3< real > &pTextPosition)
	add poem text
void	selectPoem (unsigned int pPoemIndex)
	select poem
void	switchPoem ()
	switch to next poem
void	notify ()
	notify poem manager to progress with it's poem presentation
Static Public Member Functions
static PoemManager &	get ()
	retrieve poem manager singleton instance
Protected Member Functions
	PoemManager ()
	default constructor
	~PoemManager ()
	destructor
void	updatePoemProgress ()
	update poem
Protected Attributes
QVector< Poem * >	mPoems
	poems
int	mCurrentPoemIndex
	current poem index
int	mNextPoemIndex
	next poem index
bool	mChangePoem
	flag whether poem needs to be changed or not
real	mChangeXOffset
unsigned int	mChangeStepCount
font::FontSplineCollection *	mFontSplines
	font splines
GLPanel *	mGLPanel
	flock display
QVector< space::SplineShape * >	mTextShapes
	all text spline shapes
Static Protected Attributes
static PoemManager *	sPoemManager
	singleton instance
static base::String	sDefaultFontFile
	default font file

---

Constructor & Destructor Documentation

PoemManager::PoemManager

(

)

[protected]

default constructor

PoemManager::~PoemManager

(

)

[protected]

destructor

---

Member Function Documentation

PoemManager & PoemManager::get

(

)

[static]

retrieve poem manager singleton instance

Returns:

poem manager singleton instance

void PoemManager::destroy

(

)

destroy poem manager singleton instance

void PoemManager::setGLPanel

(

GLPanel *

pGLPanel

)

set flock display

Parameters:

pGLPanel

flock display

void PoemManager::setFont

(

const base::String &

pFontPath

)

set default font for rendering poem texts

Parameters:

pFontPath

full path to font file

void PoemManager::addPoem

(

Poem *

pPoem

)

add poem

Parameters:

pPoem

poem

void PoemManager::addPoem	(	const base::String &	pText,
		real	pFontSize,
		real	pFontHSpacingCorrection,
		const math::Vector3< real > &	pTextPosition
	)

add poem text

Parameters:

	pText	poem text
	pFontSize	font size
	pFontHSpacingCorrection	horizontal font spacing correction
	pTextPosition	text position in visual space

void PoemManager::selectPoem

(

unsigned int

pPoemIndex

)

select poem

Parameters:

pPoemIndex

poem index

void PoemManager::switchPoem

(

)

switch to next poem

switches to next poem or start at first poem if no more next poems are available

void PoemManager::notify

(

)

notify poem manager to progress with it's poem presentation

void PoemManager::updatePoemProgress

(

)

[protected]

update poem

---

Member Data Documentation

PoemManager * PoemManager::sPoemManager [static, protected]

singleton instance

base::String PoemManager::sDefaultFontFile [static, protected]

default font file

QVector<Poem*> iso::flock::PoemManager::mPoems [protected]

poems

int iso::flock::PoemManager::mCurrentPoemIndex [protected]

current poem index

int iso::flock::PoemManager::mNextPoemIndex [protected]

next poem index

bool iso::flock::PoemManager::mChangePoem [protected]

flag whether poem needs to be changed or not

real iso::flock::PoemManager::mChangeXOffset [protected]

unsigned int iso::flock::PoemManager::mChangeStepCount [protected]

font::FontSplineCollection* iso::flock::PoemManager::mFontSplines [protected]

font splines

GLPanel* iso::flock::PoemManager::mGLPanel [protected]

flock display

QVector<space::SplineShape*> iso::flock::PoemManager::mTextShapes [protected]

all text spline shapes

---

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

• /Users/dbisig/programming/swarms/trunk/flock/trunk/code/iso_flock_poem_manager.h
• /Users/dbisig/programming/swarms/trunk/flock/trunk/code/iso_flock_poem_manager.cpp

---