Spinning Topp Logo BlackTopp Studios
inc
mousehoverstrategy.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _uimousehoverstrategy_h
41 #define _uimousehoverstrategy_h
42 
43 #include "vector2.h"
44 
45 namespace Mezzanine
46 {
47  namespace UI
48  {
49  class Screen;
50  class Widget;
51  class QuadRenderable;
52  ///////////////////////////////////////////////////////////////////////////////
53  /// @class MouseHoverStrategy
54  /// @headerfile mousehoverstrategy.h
55  /// @brief This is the base class for a method of finding which quad the mouse is hovered over.
56  /// @details
57  ///////////////////////////////////////
59  {
60  protected:
61  /// @internal
62  /// @brief A pointer to the screen this strategy is being used by.
64  /// @internal
65  /// @brief Stores whether or not the parent screen has been updated since the last time this strategys cache was updated.
67  public:
68  /// @brief Class constructor.
70  ParentScreen(NULL),
71  ScreenDirty(true)
72  { }
73  /// @brief Class destructor.
75  { }
76 
77  ///////////////////////////////////////////////////////////////////////////////
78  // Utility
79 
80  /// @brief Finds the hovered quad for the parent screen.
81  /// @param MousePos The current mouse position.
82  /// @return Returns a pointer to the hovered quad, or NULL if none.
83  virtual Widget* FindHoveredWidget(const Vector2& MousePos) = 0;
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Internal Methods
87 
88  /// @internal
89  /// @brief Sets the parent screen.
90  /// @param Parent The parent screen this strategy is finding the hovered quad for.
91  void _SetScreen(Screen* Parent)
92  { this->ParentScreen = Parent; }
93  /// @internal
94  /// @brief Notifies this that it's parent screen was altered.
96  { this->ScreenDirty = true; }
97  };//MouseHoverStrategy
98  }//UI
99 }//Mezzanine
100 
101 #endif
void _NotifyScreenDirty()
Notifies this that it's parent screen was altered.
void _SetScreen(Screen *Parent)
Sets the parent screen.
virtual ~MouseHoverStrategy()
Class destructor.
This is the base class for a method of finding which quad the mouse is hovered over.
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
This is the base class for all widgets.
Definition: widget.h:126
MouseHoverStrategy()
Class constructor.
bool ScreenDirty
Stores whether or not the parent screen has been updated since the last time this strategys cache was...
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
Screen * ParentScreen
A pointer to the screen this strategy is being used by.
This class is a helper class for creating UI's. It is responsible for storing and keeping track of al...
Definition: screen.h:142