hdps::util::WidgetFader Class Reference

#include <WidgetFader.h>

Inheritance diagram for hdps::util::WidgetFader:

Signals
void	fadedIn ()
void	fadedOut ()

Public Member Functions
	WidgetFader (QObject *parent, QWidget *targetWidget, float opacity=0.0f, float minimumOpacity=0.0f, float maximumOpacity=1.0f, std::int32_t fadeInDuration=150, std::int32_t fadeOutDuration=150)
void	fadeIn (std::int32_t duration=-1)
void	fadeOut (std::int32_t duration=-1)
void	setOpacity (float opacity, std::uint32_t duration=0)
bool	isFadedIn () const
bool	isFadedOut () const
float	getMinimumOpacity () const
float	getMaximumOpacity () const
void	setMinimumOpacity (float minimumOpacity)
void	setMaximumOpacity (float maximumOpacity)
std::int32_t	getFadeInDuration () const
std::int32_t	getFadeOutDuration () const
void	setFadeInDuration (std::int32_t fadeInDuration)
void	setFadeOutDuration (std::int32_t fadeOutDuration)
QGraphicsOpacityEffect &	getOpacityEffect ()

Detailed Description

Widget fader utility class

Helper class for fading in/out a target widget.

Author

Thomas Kroes

Constructor & Destructor Documentation

WidgetFader()

hdps::util::WidgetFader::WidgetFader	(	QObject *	parent,
		QWidget *	targetWidget,
		float	opacity = 0.0f,
		float	minimumOpacity = 0.0f,
		float	maximumOpacity = 1.0f,
		std::int32_t	fadeInDuration = 150,
		std::int32_t	fadeOutDuration = 150
	)

Constructor

Parameters

parent	Pointer to parent object
targetWidget	Pointer to target widget to fade
opacity	Initial opacity [0, 1]
minimumOpacity	Target fade in opacity [0, 1]
maximumOpacity	Target fade out opacity [0, 1]
animationDuration	Duration of the fade in animation
animationDuration	Duration of the fade out animation

Member Function Documentation

fadedIn

void hdps::util::WidgetFader::fadedIn ( )

signal

Signals that the animation has faded in

fadedOut

void hdps::util::WidgetFader::fadedOut ( )

signal

Signals that the animation has faded out

fadeIn()

void hdps::util::WidgetFader::fadeIn

(

std::int32_t

duration = -1

)

Fade in the target widget

Parameters

duration

Only used if duration >= 0, otherwise uses _fadeInDuration

fadeOut()

void hdps::util::WidgetFader::fadeOut

(

std::int32_t

duration = -1

)

Fade out the target widget

Parameters

duration

Only used if duration >= 0, otherwise uses _fadeOutDuration

getFadeInDuration()

std::int32_t hdps::util::WidgetFader::getFadeInDuration

(

)

const

Get fade-in duration

getFadeOutDuration()

std::int32_t hdps::util::WidgetFader::getFadeOutDuration

(

)

const

Get fade-out duration

getMaximumOpacity()

float hdps::util::WidgetFader::getMaximumOpacity

(

)

const

Get maximum opacity

getMinimumOpacity()

float hdps::util::WidgetFader::getMinimumOpacity

(

)

const

Get minimum opacity

getOpacityEffect()

QGraphicsOpacityEffect & hdps::util::WidgetFader::getOpacityEffect

(

)

Get opacity effect

Returns

Reference to opacity effect

isFadedIn()

bool hdps::util::WidgetFader::isFadedIn

(

)

const

Get whether the target widget is faded in

Returns

Boolean determining whether the target widget is faded in

isFadedOut()

bool hdps::util::WidgetFader::isFadedOut

(

)

const

Get whether the target widget is faded out

Returns

Boolean determining whether the target widget is faded out

setFadeInDuration()

void hdps::util::WidgetFader::setFadeInDuration

(

std::int32_t

fadeInDuration

)

Set fade-in duration

Parameters

fadeInDuration

Fade-in duration in milliseconds

setFadeOutDuration()

void hdps::util::WidgetFader::setFadeOutDuration

(

std::int32_t

fadeOutDuration

)

Set fade-out duration

Parameters

fadeOutDuration

Fade-out duration in milliseconds

setMaximumOpacity()

void hdps::util::WidgetFader::setMaximumOpacity

(

float

maximumOpacity

)

Set maximum opacity

Parameters

maximumOpacity

Maximum opacity

setMinimumOpacity()

void hdps::util::WidgetFader::setMinimumOpacity

(

float

minimumOpacity

)

Set minimum opacity

Parameters

minimumOpacity

Minimum opacity

setOpacity()

void hdps::util::WidgetFader::setOpacity	(	float	opacity,
		std::uint32_t	duration = 0
	)

Set opacity

Parameters

opacity	Opacity
duration	Animation duration

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/util/WidgetFader.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/util/WidgetFader.cpp