SCR_FadeInOutAnimator Class Reference

Protected Member Functions
void	SCR_FadeInOutAnimator (Widget w, float fadeInSpeed, float fadeOutSpeed, float fadeOutWaitTime, bool fadeOutSetVisibleFalse=false)
void	Update (float timeSlice)
void	FadeIn (bool fadeOut=true)
void	FadeOut ()
void	FadeOutInstantly ()
void	ForceVisible (bool force)
int	GetState ()
	Returns state. See STATE_ constants.
bool	IsRunning ()
	Returns TRUE if animation is running.
ScriptInvoker	GetOnStateChanged ()

Protected Attributes
Widget	m_Widget
int	m_iState
float	m_fFadeOutWaitTime
float	m_fFadeInSpeed
float	m_fFadeOutSpeed
bool	m_bForceVisible
float	m_fTimer
bool	m_bFadeOutSetVisibleFalse
bool	m_bAutoFadeOut
const int	STATE_FADE_IN = 0
const int	STATE_FADE_OUT_WAIT = 1
const int	STATE_FADE_OUT = 2
const int	STATE_FADING_DONE = 3
ref ScriptInvoker< int, int >	m_OnStateChanged

Detailed Description

This class helps with managing fade in and fade out animations properly: You can call FadeIn() once and it will fade in Then it will stay for a fixed amount of time in this state Later it will start the fade out animation and stay in this state Or you can call ForceVisible(true/false) periodically and it will handle the transitions itself ! Remember to call Update() yourself ! It won't get called automatically.

Definition at line 8 of file SCR_FadeInOutAnimator.c.

Constructor & Destructor Documentation

SCR_FadeInOutAnimator()

void SCR_FadeInOutAnimator::SCR_FadeInOutAnimator ( Widget w, float fadeInSpeed, float fadeOutSpeed, float fadeOutWaitTime, bool fadeOutSetVisibleFalse = false )

inlineprotected

Definition at line 32 of file SCR_FadeInOutAnimator.c.

Member Function Documentation

FadeIn()

void SCR_FadeInOutAnimator::FadeIn ( bool fadeOut = true )

inlineprotected

Definition at line 133 of file SCR_FadeInOutAnimator.c.

FadeOut()

void SCR_FadeInOutAnimator::FadeOut ( )

inlineprotected

Definition at line 143 of file SCR_FadeInOutAnimator.c.

FadeOutInstantly()

void SCR_FadeInOutAnimator::FadeOutInstantly ( )

inlineprotected

Definition at line 152 of file SCR_FadeInOutAnimator.c.

ForceVisible()

void SCR_FadeInOutAnimator::ForceVisible ( bool force )

inlineprotected

Definition at line 163 of file SCR_FadeInOutAnimator.c.

GetOnStateChanged()

ScriptInvoker SCR_FadeInOutAnimator::GetOnStateChanged ( )

inlineprotected

Definition at line 182 of file SCR_FadeInOutAnimator.c.

GetState()

int SCR_FadeInOutAnimator::GetState ( )

inlineprotected

Returns state. See STATE_ constants.

Definition at line 170 of file SCR_FadeInOutAnimator.c.

IsRunning()

bool SCR_FadeInOutAnimator::IsRunning ( )

inlineprotected

Returns TRUE if animation is running.

Definition at line 177 of file SCR_FadeInOutAnimator.c.

Update()

void SCR_FadeInOutAnimator::Update ( float timeSlice )

inlineprotected

Definition at line 46 of file SCR_FadeInOutAnimator.c.

Member Data Documentation

m_bAutoFadeOut

bool SCR_FadeInOutAnimator::m_bAutoFadeOut

protected

Definition at line 20 of file SCR_FadeInOutAnimator.c.

m_bFadeOutSetVisibleFalse

bool SCR_FadeInOutAnimator::m_bFadeOutSetVisibleFalse

protected

Definition at line 19 of file SCR_FadeInOutAnimator.c.

m_bForceVisible

bool SCR_FadeInOutAnimator::m_bForceVisible

protected

Definition at line 17 of file SCR_FadeInOutAnimator.c.

m_fFadeInSpeed

float SCR_FadeInOutAnimator::m_fFadeInSpeed

protected

Definition at line 15 of file SCR_FadeInOutAnimator.c.

m_fFadeOutSpeed

float SCR_FadeInOutAnimator::m_fFadeOutSpeed

protected

Definition at line 16 of file SCR_FadeInOutAnimator.c.

m_fFadeOutWaitTime

float SCR_FadeInOutAnimator::m_fFadeOutWaitTime

protected

Definition at line 14 of file SCR_FadeInOutAnimator.c.

m_fTimer

float SCR_FadeInOutAnimator::m_fTimer

protected

Definition at line 18 of file SCR_FadeInOutAnimator.c.

m_iState

int SCR_FadeInOutAnimator::m_iState

protected

Definition at line 12 of file SCR_FadeInOutAnimator.c.

m_OnStateChanged

ref ScriptInvoker<int, int> SCR_FadeInOutAnimator::m_OnStateChanged

protected

Definition at line 29 of file SCR_FadeInOutAnimator.c.

m_Widget

Widget SCR_FadeInOutAnimator::m_Widget

protected

Definition at line 11 of file SCR_FadeInOutAnimator.c.

STATE_FADE_IN

const int SCR_FadeInOutAnimator::STATE_FADE_IN = 0

protected

Definition at line 23 of file SCR_FadeInOutAnimator.c.

STATE_FADE_OUT

const int SCR_FadeInOutAnimator::STATE_FADE_OUT = 2

protected

Definition at line 25 of file SCR_FadeInOutAnimator.c.

STATE_FADE_OUT_WAIT

const int SCR_FadeInOutAnimator::STATE_FADE_OUT_WAIT = 1

protected

Definition at line 24 of file SCR_FadeInOutAnimator.c.

STATE_FADING_DONE

const int SCR_FadeInOutAnimator::STATE_FADING_DONE = 3

protected

Definition at line 26 of file SCR_FadeInOutAnimator.c.

---

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

• scripts/Game/UI/SCR_FadeInOutAnimator.c