141 lines
4.6 KiB
C++
Executable File
141 lines
4.6 KiB
C++
Executable File
/* _______ __ __ __ ______ __ __ _______ __ __
|
|
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
|
|
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
|
|
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
|
|
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
|
|
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
|
|
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
|
|
*
|
|
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
|
|
*
|
|
*
|
|
* Per Larsson a.k.a finalman
|
|
* Olof Naessén a.k.a jansem/yakslem
|
|
*
|
|
* Visit: http://guichan.sourceforge.net
|
|
*
|
|
* License: (BSD)
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name of Guichan nor the names of its contributors may
|
|
* be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
|
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef GCN_RECTANGLE_HPP
|
|
#define GCN_RECTANGLE_HPP
|
|
|
|
#include "guichan/platform.hpp"
|
|
|
|
#include <iostream>
|
|
|
|
namespace gcn
|
|
{
|
|
/**
|
|
* Represents a rectangle.
|
|
*
|
|
* @since 0.1.0
|
|
*/
|
|
class GCN_CORE_DECLSPEC Rectangle
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Constructor. The default rectangle is an empty rectangle
|
|
* at the coordinates (0,0).
|
|
*/
|
|
Rectangle();
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param x The x coordinate of the rectangle.
|
|
* @param y The y coordinate of the rectangle.
|
|
* @param width The width of the rectangle.
|
|
* @param height The height of the rectangle.
|
|
* @since 0.1.0
|
|
*/
|
|
Rectangle(int x, int y, int width, int height);
|
|
|
|
/**
|
|
* Sets the dimension of a rectangle.
|
|
*
|
|
* @param x The x coordinate of the rectangle.
|
|
* @param y The y coordinate of the rectangle.
|
|
* @param width The width of the rectangle.
|
|
* @param height The height of the rectangle.
|
|
* @since 0.1.0
|
|
*/
|
|
void setAll(int x, int y, int width, int height);
|
|
|
|
/**
|
|
* Checks if another rectangle intersects with the rectangle.
|
|
*
|
|
* @param rectangle Another rectangle to check for intersection.
|
|
* @return True if the rectangles intersect, false otherwise.
|
|
* @since 0.1.0
|
|
*/
|
|
bool isIntersecting(const Rectangle& rectangle) const;
|
|
|
|
/**
|
|
* Checks if a point is inside the rectangle
|
|
*
|
|
* @param x The x coordinate of the point.
|
|
* @param y The y coordinate of the point.
|
|
* @return True if the point is inside the rectangle.
|
|
* @since 0.1.0
|
|
*/
|
|
bool isPointInRect(int x, int y) const;
|
|
|
|
/**
|
|
* Output operator for output.
|
|
*
|
|
* @param out The stream to output to.
|
|
* @param rectangle The rectangle to output.
|
|
*/
|
|
friend std::ostream& operator<<(std::ostream& out,
|
|
const Rectangle& rectangle);
|
|
|
|
/**
|
|
* Holds the x coordinate of the rectangle.
|
|
*/
|
|
int x;
|
|
|
|
/**
|
|
* Holds the x coordinate of the rectangle.
|
|
*/
|
|
int y;
|
|
|
|
/**
|
|
* Holds the width of the rectangle.
|
|
*/
|
|
int width;
|
|
|
|
/**
|
|
* Holds the height of the rectangle.
|
|
*/
|
|
int height;
|
|
};
|
|
}
|
|
|
|
#endif // end GCN_RECTANGEL_HPP
|