Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/cliprectangle.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_CLIPRECTANGLE_HPP
45 #define GCN_CLIPRECTANGLE_HPP
46
47 #include "guichan/rectangle.hpp"
48 #include "guichan/platform.hpp"
49
50 namespace gcn
51 {
52 /**
53 * A rectangle used when dealing with clipping. A clip rectangle is
54 * a regular rectangle extended with variables for x offsets and y
55 * offsets. The offsets are used for calculations from relative
56 * screen coordinates to actual screen coordinates.
57 */
58 class GCN_CORE_DECLSPEC ClipRectangle : public Rectangle
59 {
60 public:
61
62 /**
63 * Constructor.
64 */
65 ClipRectangle();
66
67 /**
68 * Constructor.
69 *
70 * @param x The rectangle x coordinate.
71 * @param y The rectangle y coordinate.
72 * @param width The rectangle width.
73 * @param height The rectangle height.
74 * @param xOffset The offset of the x coordinate. Used to for
75 * calculating the actual screen coordinate from
76 * the relative screen coordinate.
77 * @param yOffset The offset of the y coordinate. Used to for
78 * calculating the actual screen coordinate from
79 * the relative screen coordinate.
80 */
81 ClipRectangle(int x,
82 int y,
83 int width,
84 int height,
85 int xOffset,
86 int yOffset);
87
88 /**
89 * Copy constructor. Copies x, y, width and height
90 * field from a rectangle to a clip rectangle.
91 *
92 * @param other The rectangle to copy data from.
93 * @returns A clip rectangle with data copyied from a rectangle.
94 */
95 const ClipRectangle& operator=(const Rectangle& other);
96
97 /**
98 * Holds the x offset of the x coordinate.
99 */
100 int xOffset;
101
102 /**
103 * Holds the y offset of the y coordinate.
104 */
105 int yOffset;
106 };
107 }
108
109 #endif // end GCN_CLIPRECTANGLE_HPP