From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_music_director.html | 1076 ++++++++++++++++++++++++++++ 1 file changed, 1076 insertions(+) create mode 100644 Doc/doxygen/html/class_music_director.html (limited to 'Doc/doxygen/html/class_music_director.html') diff --git a/Doc/doxygen/html/class_music_director.html b/Doc/doxygen/html/class_music_director.html new file mode 100644 index 0000000..6e426dd --- /dev/null +++ b/Doc/doxygen/html/class_music_director.html @@ -0,0 +1,1076 @@ + + + + + +Starshatter_Open: MusicDirector Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
MusicDirector Class Reference
+
+
+ +

#include <MusicDirector.h>

+ +

List of all members.

+ + + + +

+Public Types

enum  MODES {
+  NONE, +MENU, +INTRO, +BRIEFING, +
+  DEBRIEFING, +PROMOTION, +VICTORY, +DEFEAT, +
+  CREDITS, +FLIGHT, +COMBAT, +LAUNCH, +
+  RECOVERY, +SHUTDOWN +
+ }
enum  TRANSITIONS {
+  CUT, +FADE_OUT, +FADE_IN, +FADE_BOTH, +
+  CROSS_FADE +
+ }
+ + + + + + + +

+Public Member Functions

 MusicDirector ()
 ~MusicDirector ()
void ExecFrame ()
void ScanTracks ()
int CheckMode (int mode)
int GetMode () const
+ + + + + + + +

+Static Public Member Functions

static void Initialize ()
static void Close ()
static MusicDirector * GetInstance ()
static void SetMode (int mode)
static const char * GetModeName (int mode)
static bool IsNoMusic ()
+ + + + + +

+Protected Member Functions

void StartThread ()
void StopThread ()
void GetNextTrack (int index)
void ShuffleTracks ()
+ + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

int mode
int transition
MusicTrack * track
MusicTrack * next_track
List< Text > menu_tracks
List< Text > intro_tracks
List< Text > brief_tracks
List< Text > debrief_tracks
List< Text > promote_tracks
List< Text > flight_tracks
List< Text > combat_tracks
List< Text > launch_tracks
List< Text > recovery_tracks
List< Text > victory_tracks
List< Text > defeat_tracks
List< Text > credit_tracks
bool no_music
HANDLE hproc
ThreadSync sync
+

Detailed Description

+
+

Definition at line 30 of file MusicDirector.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum MusicDirector::MODES
+
+
Enumerator:
+ + + + + + + + + + + + + + +
NONE  +
MENU  +
INTRO  +
BRIEFING  +
DEBRIEFING  +
PROMOTION  +
VICTORY  +
DEFEAT  +
CREDITS  +
FLIGHT  +
COMBAT  +
LAUNCH  +
RECOVERY  +
SHUTDOWN  +
+
+
+ +

Definition at line 33 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + +
enum MusicDirector::TRANSITIONS
+
+
Enumerator:
+ + + + + +
CUT  +
FADE_OUT  +
FADE_IN  +
FADE_BOTH  +
CROSS_FADE  +
+
+
+ +

Definition at line 58 of file MusicDirector.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
MusicDirector::MusicDirector ()
+
+ +

Definition at line 30 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + + + +
MusicDirector::~MusicDirector ()
+
+ +

Definition at line 42 of file MusicDirector.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
int MusicDirector::CheckMode (int mode)
+
+ +

Definition at line 321 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicDirector::Close ()
+ 		+static
+
+ +

Definition at line 76 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + + + +
void MusicDirector::ExecFrame ()
+
+ +

Definition at line 91 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
MusicDirector * MusicDirector::GetInstance ()
+ 		+static
+
+ +

Definition at line 83 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MusicDirector::GetMode () const
+ 		+inline
+
+ +

Definition at line 74 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * MusicDirector::GetModeName (int mode)
+ 		+static
+
+ +

Definition at line 248 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MusicDirector::GetNextTrack (int index)
+ 		+protected
+
+ +

Definition at line 376 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicDirector::Initialize ()
+ 		+static
+
+ +

Definition at line 69 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool MusicDirector::IsNoMusic ()
+ 		+static
+
+ +

Definition at line 365 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + + + +
void MusicDirector::ScanTracks ()
+
+ +

Definition at line 147 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MusicDirector::SetMode (int mode)
+ 		+static
+
+ +

Definition at line 273 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicDirector::ShuffleTracks ()
+ 		+protected
+
+ +

Definition at line 427 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicDirector::StartThread ()
+ 		+protected
+
+ +

Definition at line 462 of file MusicDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicDirector::StopThread ()
+ 		+protected
+
+ +

Definition at line 495 of file MusicDirector.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::brief_tracks
+ 		+protected
+
+ +

Definition at line 97 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::combat_tracks
+ 		+protected
+
+ +

Definition at line 101 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::credit_tracks
+ 		+protected
+
+ +

Definition at line 106 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::debrief_tracks
+ 		+protected
+
+ +

Definition at line 98 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::defeat_tracks
+ 		+protected
+
+ +

Definition at line 105 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::flight_tracks
+ 		+protected
+
+ +

Definition at line 100 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
HANDLE MusicDirector::hproc
+ 		+protected
+
+ +

Definition at line 110 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::intro_tracks
+ 		+protected
+
+ +

Definition at line 96 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::launch_tracks
+ 		+protected
+
+ +

Definition at line 102 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::menu_tracks
+ 		+protected
+
+ +

Definition at line 95 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MusicDirector::mode
+ 		+protected
+
+ +

Definition at line 89 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MusicTrack* MusicDirector::next_track
+ 		+protected
+
+ +

Definition at line 93 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool MusicDirector::no_music
+ 		+protected
+
+ +

Definition at line 108 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::promote_tracks
+ 		+protected
+
+ +

Definition at line 99 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::recovery_tracks
+ 		+protected
+
+ +

Definition at line 103 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
ThreadSync MusicDirector::sync
+ 		+protected
+
+ +

Definition at line 111 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MusicTrack* MusicDirector::track
+ 		+protected
+
+ +

Definition at line 92 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MusicDirector::transition
+ 		+protected
+
+ +

Definition at line 90 of file MusicDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Text> MusicDirector::victory_tracks
+ 		+protected
+
+ +

Definition at line 104 of file MusicDirector.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1