/usr/include/CEGUI/CEGUIImage.h is in libcegui-mk2-dev 0.7.6-3.3.
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 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 | /***********************************************************************
filename: CEGUIImage.h
created: 13/3/2004
author: Paul D Turner
purpose: Defines interface for Image class
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIImage_h_
#define _CEGUIImage_h_
#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIRect.h"
#include "CEGUIColourRect.h"
#include "CEGUIVector.h"
#include "CEGUISize.h"
#include "CEGUIRenderer.h"
#include "CEGUIXMLSerializer.h"
#include <map>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Class that represents a single Image of an Imageset.
*/
class CEGUIEXPORT Image
{
public:
/*!
\brief
Return a Size object containing the dimensions of the Image.
\return
Size object holding the width and height of the Image.
*/
Size getSize(void) const {return Size(d_scaledWidth, d_scaledHeight);}
/*!
\brief
Return the pixel width of the image.
\return
Width of this Image in pixels.
*/
float getWidth(void) const {return d_scaledWidth;}
/*!
\brief
Return the pixel height of the image.
\return
Height of this Image in pixels
*/
float getHeight(void) const {return d_scaledHeight;}
/*!
\brief
Return a Point object that contains the offset applied when rendering this Image
\return
Point object containing the offsets applied when rendering this Image
*/
Point getOffsets(void) const {return d_scaledOffset;}
/*!
\brief
Return the X rendering offset
\return
X rendering offset. This is the number of pixels that the image is offset by when rendering at any given location.
*/
float getOffsetX(void) const {return d_scaledOffset.d_x;}
/*!
\brief
Return the Y rendering offset
\return
Y rendering offset. This is the number of pixels that the image is offset by when rendering at any given location.
*/
float getOffsetY(void) const {return d_scaledOffset.d_y;}
/*!
\brief
Return the name of this Image object.
\return
String object containing the name of this Image
*/
const String& getName(void) const;
/*!
\brief
Return the name of the Imageset that contains this Image
\return
String object containing the name of the Imageset which this Image is a part of.
*/
const String& getImagesetName(void) const;
/*!
\brief
Return the parent Imageset object that contains this Image
\return
The parent Imageset object.
*/
const Imageset* getImageset(void) const {return d_owner;}
/*!
\brief
Return Rect describing the source texture area used by this Image.
\return
Rect object that describes, in pixels, the area upon the source texture
which is used when rendering this Image.
*/
const Rect& getSourceTextureArea(void) const;
/*!
\brief
Queue the image to be drawn.
\note
The final position of the Image will be adjusted by the offset values
defined for this Image object. If absolute positioning is essential
then these values should be taken into account prior to calling the
draw() methods. However, by doing this you take away the ability of the
Imageset designer to adjust the alignment and positioning of Images,
therefore your component is far less useful since it requires code
changes to modify image positioning that could have been handled from a
data file.
\param buffer
GeometryBuffer object where the geometry for the image will be queued.
\param position
Vector2 object containing the location where the Image is to be drawn
\param size
Size object describing the size that the Image is to be drawn at.
\param clip_rect
Rect object that defines an on-screen area that the Image will be
clipped to when drawing.
\param top_left_colour
Colour to be applied to the top-left corner of the Image.
\param top_right_colour
Colour to be applied to the top-right corner of the Image.
\param bottom_left_colour
Colour to be applied to the bottom-left corner of the Image.
\param bottom_right_colour
Colour to be applied to the bottom-right corner of the Image.
\param quad_split_mode
One of the QuadSplitMode values specifying the way the quad geometry for
the image is to be split into triangles.
\return
Nothing
*/
void draw(GeometryBuffer& buffer, const Vector2& position, const Size& size,
const Rect* clip_rect,
const colour& top_left_colour = 0xFFFFFFFF,
const colour& top_right_colour = 0xFFFFFFFF,
const colour& bottom_left_colour = 0xFFFFFFFF,
const colour& bottom_right_colour = 0xFFFFFFFF,
QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
{
draw(buffer, Rect(position.d_x, position.d_y,
position.d_x + size.d_width,
position.d_y + size.d_height),
clip_rect,
ColourRect(top_left_colour, top_right_colour, bottom_left_colour,
bottom_right_colour),
quad_split_mode);
}
/*!
\brief
Queue the image to be drawn.
\note
The final position of the Image will be adjusted by the offset values
defined for this Image object. If absolute positioning is essential
then these values should be taken into account prior to calling the
draw() methods. However, by doing this you take away the ability of the
Imageset designer to adjust the alignment and positioning of Images,
therefore your component is far less useful since it requires code
changes to modify image positioning that could have been handled from a
data file.
\param buffer
GeometryBuffer object where the geometry for the image will be queued.
\param dest_rect
Rect object defining the area on-screen where the Image is to be drawn.
The Image will be scaled to fill the area as required.
\param clip_rect
Rect object that defines an on-screen area that the Image will be
clipped to when drawing.
\param top_left_colour
Colour to be applied to the top-left corner of the Image.
\param top_right_colour
Colour to be applied to the top-right corner of the Image.
\param bottom_left_colour
Colour to be applied to the bottom-left corner of the Image.
\param bottom_right_colour
Colour to be applied to the bottom-right corner of the Image.
\param quad_split_mode
One of the QuadSplitMode values specifying the way the quad geometry for
the image is to be split into triangles.
\return
Nothing
*/
void draw(GeometryBuffer& buffer, const Rect& dest_rect,
const Rect* clip_rect,
const colour& top_left_colour = 0xFFFFFFFF,
const colour& top_right_colour = 0xFFFFFFFF,
const colour& bottom_left_colour = 0xFFFFFFFF,
const colour& bottom_right_colour = 0xFFFFFFFF,
QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
{
draw(buffer, dest_rect, clip_rect,
ColourRect(top_left_colour, top_right_colour,
bottom_left_colour, bottom_right_colour),
quad_split_mode);
}
/*!
\brief
Queue the image to be drawn.
\note
The final position of the Image will be adjusted by the offset values
defined for this Image object. If absolute positioning is essential
then these values should be taken into account prior to calling the
draw() methods. However, by doing this you take away the ability of the
Imageset designer to adjust the alignment and positioning of Images,
therefore your component is far less useful since it requires code
changes to modify image positioning that could have been handled from a
data file.
\param buffer
GeometryBuffer object where the geometry for the image will be queued.
\param position
Vector2 object containing the location where the Image is to be drawn.
\param size
Size object describing the size that the Image is to be drawn at.
\param clip_rect
Rect object that defines an on-screen area that the Image will be
clipped to when drawing.
\param colours
ColourRect object that describes the colour values to use for each
corner of the Image.
\param quad_split_mode
One of the QuadSplitMode values specifying the way the quad geometry for
the image is to be split into triangles.
\return
Nothing
*/
void draw(GeometryBuffer& buffer, const Vector2& position, const Size& size,
const Rect* clip_rect, const ColourRect& colours,
QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
{
draw(buffer, Rect(position.d_x, position.d_y,
position.d_x + size.d_width,
position.d_y + size.d_height),
clip_rect, colours, quad_split_mode);
}
/*!
\brief
Queue the image to be drawn.
\note
The final position of the Image will be adjusted by the offset values
defined for this Image object. If absolute positioning is essential
then these values should be taken into account prior to calling the
draw() methods. However, by doing this you take away the ability of the
Imageset designer to adjust the alignment and positioning of Images,
therefore your component is far less useful since it requires code
changes to modify image positioning that could have been handled from a
data file.
\param buffer
GeometryBuffer object where the geometry for the image will be queued.
\param position
Vector2 object containing the location where the Image is to be drawn
\note
The image will be drawn at it's internally defined size.
\param clip_rect
Rect object that defines an on-screen area that the Image will be
clipped to when drawing.
\param colours
ColourRect object that describes the colour values to use for each
corner of the Image.
\param quad_split_mode
One of the QuadSplitMode values specifying the way the quad geometry for
the image is to be split into triangles.
\return
Nothing
*/
void draw(GeometryBuffer& buffer, const Vector2& position,
const Rect* clip_rect, const ColourRect& colours,
QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
{
draw(buffer, Rect(position.d_x, position.d_y,
position.d_x + getWidth(),
position.d_y + getHeight()),
clip_rect, colours, quad_split_mode);
}
/*!
\brief
Queue the image to be drawn.
\note
The final position of the Image will be adjusted by the offset values
defined for this Image object. If absolute positioning is essential
then these values should be taken into account prior to calling the
draw() methods. However, by doing this you take away the ability of the
Imageset designer to adjust the alignment and positioning of Images,
therefore your component is far less useful since it requires code
changes to modify image positioning that could have been handled from a
data file.
\param buffer
GeometryBuffer object where the geometry for the image will be queued.
\param position
Vector2 object containing the location where the Image is to be drawn
\param clip_rect
Rect object that defines an on-screen area that the Image will be
clipped to when drawing.
\param top_left_colour
Colour to be applied to the top-left corner of the Image.
\param top_right_colour
Colour to be applied to the top-right corner of the Image.
\param bottom_left_colour
Colour to be applied to the bottom-left corner of the Image.
\param bottom_right_colour
Colour to be applied to the bottom-right corner of the Image.
\param quad_split_mode
One of the QuadSplitMode values specifying the way the quad geometry for
the image is to be split into triangles.
\return
Nothing
*/
void draw(GeometryBuffer& buffer, const Vector2& position,
const Rect* clip_rect,
const colour& top_left_colour = 0xFFFFFFFF,
const colour& top_right_colour = 0xFFFFFFFF,
const colour& bottom_left_colour = 0xFFFFFFFF,
const colour& bottom_right_colour = 0xFFFFFFFF,
QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
{
draw(buffer, Rect(position.d_x, position.d_y,
position.d_x + getWidth(),
position.d_y + getHeight()),
clip_rect,
ColourRect(top_left_colour, top_right_colour,
bottom_left_colour, bottom_right_colour),
quad_split_mode);
}
/*!
\brief
Queue the image to be drawn.
\note
The final position of the Image will be adjusted by the offset values
defined for this Image object. If absolute positioning is essential
then these values should be taken into account prior to calling the
draw() methods. However, by doing this you take away the ability of the
Imageset designer to adjust the alignment and positioning of Images,
therefore your component is far less useful since it requires code
changes to modify image positioning that could have been handled from a
data file.
\param buffer
GeometryBuffer object where the geometry for the image will be queued.
\param dest_rect
Rect object defining the area on-screen where the Image is to be drawn.
The Image will be scaled to fill the area as required.
\param clip_rect
Rect object that defines an on-screen area that the Image will be
clipped to when drawing.
\param colours
ColourRect object that describes the colour values to use for each
corner of the Image.
\param quad_split_mode
One of the QuadSplitMode values specifying the way the quad geometry for
the image is to be split into triangles.
\return
Nothing
*/
void draw(GeometryBuffer& buffer, const Rect& dest_rect,
const Rect* clip_rect, const ColourRect& colours,
QuadSplitMode quad_split_mode = TopLeftToBottomRight) const;
/*!
\brief
Writes an xml representation of this Image object to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
friend class std::map<String, Image, String::FastLessCompare>;
friend struct std::pair<const String, Image>;
/*************************************************************************
Construction and Destruction
*************************************************************************/
/*!
\brief
Default constructor (only used by std::map)
*/
Image(void) {}
/*!
\brief
Constructor for Image objects. This is not normally used directly by client code, use the Imageset interface instead.
\param owner
Pointer to a Imageset object that owns this Image. This must not be NULL.
\param name
String object describing the name of the image being created.
\param area
Rect object describing an area that will be associated with this image.
\param render_offset
Point object that describes the offset to be applied when rendering this image.
\param horzScaling
float value indicating the initial horizontal scaling to be applied to this image.
\param vertScaling
float value indicating the initial vertical scaling to be applied to this image.
\exception NullObjectException Thrown if \a owner was NULL.
*/
Image(const Imageset* owner, const String& name, const Rect& area, const Point& render_offset, float horzScaling = 1.0f, float vertScaling = 1.0f);
/*!
\brief
Copy constructor
*/
Image(const Image& image);
/*!
\brief
Destructor for Image objects.
*/
~Image(void);
private:
/*************************************************************************
Friends
*************************************************************************/
friend class Imageset;
/*************************************************************************
Implementation Methods
*************************************************************************/
/*!
\brief
set the horizontal scaling factor to be applied to this Image
\param factor
float value describing the scaling factor required.
\return
Nothing.
*/
void setHorzScaling(float factor);
/*!
\brief
set the vertical scaling factor to be applied to this Image
\param factor
float value describing the scaling factor required.
\return
Nothing.
*/
void setVertScaling(float factor);
/*************************************************************************
Implementation Data
*************************************************************************/
const Imageset* d_owner; //!< Link back to Imageset that owns this image
Rect d_area; //!< Rect defining the area on the texture that makes up this image.
Point d_offset; //!< Offset to use when rendering
// image auto-scaling fields.
float d_scaledWidth; //!< scaled image width.
float d_scaledHeight; //!< scaled image height.
Point d_scaledOffset; //!< scaled rendering offset.
String d_name; //!< name of this image.
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIImage_h_
|