Torque3D Documentation / _generateds / GuiFadeinBitmapCtrl

GuiFadeinBitmapCtrl

Engine/source/gui/game/guiFadeinBitmapCtrl.h

A control that fades a bitmap in and out.

More...

Public Types

Protected Attributes

bool

Whether the fade cycle has run completely.

Color we fade in from and fade out to.

Easing curve for fade-in.

Milliseconds for bitmap to fade in.

Easing curve for fade-out.

Milliseconds for bitmap to fade out.

Reference time on which to base all fade timings.

Milliseconds to wait before fade-out.

Public Functions

DECLARE_CALLBACK(void , click , () )
DECLARE_CALLBACK(void , onDone , () )
DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that shows <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> bitmap. It fades the bitmap in <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> set amount of time, \<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "then waits <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> set amount of time, and finally fades the bitmap back out <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">in\n</a>" "another set amount of time." )
bool

Default behavior is call-through to onKeyDown.

bool

Happens when a key is depressed.

Do special pre-render processing.

onRender(Point2I offset, const RectI & updateRect)

Called when this control is to render itself.

bool

Called when this object is asked to wake up returns true if it's actually awake at the end.

Public Static Functions

Detailed Description

A control that fades a bitmap in and out.

Public Types

typedef GuiBitmapCtrl Parent 

Protected Attributes

bool mDone 

Whether the fade cycle has run completely.

LinearColorF mFadeColor 

Color we fade in from and fade out to.

EaseF mFadeInEase 

Easing curve for fade-in.

U32 mFadeInTime 

Milliseconds for bitmap to fade in.

EaseF mFadeOutEase 

Easing curve for fade-out.

U32 mFadeOutTime 

Milliseconds for bitmap to fade out.

U32 mStartTime 

Reference time on which to base all fade timings.

U32 mWaitTime 

Milliseconds to wait before fade-out.

Public Functions

GuiFadeinBitmapCtrl()

DECLARE_CALLBACK(void , click , () )

DECLARE_CALLBACK(void , onDone , () )

DECLARE_CONOBJECT(GuiFadeinBitmapCtrl )

DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that shows <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> bitmap. It fades the bitmap in <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> set amount of time, \<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "then waits <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> set amount of time, and finally fades the bitmap back out <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">in\n</a>" "another set amount of time." )

onGamepadButtonDown(const GuiEvent & event)

Reimplemented from: GuiControl

onKeyDown(const GuiEvent & event)

Reimplemented from: GuiControl

onMouseDown(const GuiEvent & )

Reimplemented from: GuiControl

onPreRender()

Reimplemented from: GuiControl

onRender(Point2I offset, const RectI & updateRect)

Reimplemented from: GuiBitmapCtrl

onWake()

Reimplemented from: GuiBitmapCtrl

Public Static Functions

initPersistFields()