Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/rectangle.hpp @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_RECTANGLE_HPP
45 #define GCN_RECTANGLE_HPP
46
47 #include "guichan/platform.hpp"
48
49 #include <iostream>
50
51 namespace gcn
52 {
53 /**
54 * Represents a rectangle.
55 *
56 * @since 0.1.0
57 */
58 class GCN_CORE_DECLSPEC Rectangle
59 {
60 public:
61
62 /**
63 * Constructor. The default rectangle is an empty rectangle
64 * at the coordinates (0,0).
65 */
66 Rectangle();
67
68 /**
69 * Constructor.
70 *
71 * @param x The x coordinate of the rectangle.
72 * @param y The y coordinate of the rectangle.
73 * @param width The width of the rectangle.
74 * @param height The height of the rectangle.
75 * @since 0.1.0
76 */
77 Rectangle(int x, int y, int width, int height);
78
79 /**
80 * Sets the dimension of a rectangle.
81 *
82 * @param x The x coordinate of the rectangle.
83 * @param y The y coordinate of the rectangle.
84 * @param width The width of the rectangle.
85 * @param height The height of the rectangle.
86 * @since 0.1.0
87 */
88 void setAll(int x, int y, int width, int height);
89
90 /**
91 * Checks if another rectangle intersects with the rectangle.
92 *
93 * @param rectangle Another rectangle to check for intersection.
94 * @return True if the rectangles intersect, false otherwise.
95 * @since 0.1.0
96 */
97 bool isIntersecting(const Rectangle& rectangle) const;
98
99 /**
100 * Checks if a point is inside the rectangle
101 *
102 * @param x The x coordinate of the point.
103 * @param y The y coordinate of the point.
104 * @return True if the point is inside the rectangle.
105 * @since 0.1.0
106 */
107 bool isPointInRect(int x, int y) const;
108
109 /**
110 * Output operator for output.
111 *
112 * @param out The stream to output to.
113 * @param rectangle The rectangle to output.
114 */
115 friend std::ostream& operator<<(std::ostream& out,
116 const Rectangle& rectangle);
117
118 /**
119 * Holds the x coordinate of the rectangle.
120 */
121 int x;
122
123 /**
124 * Holds the x coordinate of the rectangle.
125 */
126 int y;
127
128 /**
129 * Holds the width of the rectangle.
130 */
131 int width;
132
133 /**
134 * Holds the height of the rectangle.
135 */
136 int height;
137 };
138 }
139
140 #endif // end GCN_RECTANGEL_HPP