Mezzanine::Physics::CollidablePair Class Reference

This is a helper class for storing pairs of collidable proxies in associative containers. More...

#include <collidablepair.h>

Collaboration diagram for Mezzanine::Physics::CollidablePair:

Public Member Functions
	CollidablePair (CollidableProxy *A, CollidableProxy *B)
	Class constructor. More...
virtual	~CollidablePair ()
	Class destructor.
virtual Boole	operator< (const CollidablePair &Pair) const
	Checks to see if this pair is less than another pair. More...
virtual Boole	operator== (const CollidablePair &Pair) const
	Checks to see if this pair is the same as another pair. More...
virtual Boole	operator> (const CollidablePair &Pair) const
	Checks to see if this pair is greater than another pair. More...
virtual Boole	PairsMatch (const CollidablePair &Pair) const
	Checks to see if this pair is the same as another pair. More...

Public Attributes
CollidableProxy *	ProxyA
	The first world object in the pair.
CollidableProxy *	ProxyB
	The second world object in the pair.

Protected Member Functions
virtual UInt64	GetPairID () const
	Gets the combined ID of the objects in this pair. More...

Detailed Description

This is a helper class for storing pairs of collidable proxies in associative containers.

Most commonly this class is used in collision tracking.

Definition at line 54 of file collidablepair.h.

Constructor & Destructor Documentation

Mezzanine::Physics::CollidablePair::CollidablePair	(	CollidableProxy *	A,
		CollidableProxy *	B
	)

Class constructor.

Parameters

A	The first proxy in the collision pair.
B	The second proxy in the collision pair.

Definition at line 53 of file collidablepair.cpp.

Member Function Documentation

UInt64 Mezzanine::Physics::CollidablePair::GetPairID ( ) const

protectedvirtual

Gets the combined ID of the objects in this pair.

Definition at line 60 of file collidablepair.cpp.

Boole Mezzanine::Physics::CollidablePair::operator< ( const CollidablePair &  Pair ) const

virtual

Checks to see if this pair is less than another pair.

Remarks

This check is based on combining the names of the objects and performing a std::string::compare on them.

Parameters

Pair	The other pair to compare against.

Returns

Returns true if this pair is found to be less then the passed in pair, false otherwise.

Definition at line 83 of file collidablepair.cpp.

Boole Mezzanine::Physics::CollidablePair::operator== ( const CollidablePair &  Pair ) const

virtual

Checks to see if this pair is the same as another pair.

Parameters

Pair	The other pair to compare against.

Returns

Returns true if the pairs match regardless of ordering, false otherwise.

Definition at line 80 of file collidablepair.cpp.

Boole Mezzanine::Physics::CollidablePair::operator> ( const CollidablePair &  Pair ) const

virtual

Checks to see if this pair is greater than another pair.

Remarks

This check is based on combining the names of the objects and performing a std::string::compare on them.

Parameters

Pair	The other pair to compare against.

Returns

Returns true if this pair is found to be greater then the passed in pair, false otherwise.

Definition at line 86 of file collidablepair.cpp.

Boole Mezzanine::Physics::CollidablePair::PairsMatch ( const CollidablePair &  Pair ) const

virtual

Checks to see if this pair is the same as another pair.

Parameters

Pair	The other pair to compare against.

Returns

Returns true if the pairs match regardless of ordering, false otherwise.

Definition at line 70 of file collidablepair.cpp.

---

The documentation for this class was generated from the following files:

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Physics/collidablepair.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Physics/collidablepair.cpp