Mezzanine::UI::GridRect Struct Reference

Simple rect used to represent a complete transform on a grid. More...

#include <gridcontainer.h>

Collaboration diagram for Mezzanine::UI::GridRect:

Public Member Functions
	GridRect ()
	Blank constructor.
	GridRect (const Whole XPos, const Whole YPos, const Whole XSize, const Whole YSize)
	Descriptive constructor. More...
Boole	Envelopes (const GridRect &Other)
	Gets whether or not this GridRect completely envelopes another GridRect. More...
Whole	GetBottomCell () const
	Gets the Bottom cell of this Rect. More...
Whole	GetLeftCell () const
	Gets the Left cell of this Rect. More...
Whole	GetRightCell () const
	Gets the Right cell of this Rect. More...
Whole	GetTopCell () const
	Gets the Top cell of this Rect. More...
Boole	operator!= (const GridRect &Other)
	Inequality comparison operator. More...
Boole	operator== (const GridRect &Other)
	Equality comparison operator. More...
void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...
void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

Static Public Member Functions
static String	GetSerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized. More...

Public Attributes
GridVector2	Position
	The Cell position of this rect.
GridVector2	Size
	The Cell size of this rect.

Detailed Description

Simple rect used to represent a complete transform on a grid.

Definition at line 91 of file gridcontainer.h.

Constructor & Destructor Documentation

Mezzanine::UI::GridRect::GridRect	(	const Whole	XPos,
		const Whole	YPos,
		const Whole	XSize,
		const Whole	YSize
	)

Descriptive constructor.

Parameters

XPos	The Cell position on the X axis.
YPos	The Cell position on the Y axis.
XSize	The number of cells this rect occupies on the X axis.
YSize	The number of cells this rect occupies on the Y axis.

Definition at line 85 of file gridcontainer.cpp.

Member Function Documentation

Boole Mezzanine::UI::GridRect::Envelopes

(

const GridRect &

Other

)

Gets whether or not this GridRect completely envelopes another GridRect.

Parameters

Other

The other GridRect to compare to.

Returns

Returns true if the provided GridRect is completely overlapped by this GridRect, false otherwise.

Definition at line 105 of file gridcontainer.cpp.

Whole Mezzanine::UI::GridRect::GetBottomCell

(

)

const

Gets the Bottom cell of this Rect.

Returns

Returns the cell position of the Bottom of this Rect.

Definition at line 102 of file gridcontainer.cpp.

Whole Mezzanine::UI::GridRect::GetLeftCell

(

)

const

Gets the Left cell of this Rect.

Returns

Returns the cell position of the Left of this Rect.

Definition at line 93 of file gridcontainer.cpp.

Whole Mezzanine::UI::GridRect::GetRightCell

(

)

const

Gets the Right cell of this Rect.

Returns

Returns the cell position of the Right of this Rect.

Definition at line 96 of file gridcontainer.cpp.

String Mezzanine::UI::GridRect::GetSerializableName ( )

static

Get the name of the the XML tag this class will leave behind as its instances are serialized.

Returns

A string containing the name of this class.

Definition at line 158 of file gridcontainer.cpp.

Whole Mezzanine::UI::GridRect::GetTopCell

(

)

const

Gets the Top cell of this Rect.

Returns

Returns the cell position of the Top of this Rect.

Definition at line 99 of file gridcontainer.cpp.

Boole Mezzanine::UI::GridRect::operator!=

(

const GridRect &

Other

)

Inequality comparison operator.

Parameters

Other

The other GridRect to compare with.

Returns

Returns true if this GridRect does not represent the same transform as the other GridRect, false otherwise.

Definition at line 167 of file gridcontainer.cpp.

Boole Mezzanine::UI::GridRect::operator==

(

const GridRect &

Other

)

Equality comparison operator.

Parameters

Other

The other GridRect to compare with.

Returns

Returns true if both GridRects represent the same transform, false otherwise.

Definition at line 164 of file gridcontainer.cpp.

void Mezzanine::UI::GridRect::ProtoDeSerialize

(

const XML::Node &

SelfRoot

)

Take the data stored in an XML Node and overwrite this object with it.

Parameters

SelfRoot

An XML::Node containing the data to populate this class with.

Definition at line 129 of file gridcontainer.cpp.

void Mezzanine::UI::GridRect::ProtoSerialize

(

XML::Node &

ParentNode

)

const

Convert this class to an XML::Node ready for serialization.

Parameters

ParentNode

The point in the XML hierarchy that all this rect should be appended to.

Definition at line 113 of file gridcontainer.cpp.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/gridcontainer.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/gridcontainer.cpp