// NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
// Copyright (C) 2010  Winch Gate Property Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef NL_RECT_H
#define NL_RECT_H

#include "types_nl.h"


namespace NLMISC {

class CVector2f;


/**
 * This class describe an integer 2d rectangle.
 * \author Cyril Corvazier
 * \author Nevrax France
 * \date 2000
 */
class CRect
{
public:
	/// default ctor
	CRect() {}

	/// Constructor with a 2d point, a width and a height
	CRect (sint32 x, sint32 y, uint32 width, uint32 height);

	/// Constructor with a single 2d point. Build a rectangle with width and height = 0.
	CRect (sint32 x, sint32 y)
	{
		X=x;
		Y=y;
		Width=0;
		Height=0;
	}

	/// Set from a 2d point, a width and a height
	void setWH(sint32 x, sint32 y, uint32 width, uint32 height);

	/// Set from 2 2d points
	void set(sint32 x0, sint32 y0, sint32 x1, sint32 y1);

	/// Extend the box for including the point which coordinates are passed in parameter.
	void		extend (sint32 x, sint32 y);

	/// Return the lower X coordinate of the box
	sint32		left() const
	{
		return X;
	}

	/// Return the higher X coordinate of the box + 1
	sint32		right() const
	{
		return X+(sint32)Width;
	}

	/// Return the lower Y coordinate of the box
	sint32		top() const
	{
		return Y;
	}

	/// Return the higher Y coordinate of the box + 1
	sint32		bottom() const
	{
		return Y+(sint32)Height;
	}

	/// Compute the x center of the rectangle
	sint32		getXCenter() const
	{
		return X+(sint32)(Width>>1);
	}

	/// Compute the y center of the rectangle
	sint32		getYCenter() const
	{
		return Y+(sint32)(Height>>1);
	}

	/// Lower X coordinate of the rect
	sint32		X;

	/// Lower Y coordinate of the rect
	sint32		Y;

	/// Width of the rect
	uint32		Width;

	/// Height of the rect
	uint32		Height;
};


} // NLMISC


#endif // NL_RECT_H

/* End of rect.h */