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_track.html | 923 ++++++++++++++++++++++++++++++++ 1 file changed, 923 insertions(+) create mode 100644 Doc/doxygen/html/class_music_track.html (limited to 'Doc/doxygen/html/class_music_track.html') diff --git a/Doc/doxygen/html/class_music_track.html b/Doc/doxygen/html/class_music_track.html new file mode 100644 index 0000000..27d33ed --- /dev/null +++ b/Doc/doxygen/html/class_music_track.html @@ -0,0 +1,923 @@ + + + + + +Starshatter_Open: MusicTrack Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Protected Attributes
+
+
MusicTrack Class Reference
+
+
+ +

#include <MusicTrack.h>

+ +

List of all members.

+ + + +

+Public Types

enum  STATE {
+  NONE, +FADE_IN, +PLAY, +FADE_OUT, +
+  STOP +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MusicTrack (const Text &name, int mode=0, int index=0)
virtual ~MusicTrack ()
virtual void ExecFrame ()
virtual void Play ()
virtual void Stop ()
virtual void FadeIn ()
virtual void FadeOut ()
const Text & Name () const
Sound * GetSound () const
int GetState () const
int GetMode () const
int GetIndex () const
int IsReady () const
int IsPlaying () const
int IsDone () const
int IsLooped () const
virtual long GetVolume () const
virtual void SetVolume (long v)
virtual double GetTotalTime () const
virtual double GetTimeRemaining () const
virtual double GetTimeElapsed () const
virtual double GetFadeTime () const
virtual void SetFadeTime (double t)
+ + + + + + + + +

+Protected Attributes

Text name
Sound * sound
int state
int mode
int index
double fade
double fade_time
+

Detailed Description

+
+

Definition at line 29 of file MusicTrack.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum MusicTrack::STATE
+
+
Enumerator:
+ + + + + +
NONE  +
FADE_IN  +
PLAY  +
FADE_OUT  +
STOP  +
+
+
+ +

Definition at line 32 of file MusicTrack.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
MusicTrack::MusicTrack (const Text & name,
int mode = 0,
int index = 0 
)
+
+ +

Definition at line 33 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
MusicTrack::~MusicTrack ()
+ 		+virtual
+
+ +

Definition at line 69 of file MusicTrack.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void MusicTrack::ExecFrame ()
+ 		+virtual
+
+ +

Definition at line 80 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicTrack::FadeIn ()
+ 		+virtual
+
+ +

Definition at line 163 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicTrack::FadeOut ()
+ 		+virtual
+
+ +

Definition at line 172 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double MusicTrack::GetFadeTime () const
+ 		+inlinevirtual
+
+ +

Definition at line 64 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MusicTrack::GetIndex () const
+ 		+inline
+
+ +

Definition at line 50 of file MusicTrack.h.

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

Definition at line 49 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Sound* MusicTrack::GetSound () const
+ 		+inline
+
+ +

Definition at line 47 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MusicTrack::GetState () const
+ 		+inline
+
+ +

Definition at line 48 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double MusicTrack::GetTimeElapsed () const
+ 		+virtual
+
+ +

Definition at line 266 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double MusicTrack::GetTimeRemaining () const
+ 		+virtual
+
+ +

Definition at line 257 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double MusicTrack::GetTotalTime () const
+ 		+virtual
+
+ +

Definition at line 248 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
long MusicTrack::GetVolume () const
+ 		+virtual
+
+ +

Definition at line 221 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + + + +
int MusicTrack::IsDone () const
+
+ +

Definition at line 201 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + + + +
int MusicTrack::IsLooped () const
+
+ +

Definition at line 210 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + + + +
int MusicTrack::IsPlaying () const
+
+ +

Definition at line 192 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + + + +
int MusicTrack::IsReady () const
+
+ +

Definition at line 183 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& MusicTrack::Name () const
+ 		+inline
+
+ +

Definition at line 46 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicTrack::Play ()
+ 		+virtual
+
+ +

Definition at line 149 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MusicTrack::SetFadeTime (double t)
+ 		+inlinevirtual
+
+ +

Definition at line 65 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MusicTrack::SetVolume (long v)
+ 		+virtual
+
+ +

Definition at line 230 of file MusicTrack.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MusicTrack::Stop ()
+ 		+virtual
+
+ +

Definition at line 156 of file MusicTrack.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double MusicTrack::fade
+ 		+protected
+
+ +

Definition at line 73 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double MusicTrack::fade_time
+ 		+protected
+
+ +

Definition at line 74 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MusicTrack::index
+ 		+protected
+
+ +

Definition at line 72 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MusicTrack::mode
+ 		+protected
+
+ +

Definition at line 71 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MusicTrack::name
+ 		+protected
+
+ +

Definition at line 68 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Sound* MusicTrack::sound
+ 		+protected
+
+ +

Definition at line 69 of file MusicTrack.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MusicTrack::state
+ 		+protected
+
+ +

Definition at line 70 of file MusicTrack.h.

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