Spinning Topp Logo BlackTopp Studios
inc
device.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 _inputdevice_cpp
41 #define _inputdevice_cpp
42 
43 #include "Input/device.h"
44 
45 namespace Mezzanine
46 {
47  namespace Input
48  {
50  { }
51 
53  { }
54 
55  ///////////////////////////////////////////////////////////////////////////////
56  // Sequenced Input Management
57 
58  void Device::AddInputSequence(const MetaCodeContainer& Codes, const Int32& SequenceID)
59  {
60  this->VerifySequenceImpl(Codes);
61  this->Sequences.AddInputSequence(Codes,SequenceID);
62  }
63 
65  { return this->Sequences.InputSequenceExists(Codes); }
66 
68  { return this->Sequences.GetIDofInputSequence(Codes); }
69 
71  { this->Sequences.RemoveInputSequence(Codes); }
72 
75  }//Input
76 }//Mezzanine
77 
78 #endif
int32_t Int32
An 32-bit integer.
Definition: datatypes.h:124
void RemoveInputSequence(const MetaCodeContainer &Codes)
Removes the specified custom sequence of MetaCode's. the vector of MetaCode's doesn't end with a null...
Definition: device.cpp:70
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
Boole InputSequenceExists(const MetaCodeContainer &Codes)
Checks to see if the provided sequence of MetaCode's is already being checked for. the vector of MetaCode's doesn't end with a null MetaCode, an exception will be thrown.
Definition: device.cpp:64
void AddInputSequence(const MetaCodeContainer &Codes, const Int32 &SequenceID)
Adds a custom sequence of inputs that this system will look for and generate MetaCode's for when they...
Definition: device.cpp:58
void AddInputSequence(const MetaCodeContainer &Codes, const Int32 &SequenceID)
Adds a custom sequence of inputs that this system will look for and generate MetaCode's for when they...
Int32 GetIDofInputSequence(const MetaCodeContainer &Codes)
Gets the ID of the provided sequence of MetaCode's. the vector of MetaCode's doesn't end with a null ...
Definition: device.cpp:67
SequenceContainer Sequences
A container for storing and detecting input sequences for an input device.
Definition: device.h:60
virtual ~Device()
Class destructor.
Definition: device.cpp:52
Device()
Class constructor.
Definition: device.cpp:49
virtual void VerifySequenceImpl(const MetaCodeContainer &Sequence) const =0
Provides the device specific logic for filtering code sequences.
Boole InputSequenceExists(const MetaCodeContainer &Codes)
Checks to see if the provided sequence of MetaCode's is already being checked for. the vector of MetaCode's doesn't end with a null MetaCode, an exception will be thrown.
Input::MetaCode::MetaCodeContainer MetaCodeContainer
Convenience datatype for storage of MetaCodes.
Definition: metacode.h:351
Int32 GetIDofInputSequence(const MetaCodeContainer &Codes)
Gets the ID of the provided sequence of MetaCode's. the vector of MetaCode's doesn't end with a null ...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
void RemoveAllInputSequences()
Removes all stored input sequences.
Definition: device.cpp:73
The declaration of the User input Device class.
void RemoveAllInputSequences()
Removes all stored input sequences.
void RemoveInputSequence(const MetaCodeContainer &Codes)
Removes the specified custom sequence of MetaCode's. the vector of MetaCode's doesn't end with a null...