Spinning Topp Logo BlackTopp Studios
inc
brutestrategy.cpp
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 _uibrutestrategy_cpp
41 #define _uibrutestrategy_cpp
42 
43 #include "UI/brutestrategy.h"
44 #include "UI/screen.h"
45 #include "UI/widget.h"
46 
47 namespace Mezzanine
48 {
49  namespace UI
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  // BruteStrategy Functors
53 
54  ///////////////////////////////////////////////////////////////////////////////
55  /// @internal
56  /// @class MouseHoverCheck
57  /// @brief Simple functor for finding which renderable the mouse is hovered over.
58  /// @details This is intended for reverse checks.
59  ///////////////////////////////////////
61  {
62  public:
63  /// @brief The current mouse position to be checked for hover.
65  /// @brief A pointer to the result if one was found, or NULL if it wasn't.
67 
68  /// @brief Class constructor.
69  /// @param Pos The position on the screen being checked for overlap.
70  MouseHoverCheck(const Vector2& Pos) :
71  MousePos(Pos),
72  Result(NULL)
73  { }
74  /// @brief Class destructor.
76  { }
77 
78  /// @brief Interface needed for processing child widgets of screens and widgets.
79  /// @param Wid A pointer to the Widget that will be processed.
80  /// @return Returns true if a valid result is found.
82  {
83  // Can it be seen?
84  if( Wid->GetVisible() && Wid->GetNumVisibleRenderLayers() ) {
85  // Is it inside?
86  if( Wid->IsInside(this->MousePos) ) {
87  // Has mouse picking been disabled?
88  if( !Wid->GetMousePassthrough() ) {
89  this->Result = static_cast<Widget*>( Wid );
90  }
91  }
92  }
93  return ( Result != NULL );
94  }
95  };//MouseHoverCheck
96 
97  ///////////////////////////////////////////////////////////////////////////////
98  // BruteStrategy Methods
99 
101  {
102  MouseHoverCheck Check(MousePos);
104  return Check.Result;
105  }
106  }//UI
107 }//Mezzanine
108 
109 #endif
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
virtual Boole GetMousePassthrough() const
Gets whether or not Mouse Passthrough is enabled.
MouseHoverCheck(const Vector2 &Pos)
Class constructor.
Widget * FindHoveredWidget(const Vector2 &MousePos)
Finds the hovered quad for the parent screen.
Boole _ReverseProcessAllChildren(Callback *CB)
Processes all children of this screen in reverse zorder.
Definition: screen.h:679
~MouseHoverCheck()
Class destructor.
virtual Boole IsInside(const Vector2 &Point) const
Checks to see if a point in 2D space is inside this quad.
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
Boole operator()(Widget *Wid)
Interface needed for processing child widgets of screens and widgets.
Widget * Result
A pointer to the result if one was found, or NULL if it wasn't.
UInt32 GetNumVisibleRenderLayers() const
Gets the number of RenderLayers that are visible in this renderable.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
virtual Boole GetVisible() const
Gets the visibility setting of this renderable.
Definition: widget.cpp:243
Screen * ParentScreen
A pointer to the screen this strategy is being used by.
Vector2 MousePos
The current mouse position to be checked for hover.
Simple functor for finding which renderable the mouse is hovered over.