SCR_WLibProgressBarComponent Class Reference

Minimalist progress bar. More...

Inheritance diagram for SCR_WLibProgressBarComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
void	SetMin (float value)
void	SetMax (float value)
void	SetValue (float value, bool animate=true)
void	SetChange (float value)
void	UpdateVisuals (bool animate=true)
void	StopProgressAnimation ()
void	SetSliderColor (Color newColor)
void	SetSliderChangeColor (Color newColor)
float	GetMin ()
float	GetMax ()
float	GetValue ()
Widget	GetRootWidget ()
float	GetAnimationSpeed ()
bool	IsUsingAnimationTime ()
void	SetUsingAnimationTime (bool enable)
void	SetAnimationTime (float value)

Static Protected Member Functions
static SCR_WLibProgressBarComponent	GetProgressBar (string name, Widget parent, bool searchAllChildren=true)

Protected Attributes
const string	WIDGET_CHANGE = "Change"
float	m_fMin
float	m_fMax
float	m_fValue
bool	m_bReverseDirection
bool	m_bConstantAnimationSpeed
float	m_fAnimationTime
ref Color	m_SliderColor
ref Color	m_BackgroundColor
Widget	m_wRoot
Widget	m_wBar
Widget	m_wChange
Widget	m_wSpacer
float	m_fChange

Detailed Description

Minimalist progress bar.

Definition at line 6 of file SCR_WLibProgressBar.c.

Member Function Documentation

GetAnimationSpeed()

float SCR_WLibProgressBarComponent::GetAnimationSpeed ( )

inlineprotected

Definition at line 174 of file SCR_WLibProgressBar.c.

GetMax()

float SCR_WLibProgressBarComponent::GetMax ( )

inlineprotected

Definition at line 156 of file SCR_WLibProgressBar.c.

GetMin()

float SCR_WLibProgressBarComponent::GetMin ( )

inlineprotected

Definition at line 150 of file SCR_WLibProgressBar.c.

GetProgressBar()

SCR_WLibProgressBarComponent SCR_WLibProgressBarComponent::GetProgressBar ( string name, Widget parent, bool searchAllChildren = true )

inlinestaticprotected

Definition at line 198 of file SCR_WLibProgressBar.c.

GetRootWidget()

Widget SCR_WLibProgressBarComponent::GetRootWidget ( )

inlineprotected

Definition at line 168 of file SCR_WLibProgressBar.c.

GetValue()

float SCR_WLibProgressBarComponent::GetValue ( )

inlineprotected

Definition at line 162 of file SCR_WLibProgressBar.c.

HandlerAttached()

override void SCR_WLibProgressBarComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 42 of file SCR_WLibProgressBar.c.

IsUsingAnimationTime()

bool SCR_WLibProgressBarComponent::IsUsingAnimationTime ( )

inlineprotected

Definition at line 180 of file SCR_WLibProgressBar.c.

SetAnimationTime()

void SCR_WLibProgressBarComponent::SetAnimationTime ( float value )

inlineprotected

Definition at line 192 of file SCR_WLibProgressBar.c.

SetChange()

void SCR_WLibProgressBarComponent::SetChange ( float value )

inlineprotected

Definition at line 85 of file SCR_WLibProgressBar.c.

SetMax()

void SCR_WLibProgressBarComponent::SetMax ( float value )

inlineprotected

Definition at line 71 of file SCR_WLibProgressBar.c.

SetMin()

void SCR_WLibProgressBarComponent::SetMin ( float value )

inlineprotected

Definition at line 64 of file SCR_WLibProgressBar.c.

SetSliderChangeColor()

void SCR_WLibProgressBarComponent::SetSliderChangeColor ( Color newColor )

inlineprotected

Definition at line 143 of file SCR_WLibProgressBar.c.

SetSliderColor()

void SCR_WLibProgressBarComponent::SetSliderColor ( Color newColor )

inlineprotected

Definition at line 136 of file SCR_WLibProgressBar.c.

SetUsingAnimationTime()

void SCR_WLibProgressBarComponent::SetUsingAnimationTime ( bool enable )

inlineprotected

Definition at line 186 of file SCR_WLibProgressBar.c.

SetValue()

void SCR_WLibProgressBarComponent::SetValue ( float value, bool animate = true )

inlineprotected

Definition at line 78 of file SCR_WLibProgressBar.c.

StopProgressAnimation()

void SCR_WLibProgressBarComponent::StopProgressAnimation ( )

inlineprotected

Definition at line 126 of file SCR_WLibProgressBar.c.

UpdateVisuals()

void SCR_WLibProgressBarComponent::UpdateVisuals ( bool animate = true )

inlineprotected

Definition at line 92 of file SCR_WLibProgressBar.c.

Member Data Documentation

m_BackgroundColor

ref Color SCR_WLibProgressBarComponent::m_BackgroundColor

protected

Definition at line 32 of file SCR_WLibProgressBar.c.

m_bConstantAnimationSpeed

bool SCR_WLibProgressBarComponent::m_bConstantAnimationSpeed

protected

Definition at line 23 of file SCR_WLibProgressBar.c.

m_bReverseDirection

bool SCR_WLibProgressBarComponent::m_bReverseDirection

protected

Definition at line 20 of file SCR_WLibProgressBar.c.

m_fAnimationTime

float SCR_WLibProgressBarComponent::m_fAnimationTime

protected

Definition at line 26 of file SCR_WLibProgressBar.c.

m_fChange

float SCR_WLibProgressBarComponent::m_fChange

protected

Definition at line 39 of file SCR_WLibProgressBar.c.

m_fMax

float SCR_WLibProgressBarComponent::m_fMax

protected

Definition at line 14 of file SCR_WLibProgressBar.c.

m_fMin

float SCR_WLibProgressBarComponent::m_fMin

protected

Definition at line 11 of file SCR_WLibProgressBar.c.

m_fValue

float SCR_WLibProgressBarComponent::m_fValue

protected

Definition at line 17 of file SCR_WLibProgressBar.c.

m_SliderColor

ref Color SCR_WLibProgressBarComponent::m_SliderColor

protected

Definition at line 29 of file SCR_WLibProgressBar.c.

m_wBar

Widget SCR_WLibProgressBarComponent::m_wBar

protected

Definition at line 35 of file SCR_WLibProgressBar.c.

m_wChange

Widget SCR_WLibProgressBarComponent::m_wChange

protected

Definition at line 36 of file SCR_WLibProgressBar.c.

m_wRoot

Widget SCR_WLibProgressBarComponent::m_wRoot

protected

Definition at line 34 of file SCR_WLibProgressBar.c.

m_wSpacer

Widget SCR_WLibProgressBarComponent::m_wSpacer

protected

Definition at line 37 of file SCR_WLibProgressBar.c.

WIDGET_CHANGE

const string SCR_WLibProgressBarComponent::WIDGET_CHANGE = "Change"

protected

Definition at line 8 of file SCR_WLibProgressBar.c.

---

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

• scripts/Game/UI/Components/WidgetLibrary/SCR_WLibProgressBar.c