Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::UI::GridVector2 Struct Reference

Simple class used to represent positions or sizes on a grid. More...

#include <gridcontainer.h>

Public Member Functions

 GridVector2 ()
 Blank constructor.
 
 GridVector2 (const Whole x, const Whole y)
 Descriptive constructor. More...
 
Boole operator!= (const GridVector2 &Other)
 Inequality comparison operator. More...
 
Boole operator== (const GridVector2 &Other)
 Equality comparison operator. More...
 

Public Attributes

Whole X
 The Cell(s) on the X axis.
 
Whole Y
 The Cell(s) on the Y axis.
 

Detailed Description

Simple class used to represent positions or sizes on a grid.

Definition at line 57 of file gridcontainer.h.

Constructor & Destructor Documentation

Mezzanine::UI::GridVector2::GridVector2 ( const Whole  x,
const Whole  y 
)

Descriptive constructor.

Parameters
xThe Cell(s) on the X axis.
yThe Cell(s) on the Y axis.

Definition at line 63 of file gridcontainer.cpp.

Member Function Documentation

Boole Mezzanine::UI::GridVector2::operator!= ( const GridVector2 Other)

Inequality comparison operator.

Parameters
OtherThe other GridVector2 to compare with.
Returns
Returns true if this GridVector2 contains different values as the other GridVector2, false otherwise.

Definition at line 73 of file gridcontainer.cpp.

Boole Mezzanine::UI::GridVector2::operator== ( const GridVector2 Other)

Equality comparison operator.

Parameters
OtherThe other GridVector2 to compare with.
Returns
Returns true if both GridVector2s contain the same values, false otherwise.

Definition at line 70 of file gridcontainer.cpp.


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