Spinning Topp Logo BlackTopp Studios
inc
buttondevice.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 _inputbuttondevice_cpp
41 #define _inputbuttondevice_cpp
42 
43 #include "Input/buttondevice.h"
44 
45 namespace Mezzanine
46 {
47  namespace Input
48  {
50  { }
51 
53  { }
54 
56  {
57  for( std::vector<Whole>::iterator It = this->TransitioningIndexes.begin() ; It != this->TransitioningIndexes.end() ; ++It )
58  {
59  Input::ButtonState State = this->Buttons.at( (*It) );
60  if( Input::BUTTON_PRESSING == State )
61  this->Buttons.at( (*It) ) = Input::BUTTON_DOWN;
62  else if( Input::BUTTON_LIFTING == State )
63  this->Buttons.at( (*It) ) = Input::BUTTON_UP;
64  }
65  this->TransitioningIndexes.clear();
66  }
67 
68  ///////////////////////////////////////////////////////////////////////////////
69  // Query Methods
70 
72  { return this->Buttons.size(); }
73 
75  { return Input::BUTTON_UP < this->GetButtonState(Button); }
76 
78  { return Input::BUTTON_UP < this->GetButtonState(Button); }
79 
81  { return Input::BUTTON_PRESSING == this->GetButtonState(Button); }
82 
84  { return Input::BUTTON_PRESSING == this->GetButtonState(Button); }
85 
87  { return Input::BUTTON_LIFTING == this->GetButtonState(Button); }
88 
90  { return Input::BUTTON_LIFTING == this->GetButtonState(Button); }
91 
93  {
94  Input::ButtonState State = this->GetButtonState(Button);
95  return (Input::BUTTON_LIFTING == State || Input::BUTTON_PRESSING == State);
96  }
97 
99  {
100  Input::ButtonState State = this->GetButtonState(Button);
101  return (Input::BUTTON_LIFTING == State || Input::BUTTON_PRESSING == State);
102  }
103 
105  { return State == this->GetButtonState(Button); }
106 
108  { return State == this->GetButtonState(Button); }
109 
110  void ButtonDevice::_Update(const MetaCodeContainer& DeltaCodes, MetaCodeContainer& GeneratedCodes)
111  {
112  this->UpdateButtonTransitions();
113  this->UpdateImpl(DeltaCodes,GeneratedCodes);
114  this->AddPressedButtons(GeneratedCodes);
115  }
116  }//Input
117 }//Mezzanine
118 
119 #endif
InputCode
The InputCode enum defines all the posible types of inputs.
Boole CheckButtonState(const UInt16 Button, const Input::ButtonState &State) const
Checks to see if a button on this device is a specific state.
UInt16 GetNumButtons() const
Gets the number of buttons on this device.
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
Boole IsButtonTransitioning(const UInt16 Button) const
Gets whether or not a device button was lifted or pressed this frame.
virtual const Input::ButtonState & GetButtonState(const UInt16 Button) const =0
Gets the state of the requested button.
uint16_t UInt16
An 16-bit unsigned integer.
Definition: datatypes.h:122
void _Update(const MetaCodeContainer &DeltaCodes, MetaCodeContainer &GeneratedCodes)
Updates this device with the newest data.
Boole IsButtonPressing(const UInt16 Button) const
Gets whether or not a device button was pressed this frame.
std::vector< Whole > TransitioningIndexes
A container of indexes being tracked due to state transitions.
Definition: buttondevice.h:58
virtual void AddPressedButtons(MetaCodeContainer &GeneratedCodes) const =0
Adds MetaCodes belonging to all the buttons that are currently pressed for this device.
Input::MetaCode::MetaCodeContainer MetaCodeContainer
Convenience datatype for storage of MetaCodes.
Definition: metacode.h:351
virtual ~ButtonDevice()
Class destructor.
ButtonDevice()
Class constructor.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
ButtonState
An Optional listing of value that can be used in a metacode to represent the information of a button ...
void UpdateButtonTransitions()
Updates transitioning buttons.
Boole IsButtonLifting(const UInt16 Button) const
Gets whether or not a device button was lifted this frame.
Boole IsButtonPressed(const UInt16 Button) const
Gets whether or not a device button is pressed down.
virtual void UpdateImpl(const MetaCodeContainer &DeltaCodes, MetaCodeContainer &GeneratedCodes)=0
Internal implementation of the device update.
std::vector< Input::ButtonState > Buttons
A container of states for each button on the input device.
Definition: buttondevice.h:61