/usr/include/fifechan/graphics.hpp is in libfifechan-dev 0.1.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 | /***************************************************************************
* Copyright (c) 2017 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 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 FCN_GRAPHICS_HPP
#define FCN_GRAPHICS_HPP
#include <iosfwd>
#include <stack>
#include "fifechan/cliprectangle.hpp"
#include "fifechan/platform.hpp"
namespace fcn
{
class Color;
class Font;
class Image;
/**
* Abstract class for providing drawing primitve functions.
* It contains all vital functions for drawing.
*
* Guichan contains implementations of Graphics for common
* libraries like the Allegro library, the HGE library,
* the OpenGL library, the OpenLayer library, and the SDL library.
* To make Guichan usable with other libraries, a Graphics class
* must be implemented.
*
* In Graphics you can set clip areas to limit drawing to certain
* areas of the screen. Clip areas are put on a stack, which
* means that you can push smaller and smaller clip areas onto the
* stack. All coordinates will be relative to the top most clip area.
* In most cases you won't have to worry about the clip areas,
* unless you want to implement some really complex widget.
* Pushing and poping of clip areas are handled automatically by
* container widgets when their child widgets are drawn.
*
* IMPORTANT: Remember to pop each clip area that you pushed on the stack
* after you are done with it.
*
* If you feel that Graphics is to restrictive for your needs,
* there is no one stopping you from using your own code for drawing
* in widgets. You could for instance use pure SDL in the drawing of
* widgets bypassing Graphics. This might however hurt portability of
* your application.
*
* If you implement a Graphics class not present in Guichan we would
* be very happy to add it to Guichan.
*
* @see AllegroGraphics, HGEGraphics, OpenLayerGraphics, OpenGLGraphics,
* SDLGraphics, Image
*/
class FCN_CORE_DECLSPEC Graphics
{
public:
/**
* Alignments for text drawing.
*/
enum Alignment
{
Left = 0,
Center,
Right
};
/**
* Constructor.
*/
Graphics();
/**
* Destructor.
*/
virtual ~Graphics() { }
/**
* Initializes drawing. Called by the Gui when Gui::draw() is called.
* It is needed by some implementations of Graphics to perform
* preparations before drawing. An example of such an implementation
* is the OpenGLGraphics.
*
* NOTE: You will never need to call this function yourself, unless
* you use a Graphics object outside of Guichan.
*
* @see _endDraw, Gui::draw
*/
virtual void _beginDraw() { }
/**
* Deinitializes drawing. Called by the Gui when a Gui::draw() is done.
* done. It should reset any state changes made by _beginDraw().
*
* NOTE: You will never need to call this function yourself, unless
* you use a Graphics object outside of Guichan.
*
* @see _beginDraw, Gui::draw
*/
virtual void _endDraw() { }
/**
* Pushes a clip area onto the stack. The x and y coordinates in the
* rectangle is relative to the last pushed clip area.
* If the new area falls outside the current clip area, it will be
* clipped as necessary.
*
* If a clip area is outside of the top clip area a clip area with
* zero width and height will be pushed.
*
* @param area The clip area to be pushed onto the stack.
* @return False if the the new area lays outside the current clip
* area.
*/
virtual bool pushClipArea(Rectangle area);
/**
* Removes the top most clip area from the stack.
*
* @throws Exception if the stack is empty.
*/
virtual void popClipArea();
/**
* Gets the current clip area. Usefull if you want to do drawing
* bypassing Graphics.
*
* @return The current clip area.
*/
virtual const ClipRectangle& getCurrentClipArea();
/**
* Draws a part of an image.
*
* NOTE: Width and height arguments will not scale the image but
* specifies the size of the part to be drawn. If you want
* to draw the whole image there is a simplified version of
* this function.
*
* EXAMPLE: @code drawImage(myImage, 10, 10, 20, 20, 40, 40); @endcode
* Will draw a rectangular piece of myImage starting at
* coordinate (10, 10) in myImage, with width and height 40.
* The piece will be drawn with it's top left corner at
* coordinate (20, 20).
*
* @param image The image to draw.
* @param srcX The source image x coordinate.
* @param srcY The source image y coordinate.
* @param dstX The destination x coordinate.
* @param dstY The destination y coordinate.
* @param width The width of the piece.
* @param height The height of the piece.
*/
virtual void drawImage(const Image* image,
int srcX,
int srcY,
int dstX,
int dstY,
int width,
int height) = 0;
/**
* Draws an image. A simplified version of the other drawImage.
* It will draw a whole image at the coordinate you specify.
* It is equivalent to calling:
* @code drawImage(myImage, 0, 0, dstX, dstY, image->getWidth(), \
image->getHeight()); @endcode
*/
virtual void drawImage(const Image* image, int dstX, int dstY);
/**
* Draws a single point/pixel.
*
* @param x The x coordinate.
* @param y The y coordinate.
*/
virtual void drawPoint(int x, int y) = 0;
/**
* Ddraws a line.
*
* @param x1 The first x coordinate.
* @param y1 The first y coordinate.
* @param x2 The second x coordinate.
* @param y2 The second y coordinate.
*/
virtual void drawLine(int x1, int y1, int x2, int y2) = 0;
/**
* Draws a simple, non-filled rectangle with a one pixel width.
*
* @param rectangle The rectangle to draw.
*/
virtual void drawRectangle(const Rectangle& rectangle) = 0;
/**
* Draws a simple, non-filled rectangle with a one pixel width.
*
* This is an overload provided for convenience.
*
* @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
*
*/
inline void drawRectangle(int x, int y, int width, int height)
{ drawRectangle(Rectangle(x, y, width, height)); }
/**
* Draws a filled rectangle.
*
* @param rectangle The filled rectangle to draw.
*/
virtual void fillRectangle(const Rectangle& rectangle) = 0;
/**
* Draws a filled rectangle.
*
* This is an overload provided for convenience.
*
* @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
*
*/
inline void fillRectangle(int x, int y, int width, int height)
{ fillRectangle(Rectangle(x, y, width, height)); }
/**
* Sets the color to use when drawing.
*
* @param color A color.
* @see getColor
*/
virtual void setColor(const Color& color) = 0;
/**
* Gets the color to use when drawing.
*
* @return The color used when drawing.
* @see setColor
*/
virtual const Color& getColor() const = 0;
/**
* Sets the font to use when drawing text.
*
* @param font The font to use when drawing.
*/
virtual void setFont(Font* font);
/**
* Draws text.
*
* @param text The text to draw.
* @param x The x coordinate where to draw the text.
* @param y The y coordinate where to draw the text.
* @param alignment The alignemnt to use when drawing.
* @throws Exception when no font has been set.
*/
virtual void drawText(const std::string& text,
int x,
int y,
Alignment alignment = Left);
protected:
/**
* Holds the clip area stack.
*/
std::stack<ClipRectangle> mClipStack;
/**
* Holds the current font.
*/
Font* mFont;
};
}
#endif // end FCN_GRAPHICS_HPP
|