MyGUI 3.4.3
MyGUI::ControllerFadeAlpha Class Reference

#include <MyGUI_ControllerFadeAlpha.h>

Inheritance diagram for MyGUI::ControllerFadeAlpha:

Public Types

typedef RTTIBase Base
 
typedef ControllerFadeAlpha RTTIBase
 
- Public Types inherited from MyGUI::ControllerItem
typedef RTTIBase Base
 
typedef ControllerItem RTTIBase
 
- Public Types inherited from MyGUI::IObject
typedef IObject RTTIBase
 

Public Member Functions

virtual std::string_view getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
void setAlpha (float _value)
 
void setCoef (float _value)
 
void setEnabled (bool _value)
 
bool addTime (Widget *_widget, float _time) override
 
void prepareItem (Widget *_widget) override
 
void setProperty (std::string_view _key, std::string_view _value) override
 
- Public Member Functions inherited from MyGUI::ControllerItem
template<typename Type >
bool isType () const
 
- Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool isType () const
 
template<typename Type >
Type * castType (bool _throw=true)
 
template<typename Type >
const Type * castType (bool _throw=true) const
 
virtual ~IObject ()=default
 

Static Public Member Functions

static std::string_view getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::ControllerItem
static std::string_view getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::IObject
static std::string_view getClassTypeName ()
 

Additional Inherited Members

- Data Fields inherited from MyGUI::ControllerItem
EventPairAddParameter< EventHandle_WidgetPtr, EventHandle_WidgetPtrControllerItemPtreventPreAction
 
EventPairAddParameter< EventHandle_WidgetPtr, EventHandle_WidgetPtrControllerItemPtreventUpdateAction
 
EventPairAddParameter< EventHandle_WidgetPtr, EventHandle_WidgetPtrControllerItemPtreventPostAction
 

Detailed Description

This controller used for smooth changing alpha of widget in time

Definition at line 18 of file MyGUI_ControllerFadeAlpha.h.

Member Typedef Documentation

◆ Base

◆ RTTIBase

Member Function Documentation

◆ addTime()

bool MyGUI::ControllerFadeAlpha::addTime ( Widget * _widget,
float _time )
overridevirtual

Implements MyGUI::ControllerItem.

Definition at line 37 of file MyGUI_ControllerFadeAlpha.cpp.

◆ getClassTypeName()

static std::string_view MyGUI::ControllerFadeAlpha::getClassTypeName ( )
inlinestatic

Definition at line 20 of file MyGUI_ControllerFadeAlpha.h.

◆ getTypeName()

virtual std::string_view MyGUI::ControllerFadeAlpha::getTypeName ( ) const
inlineoverridevirtual

Get type name as string

Reimplemented from MyGUI::ControllerItem.

Definition at line 20 of file MyGUI_ControllerFadeAlpha.h.

◆ isType() [1/2]

template<typename Type >
bool MyGUI::ControllerFadeAlpha::isType ( ) const
inline

Compare with selected type

Definition at line 20 of file MyGUI_ControllerFadeAlpha.h.

◆ isType() [2/2]

virtual bool MyGUI::ControllerFadeAlpha::isType ( const std::type_info & _type) const
inlineoverridevirtual

Compare with selected type

Reimplemented from MyGUI::ControllerItem.

Definition at line 20 of file MyGUI_ControllerFadeAlpha.h.

◆ prepareItem()

void MyGUI::ControllerFadeAlpha::prepareItem ( Widget * _widget)
overridevirtual

Implements MyGUI::ControllerItem.

Definition at line 17 of file MyGUI_ControllerFadeAlpha.cpp.

◆ setAlpha()

void MyGUI::ControllerFadeAlpha::setAlpha ( float _value)
Parameters
_valueAlpha that will be as result of changing

Definition at line 83 of file MyGUI_ControllerFadeAlpha.cpp.

◆ setCoef()

void MyGUI::ControllerFadeAlpha::setCoef ( float _value)
Parameters
_valueCoefficient of alpha changing speed (1. mean that alpha will change from 0 to 1 at 1 second)

Definition at line 88 of file MyGUI_ControllerFadeAlpha.cpp.

◆ setEnabled()

void MyGUI::ControllerFadeAlpha::setEnabled ( bool _value)
Parameters
_valueIf true then widget will be inactive after start of alpha changing

Definition at line 93 of file MyGUI_ControllerFadeAlpha.cpp.

◆ setProperty()

void MyGUI::ControllerFadeAlpha::setProperty ( std::string_view _key,
std::string_view _value )
overridevirtual

Reimplemented from MyGUI::ControllerItem.

Definition at line 73 of file MyGUI_ControllerFadeAlpha.cpp.


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