MWGui::ScreenFader Class Reference

#include <screenfader.hpp>

Inheritance diagram for MWGui::ScreenFader:

Collaboration diagram for MWGui::ScreenFader:

Public Member Functions
	ScreenFader (const std::string &texturePath, const std::string &layout="openmw_screen_fader.layout", const MyGUI::FloatCoord &texCoordOverride=MyGUI::FloatCoord(0, 0, 1, 1))
	~ScreenFader ()
void	onFrameStart (float dt)
void	fadeIn (const float time, float delay=0)
void	fadeOut (const float time, float delay=0)
void	fadeTo (const int percent, const float time, float delay=0)
void	clear ()
	Clear any state specific to the running game. More...
void	setFactor (float factor)
void	setRepeat (bool repeat)
void	queue (float time, float targetAlpha, float delay)
bool	isEmpty ()
void	clearQueue ()
void	notifyAlphaChanged (float alpha)
void	notifyOperationFinished ()
float	getCurrentAlpha ()
Public Member Functions inherited from MWGui::WindowBase
	WindowBase (const std::string &parLayout)
virtual MyGUI::Widget *	getDefaultKeyFocus ()
virtual void	setPtr (const MWWorld::Ptr &ptr)
	Open this object in the GUI, for windows that support it. More...
virtual void	onFrame (float duration)
	Called every frame if the window is in an active GUI mode. More...
virtual void	onOpen ()
	Notify that window has been made visible. More...
virtual void	onClose ()
	Notify that window has been hidden. More...
virtual bool	exit ()
	Gracefully exits the window. More...
virtual void	setVisible (bool visible)
	Sets the visibility of the window. More...
bool	isVisible ()
	Returns the visibility state of the window. More...
void	center ()
virtual void	onResChange (int width, int height)
	Called when GUI viewport changes size. More...
Public Member Functions inherited from MWGui::Layout
	Layout (const std::string &_layout, MyGUI::Widget *_parent=nullptr)
virtual	~Layout ()
MyGUI::Widget *	getWidget (const std::string &_name)
template<typename T >
void	getWidget (T *&_widget, const std::string &_name)
void	setCoord (int x, int y, int w, int h)
void	setText (const std::string &name, const std::string &caption)
void	setTitle (const std::string &title)

Private Member Functions
void	applyAlpha ()

Private Attributes
float	mCurrentAlpha
float	mFactor
bool	mRepeat
std::deque< FadeOp::Ptr >	mQueue

Additional Inherited Members
Public Types inherited from MWGui::WindowBase
typedef MyGUI::delegates::CMultiDelegate1 < WindowBase * >	EventHandle_WindowBase
Public Attributes inherited from MWGui::Layout
MyGUI::Widget *	mMainWidget
Protected Attributes inherited from MWGui::Layout
std::string	mPrefix
std::string	mLayoutName
MyGUI::VectorWidgetPtr	mListWindowRoot

Constructor & Destructor Documentation

MWGui::ScreenFader::ScreenFader	(	const std::string &	texturePath,
		const std::string &	layout = "openmw_screen_fader.layout",
		const MyGUI::FloatCoord &	texCoordOverride = MyGUI::FloatCoord(0,0,1,1)
	)

Here is the call graph for this function:

MWGui::ScreenFader::~ScreenFader

(

)

Here is the call graph for this function:

Member Function Documentation

void MWGui::ScreenFader::applyAlpha ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWGui::ScreenFader::clear ( )

virtual

Clear any state specific to the running game.

Reimplemented from MWGui::WindowBase.

Here is the call graph for this function:

void MWGui::ScreenFader::clearQueue

(

)

Here is the caller graph for this function:

void MWGui::ScreenFader::fadeIn	(	const float	time,
		float	delay = 0
	)

Here is the call graph for this function:

Here is the caller graph for this function:

void MWGui::ScreenFader::fadeOut	(	const float	time,
		float	delay = 0
	)

Here is the call graph for this function:

Here is the caller graph for this function:

void MWGui::ScreenFader::fadeTo	(	const int	percent,
		const float	time,
		float	delay = 0
	)

Here is the call graph for this function:

Here is the caller graph for this function:

float MWGui::ScreenFader::getCurrentAlpha

(

)

Here is the caller graph for this function:

bool MWGui::ScreenFader::isEmpty

(

)

Here is the caller graph for this function:

void MWGui::ScreenFader::notifyAlphaChanged

(

float

alpha

)

Here is the call graph for this function:

Here is the caller graph for this function:

void MWGui::ScreenFader::notifyOperationFinished

(

)

Here is the caller graph for this function:

void MWGui::ScreenFader::onFrameStart

(

float

dt

)

Here is the caller graph for this function:

void MWGui::ScreenFader::queue	(	float	time,
		float	targetAlpha,
		float	delay
	)

Here is the call graph for this function:

Here is the caller graph for this function:

void MWGui::ScreenFader::setFactor

(

float

factor

)

Here is the call graph for this function:

void MWGui::ScreenFader::setRepeat

(

bool

repeat

)

Member Data Documentation

float MWGui::ScreenFader::mCurrentAlpha

private

float MWGui::ScreenFader::mFactor

private

std::deque<FadeOp::Ptr> MWGui::ScreenFader::mQueue

private

bool MWGui::ScreenFader::mRepeat

private

---

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

• /home/travis/build/elsid/openmw/apps/openmw/mwgui/screenfader.hpp
• /home/travis/build/elsid/openmw/apps/openmw/mwgui/screenfader.cpp