MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
collidablepair.h
1 // © Copyright 2010 - 2014 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 _collidablepair_h
41 #define _collidablepair_h
42 
43 #include "datatypes.h"
44 
45 namespace Mezzanine
46 {
47  namespace Physics
48  {
49  class CollidableProxy;
50  ///////////////////////////////////////////////////////////////////////////////
51  /// @brief This is a helper class for storing pairs of collidable proxies in associative containers.
52  /// @details Most commonly this class is used in collision tracking.
53  ///////////////////////////////////////
55  {
56  protected:
57  /// @internal
58  /// @brief Gets the combined ID of the objects in this pair.
59  virtual UInt64 GetPairID() const;
60  public:
61  ///////////////////////////////////////////////////////////////////////////////
62  // Public Data Members
63 
64  /// @brief The first world object in the pair.
66  /// @brief The second world object in the pair.
68 
69  ///////////////////////////////////////////////////////////////////////////////
70  // Construction and Destruction
71 
72  /// @brief Class constructor.
74  /// @brief Class destructor.
75  virtual ~CollidablePair();
76 
77  ///////////////////////////////////////////////////////////////////////////////
78  // Utility
79 
80  /// @brief Checks to see if this pair is the same as another pair.
81  /// @param Pair The other pair to compare against.
82  /// @return Returns true if the pairs match regardless of ordering, false otherwise.
83  virtual bool PairsMatch(const CollidablePair& Pair) const;
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Operators
87 
88  /// @brief Checks to see if this pair is the same as another pair.
89  /// @param Pair The other pair to compare against.
90  /// @return Returns true if the pairs match regardless of ordering, false otherwise.
91  virtual bool operator==(const CollidablePair& Pair) const;
92  /// @brief Checks to see if this pair is less than another pair.
93  /// @remarks This check is based on combining the names of the objects and performing a std::string::compare on them.
94  /// @param Pair The other pair to compare against.
95  /// @return Returns true if this pair is found to be less then the passed in pair, false otherwise.
96  virtual bool operator<(const CollidablePair& Pair) const;
97  /// @brief Checks to see if this pair is greater than another pair.
98  /// @remarks This check is based on combining the names of the objects and performing a std::string::compare on them.
99  /// @param Pair The other pair to compare against.
100  /// @return Returns true if this pair is found to be greater then the passed in pair, false otherwise.
101  virtual bool operator>(const CollidablePair& Pair) const;
102  };// ©ollidablePair
103  }//Physics
104 }//Mezzanine
105 
106 #endif