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

#include <FadeView.h>

+
+Inheritance diagram for FadeView:
+
+
+ + +View + +
+ +

List of all members.

+ + + +

+Public Types

enum  FadeState {
+  StateStart, +State2, +StateIn, +StateHold, +
+  StateOut, +StateDone +
+ }
+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 FadeView (Window *c, double fade_in=1, double fade_out=1, double hold_time=4)
virtual ~FadeView ()
virtual void Refresh ()
virtual bool Done () const
virtual bool Holding () const
virtual void FastFade (int fade_fast)
virtual void FadeIn (double fade_in)
virtual void FadeOut (double fade_out)
virtual void StopHold ()
- Public Member Functions inherited from View
 View (Window *c)
virtual ~View ()
int operator== (const View &that) const
virtual void OnWindowMove ()
virtual void OnShow ()
virtual void OnHide ()
virtual void SetWindow (Window *w)
virtual Window * GetWindow ()
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + + + + + + + + +

+Protected Attributes

double fade_in
double fade_out
double hold_time
double time
double step_time
int fast
FadeState state
- Protected Attributes inherited from View
Window * window
+

Detailed Description

+
+

Definition at line 23 of file FadeView.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum FadeView::FadeState
+
+
Enumerator:
+ + + + + + +
StateStart  +
State2  +
StateIn  +
StateHold  +
StateOut  +
StateDone  +
+
+
+ +

Definition at line 28 of file FadeView.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FadeView::FadeView (Window * c,
double fade_in = 1,
double fade_out = 1,
double hold_time = 4 
)
+
+ +

Definition at line 25 of file FadeView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
FadeView::~FadeView ()
+ 		+virtual
+
+ +

Definition at line 37 of file FadeView.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool FadeView::Done () const
+ 		+inlinevirtual
+
+ +

Definition at line 35 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void FadeView::FadeIn (double fade_in)
+ 		+virtual
+
+ +

Definition at line 42 of file FadeView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void FadeView::FadeOut (double fade_out)
+ 		+virtual
+
+ +

Definition at line 43 of file FadeView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void FadeView::FastFade (int fade_fast)
+ 		+virtual
+
+ +

Definition at line 44 of file FadeView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool FadeView::Holding () const
+ 		+inlinevirtual
+
+ +

Definition at line 36 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void FadeView::Refresh ()
+ 		+virtual
+
+ +

Reimplemented from View.

+ +

Definition at line 54 of file FadeView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void FadeView::StopHold ()
+ 		+virtual
+
+ +

Definition at line 45 of file FadeView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* FadeView::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented from View.

+ +

Definition at line 26 of file FadeView.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double FadeView::fade_in
+ 		+protected
+
+ +

Definition at line 45 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double FadeView::fade_out
+ 		+protected
+
+ +

Definition at line 46 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int FadeView::fast
+ 		+protected
+
+ +

Definition at line 51 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double FadeView::hold_time
+ 		+protected
+
+ +

Definition at line 47 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
FadeState FadeView::state
+ 		+protected
+
+ +

Definition at line 52 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double FadeView::step_time
+ 		+protected
+
+ +

Definition at line 49 of file FadeView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double FadeView::time
+ 		+protected
+
+ +

Definition at line 48 of file FadeView.h.

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