This class keeps and manage the musical instruments. More...

Public Member Functions
bool	Initialize (iObjectRegistry *objectReg)
	Reads the instruments definitions.
	InstrumentManager ()
	Constructor.
bool	PlaySong (SoundControl sndCtrl, csVector3 pos, csVector3 dir, SoundHandle &songHandle, csRef< iDocument > musicalSheet, const char *instrName)
	Play the song in the given musical sheet with the given instruments.
	~InstrumentManager ()
	Destructor.

Detailed Description

This class keeps and manage the musical instruments.

Definition at line 44 of file instrumentmngr.h.

Constructor & Destructor Documentation

InstrumentManager::InstrumentManager ( )

Constructor.

Creates an empty InstrumentManager.

InstrumentManager::~InstrumentManager ( )

Destructor.

Destroys all instruments.

bool InstrumentManager::Initialize ( iObjectRegistry * objectReg )

Reads the instruments definitions.

Parameters:

objectReg the object registry.

Returns:: false if SoundSystemManager has not been correctly initialized or if the instruments definitions are not syntactically correct.

bool InstrumentManager::PlaySong	(	SoundControl *	sndCtrl,
		csVector3	pos,
		csVector3	dir,
		SoundHandle *&	songHandle,
		csRef< iDocument >	musicalSheet,
		const char *	instrName
	)

Play the song in the given musical sheet with the given instruments.

Parameters:

sndCtrl	the SoundControl for this song.
pos	the position of the player to play this song.
dir	the direction of this sound.
songHandle	an null SongHandle that will handle the song.
musicalSheet	the XML musical sheet to play.
instrName	the name of the instruments.

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