1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/***************************************************************************
* Copyright (c) 2017-2019 by the fifechan team *
* https://github.com/fifengine/fifechan *
* This file is part of fifechan. *
* *
* fifechan is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naessn and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naessn 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 FCN_RECTANGLE_HPP
#define FCN_RECTANGLE_HPP
#include "fifechan/platform.hpp"
#include <iostream>
namespace fcn
{
/**
* Represents a rectangle.
*
*/
class FCN_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.
*/
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.
*/
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.
*/
bool isIntersecting(const Rectangle& rectangle) const;
/**
* Checks the rectangle contains a point.
*
* @param x The x coordinate of the point.
* @param y The y coordinate of the point.
* @return True if the rectangle contains the point,
* false otherwise.
*/
bool isContaining(int x, int y) const;
/**
* Checks if the rectangle contains a rectangle.
*
* @param other The rectangle to check.
* @return True if the rectangle contains the rectangle,
* false otherwise.
*/
bool isContaining(const Rectangle& other) const;
/**
* Checks whether the rectangle is empty or not. A rectangle
* is considered empty when it's width or height is either
* zero or negative.
*
* @return True if the rectangle is empty, false otherwise.
*/
bool isEmpty() const;
/**
* Adds a rectangle to this rectangle. The resulting rectangle
* is the union of the two rectangles.
*
* @param rh The rectangle to add.
* @return The union of the two rectangles.
*/
Rectangle operator+(const Rectangle& rh) const;
/**
* Adds a rectangle to this rectangle. This rectangle will be
* the union of the two rectangles.
*
* @param rh The rectangle to add.
* @return A reference to this rectangle.
*/
const Rectangle& operator+=(const Rectangle& rh);
/**
* Gets the intersection between two rectangles.
*
* @param rh The rectangle to calculate the intersection with.
* @return The intersection between two rectangles.
*/
Rectangle intersection(const Rectangle& rh) 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 FCN_RECTANGEL_HPP
|
