PixelLightAPI  .
Protected Member Functions | Protected Attributes
PLGui::ModBlend Class Reference

Modifier that blends a widget in and out according to the mouse cursor. More...

#include <ModBlend.h>

Inheritance diagram for PLGui::ModBlend:
Inheritance graph
[legend]

List of all members.

Protected Member Functions

virtual void OnAttach (Widget &cWidget) override
 Called when the modifier is attached to a widget.
virtual void OnDetach (Widget &cWidget) override
 Called when the modifier is detached from a widget.
virtual void OnMouseOver (bool bMouseOver) override
 Called when the mouse-over state of the widget has changed.
void OnTimer ()
 Called when the timer has fired.

Protected Attributes

PLCore::uint64 m_nTimeout
float m_fTrans
float m_fTransDest
Timerm_pTimer

Detailed Description

Modifier that blends a widget in and out according to the mouse cursor.


Member Function Documentation

virtual void PLGui::ModBlend::OnAttach ( Widget cWidget) [override, protected, virtual]

Called when the modifier is attached to a widget.

Parameters:
[in]cWidgetWidget to which the modifier is attached

Reimplemented from PLGui::Modifier.

virtual void PLGui::ModBlend::OnDetach ( Widget cWidget) [override, protected, virtual]

Called when the modifier is detached from a widget.

Parameters:
[in]cWidgetWidget from which the modifier is detached

Reimplemented from PLGui::Modifier.

virtual void PLGui::ModBlend::OnMouseOver ( bool  bMouseOver) [override, protected, virtual]

Called when the mouse-over state of the widget has changed.

Parameters:
[in]bMouseOver'true' if the mouse is over the widget or a child widget, else 'false'

Reimplemented from PLGui::WidgetFunctions.

void PLGui::ModBlend::OnTimer ( ) [protected]

Called when the timer has fired.


Member Data Documentation

PLCore::uint64 PLGui::ModBlend::m_nTimeout [protected]

Timeout for blend animation (in milliseconds)

float PLGui::ModBlend::m_fTrans [protected]

Current transparency (0.0f - 1.0f)

float PLGui::ModBlend::m_fTransDest [protected]

Destination transparency (0.0f - 1.0f)

Timer used for fading


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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:18
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported