Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Attributes | List of all members
Mezzanine::UI::MouseHoverStrategy Class Referenceabstract

This is the base class for a method of finding which quad the mouse is hovered over. More...

#include <mousehoverstrategy.h>

+ Inheritance diagram for Mezzanine::UI::MouseHoverStrategy:
+ Collaboration diagram for Mezzanine::UI::MouseHoverStrategy:

Public Member Functions

 MouseHoverStrategy ()
 Class constructor.
 
virtual ~MouseHoverStrategy ()
 Class destructor.
 
void _NotifyScreenDirty ()
 Notifies this that it's parent screen was altered. More...
 
void _SetScreen (Screen *Parent)
 Sets the parent screen. More...
 
virtual WidgetFindHoveredWidget (const Vector2 &MousePos)=0
 Finds the hovered quad for the parent screen. More...
 

Protected Attributes

ScreenParentScreen
 A pointer to the screen this strategy is being used by. More...
 
bool ScreenDirty
 Stores whether or not the parent screen has been updated since the last time this strategys cache was updated. More...
 

Detailed Description

This is the base class for a method of finding which quad the mouse is hovered over.

Definition at line 58 of file mousehoverstrategy.h.

Member Function Documentation

void Mezzanine::UI::MouseHoverStrategy::_NotifyScreenDirty ( )
inline

Notifies this that it's parent screen was altered.

Definition at line 95 of file mousehoverstrategy.h.

void Mezzanine::UI::MouseHoverStrategy::_SetScreen ( Screen Parent)
inline

Sets the parent screen.

Parameters
ParentThe parent screen this strategy is finding the hovered quad for.

Definition at line 91 of file mousehoverstrategy.h.

virtual Widget* Mezzanine::UI::MouseHoverStrategy::FindHoveredWidget ( const Vector2 MousePos)
pure virtual

Finds the hovered quad for the parent screen.

Parameters
MousePosThe current mouse position.
Returns
Returns a pointer to the hovered quad, or NULL if none.

Implemented in Mezzanine::UI::NineBoxStrategy, and Mezzanine::UI::BruteStrategy.

Member Data Documentation

Screen* Mezzanine::UI::MouseHoverStrategy::ParentScreen
protected

A pointer to the screen this strategy is being used by.

Definition at line 63 of file mousehoverstrategy.h.

bool Mezzanine::UI::MouseHoverStrategy::ScreenDirty
protected

Stores whether or not the parent screen has been updated since the last time this strategys cache was updated.

Definition at line 66 of file mousehoverstrategy.h.


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