Element for fading out or in. More...
#include <IGUIInOutFader.h>
Public Member Functions | |
IGUIInOutFader (IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle) | |
constructor More... | |
virtual void | fadeIn (u32 time)=0 |
Starts the fade in process. More... | |
virtual void | fadeOut (u32 time)=0 |
Starts the fade out process. More... | |
virtual video::SColor | getColor () const =0 |
Gets the color to fade out to or to fade in from. More... | |
virtual bool | isReady () const =0 |
Returns if the fade in or out process is done. More... | |
virtual void | setColor (video::SColor color)=0 |
Sets the color to fade out to or to fade in from. More... | |
virtual void | setColor (video::SColor source, video::SColor dest)=0 |
![]() | |
IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent, s32 id, const core::rect< s32 > &rectangle) | |
Constructor. More... | |
virtual | ~IGUIElement () |
Destructor. More... | |
virtual void | addChild (IGUIElement *child) |
Adds a GUI element as new child of this element. More... | |
virtual bool | bringToFront (IGUIElement *element) |
Brings a child to front. More... | |
virtual void | deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0) |
Reads attributes of the scene node. More... | |
virtual void | draw () |
Draws the element and its children. More... | |
core::rect< s32 > | getAbsoluteClippingRect () const |
Returns the visible area of the element. More... | |
core::rect< s32 > | getAbsolutePosition () const |
Gets the absolute rectangle of this element. More... | |
virtual const core::list< IGUIElement * > & | getChildren () const |
Returns list with children of this element. More... | |
virtual IGUIElement * | getElementFromId (s32 id, bool searchchildren=false) const |
Finds the first element with the given id. More... | |
IGUIElement * | getElementFromPoint (const core::position2d< s32 > &point) |
Returns the topmost GUI element at the specific position. More... | |
virtual s32 | getID () const |
Returns id. Can be used to identify the element. More... | |
virtual const c8 * | getName () const |
Returns the name of the element. More... | |
bool | getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement *&first, IGUIElement *&closest, bool includeInvisible=false) const |
searches elements to find the closest next element to tab to More... | |
IGUIElement * | getParent () const |
Returns parent of this element. More... | |
core::rect< s32 > | getRelativePosition () const |
Returns the relative rectangle of this element. More... | |
IGUIElement * | getTabGroup () |
Returns the container element which holds all elements in this element's tab group. More... | |
s32 | getTabOrder () const |
Returns the number in the tab order sequence. More... | |
virtual const wchar_t * | getText () const |
Returns caption of this element. More... | |
virtual const core::stringw & | getToolTipText () const |
Returns caption of this element. More... | |
EGUI_ELEMENT_TYPE | getType () const |
Returns the type of the gui element. More... | |
virtual const c8 * | getTypeName () const |
Returns the type name of the gui element. More... | |
virtual bool | hasType (EGUI_ELEMENT_TYPE type) const |
Returns true if the gui element supports the given type. More... | |
virtual bool | isEnabled () const |
Returns true if element is enabled. More... | |
bool | isMyChild (IGUIElement *child) const |
bool | isNotClipped () const |
Gets whether the element will ignore its parent's clipping rectangle. More... | |
virtual bool | isPointInside (const core::position2d< s32 > &point) const |
Returns true if a point is within this element. More... | |
virtual bool | isSubElement () const |
Returns true if this element was created as part of its parent control. More... | |
bool | isTabGroup () const |
Returns true if this element is a tab group. More... | |
bool | isTabStop () const |
Returns true if this element can be focused by navigating with the tab key. More... | |
virtual bool | isVisible () const |
Returns true if element is visible. More... | |
virtual void | move (core::position2d< s32 > absoluteMovement) |
Moves this element. More... | |
virtual bool | OnEvent (const SEvent &event) |
Called if an event happened. More... | |
virtual void | OnPostRender (u32 timeMs) |
animate the element and its children. More... | |
virtual void | remove () |
Removes this element from its parent. More... | |
virtual void | removeChild (IGUIElement *child) |
Removes a child. More... | |
virtual bool | sendToBack (IGUIElement *child) |
Moves a child to the back, so it's siblings are drawn on top of it. More... | |
virtual void | serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const |
Writes attributes of the scene node. More... | |
void | setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom) |
The alignment defines how the borders of this element will be positioned when the parent element is resized. More... | |
virtual void | setEnabled (bool enabled) |
Sets the enabled state of this element. More... | |
virtual void | setID (s32 id) |
Sets the id of this element. More... | |
void | setMaxSize (core::dimension2du size) |
Sets the maximum size allowed for this element. More... | |
void | setMinSize (core::dimension2du size) |
Sets the minimum size allowed for this element. More... | |
virtual void | setName (const c8 *name) |
Sets the name of the element. More... | |
virtual void | setName (const core::stringc &name) |
Sets the name of the element. More... | |
void | setNotClipped (bool noClip) |
Sets whether the element will ignore its parent's clipping rectangle. More... | |
void | setRelativePosition (const core::rect< s32 > &r) |
Sets the relative rectangle of this element. More... | |
void | setRelativePosition (const core::position2di &position) |
Sets the relative rectangle of this element, maintaining its current width and height. More... | |
void | setRelativePositionProportional (const core::rect< f32 > &r) |
Sets the relative rectangle of this element as a proportion of its parent's area. More... | |
virtual void | setSubElement (bool subElement) |
Sets whether this control was created as part of its parent. More... | |
void | setTabGroup (bool isGroup) |
Sets whether this element is a container for a group of elements which can be navigated using the tab key. More... | |
void | setTabOrder (s32 index) |
Sets the priority of focus when using the tab key to navigate between a group of elements. More... | |
void | setTabStop (bool enable) |
If set to true, the focus will visit this element when using the tab key to cycle through elements. More... | |
virtual void | setText (const wchar_t *text) |
Sets the new caption of this element. More... | |
virtual void | setToolTipText (const wchar_t *text) |
Sets the new caption of this element. More... | |
virtual void | setVisible (bool visible) |
Sets the visible state of this element. More... | |
virtual void | updateAbsolutePosition () |
Updates the absolute position. More... | |
![]() | |
IReferenceCounted () | |
Constructor. More... | |
virtual | ~IReferenceCounted () |
Destructor. More... | |
bool | drop () const |
Drops the object. Decrements the reference counter by one. More... | |
const c8 * | getDebugName () const |
Returns the debug name of the object. More... | |
s32 | getReferenceCount () const |
Get the reference count. More... | |
void | grab () const |
Grabs the object. Increments the reference counter by one. More... | |
![]() | |
virtual | ~IEventReceiver () |
Destructor. More... | |
Additional Inherited Members | |
![]() | |
void | addChildToEnd (IGUIElement *child) |
void | recalculateAbsolutePosition (bool recursive) |
![]() | |
void | setDebugName (const c8 *newName) |
Sets the debug name of the object. More... | |
![]() | |
core::rect< s32 > | AbsoluteClippingRect |
absolute clipping rect of element More... | |
core::rect< s32 > | AbsoluteRect |
absolute rect of element More... | |
EGUI_ALIGNMENT | AlignBottom |
EGUI_ALIGNMENT | AlignLeft |
tells the element how to act when its parent is resized More... | |
EGUI_ALIGNMENT | AlignRight |
EGUI_ALIGNMENT | AlignTop |
core::list< IGUIElement * > | Children |
List of all children of this element. More... | |
core::rect< s32 > | DesiredRect |
IGUIEnvironment * | Environment |
GUI Environment. More... | |
s32 | ID |
users can set this for identificating the element by integer More... | |
bool | IsEnabled |
is enabled? More... | |
bool | IsSubElement |
is a part of a larger whole and should not be serialized? More... | |
bool | IsTabGroup |
tab groups are containers like windows, use ctrl+tab to navigate More... | |
bool | IsTabStop |
tab stop like in windows More... | |
bool | IsVisible |
is visible? More... | |
core::rect< s32 > | LastParentRect |
for calculating the difference when resizing parent More... | |
core::dimension2du | MaxSize |
maximum and minimum size of the element More... | |
core::dimension2du | MinSize |
core::stringc | Name |
users can set this for identificating the element by string More... | |
bool | NoClip |
does this element ignore its parent's clipping rectangle? More... | |
IGUIElement * | Parent |
Pointer to the parent. More... | |
core::rect< s32 > | RelativeRect |
relative rect of element More... | |
core::rect< f32 > | ScaleRect |
relative scale of the element inside its parent More... | |
s32 | TabOrder |
tab order More... | |
core::stringw | Text |
caption More... | |
core::stringw | ToolTipText |
tooltip More... | |
EGUI_ELEMENT_TYPE | Type |
type of element More... | |
Element for fading out or in.
Here is a small example on how the class is used. In this example we fade in from a total red screen in the beginning. As you can see, the fader is not only useful for dramatic in and out fading, but also to show that the player is hit in a first person shooter game for example.
Definition at line 27 of file IGUIInOutFader.h.
|
inline |
constructor
Definition at line 32 of file IGUIInOutFader.h.
References fadeIn(), fadeOut(), getColor(), isReady(), and setColor().
|
pure virtual |
Starts the fade in process.
In the beginning the whole rect is drawn by the set color (black by default) and at the end of the overgiven time the color has faded out.
time | Time specifying how long it should need to fade in, in milliseconds. |
Referenced by IGUIInOutFader().
|
pure virtual |
Starts the fade out process.
In the beginning everything is visible, and at the end of the time only the set color (black by the fault) will be drawn.
time | Time specifying how long it should need to fade out, in milliseconds. |
Referenced by IGUIInOutFader().
|
pure virtual |
Gets the color to fade out to or to fade in from.
Referenced by IGUIInOutFader().
|
pure virtual |
Returns if the fade in or out process is done.
Referenced by IGUIInOutFader().
|
pure virtual |
Sets the color to fade out to or to fade in from.
color | Color to where it is faded out od from it is faded in. |
Referenced by IGUIInOutFader().
|
pure virtual |