/usr/include/CEGUI/CEGUIImageset.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 | /***********************************************************************
filename: CEGUIImageset.h
created: 21/2/2004
author: Paul D Turner
purpose: Defines the interface for the Imageset 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 _CEGUIImageset_h_
#define _CEGUIImageset_h_
#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIRect.h"
#include "CEGUIColourRect.h"
#include "CEGUIImagesetManager.h"
#include "CEGUIImage.h"
#include "CEGUIIteratorBase.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
Offers functions to define, access, and draw, a set of image components on a single graphical surface or Texture.
Imageset objects are a means by which a single graphical image (file, Texture, etc), can be split into a number
of 'components' which can later be accessed via name. The components of an Imageset can queried for
various details, and sent to the Renderer object for drawing.
*/
class CEGUIEXPORT Imageset
{
typedef std::map<String, Image, String::FastLessCompare> ImageRegistry;
public:
/*!
\brief
Construct a new Imageset object. Object will initially have no Images defined
\param texture
Texture object that holds the imagery for the Imageset being created.
*/
Imageset(const String& name, Texture& texture);
/*!
\brief
Construct a new Imageset using the specified image file and imageset name. The created
imageset will, by default, have a single Image defined named "full_image" which represents
the entire area of the loaded image file.
\note
Under certain renderers it may be required that the source image dimensions be some
power of 2, if this condition is not met then stretching and other undesired side-effects
may be experienced. To be safe from such effects it is generally recommended that all
images that you load have dimensions that are some power of 2.
\param name
String object holding the name to be assigned to the created imageset.
\param filename
String object holding the filename of the image that is to be loaded. The image should be
of some format that is supported by the Renderer that is in use.
\param resourceGroup
Resource group identifier to be passed to the resource manager, which may specify a group
from which the image file is to be loaded.
\exception FileIOException thrown if something goes wrong while loading the image.
*/
Imageset(const String& name, const String& filename, const String& resourceGroup);
/*!
\brief
Destroys Imageset objects
*/
~Imageset(void);
typedef ConstBaseIterator<ImageRegistry> ImageIterator; //!< Iterator type for this collection
/*************************************************************************
Public interface
*************************************************************************/
/*!
\brief
return Texture object for this Imageset
\return
Texture object that holds the imagery for this Imageset
*/
Texture* getTexture(void) const {return d_texture;}
/*!
\brief
return String object holding the name of the Imageset
\return
String object that holds the name of the Imageset.
*/
const String& getName(void) const {return d_name;}
/*!
\brief
return number of images defined for this Imageset
\return
uint value equal to the number of Image objects defined for the Imageset
*/
uint getImageCount(void) const {return (uint)d_images.size();}
/*!
\brief
return true if an Image with the specified name exists.
\param name
String object holding the name of the Image to look for.
\return
true if an Image object named \a name is defined for this Imageset, else false.
*/
bool isImageDefined(const String& name) const {return d_images.find(name) != d_images.end();}
/*!
\brief
return a copy of the Image object for the named image
\param name
String object holding the name of the Image object to be returned
\return
constant Image object that has the requested name.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
const Image& getImage(const String& name) const;
/*!
\brief
remove the definition for the Image with the specified name. If no such Image exists, nothing happens.
\param name
String object holding the name of the Image object to be removed from the Imageset,
\return
Nothing.
*/
void undefineImage(const String& name);
/*!
\brief
Removes the definitions for all Image objects currently defined in the Imageset
\return
Nothing
*/
void undefineAllImages(void);
/*!
\brief
return a Size object describing the dimensions of the named image.
\param name
String object holding the name of the Image.
\return
Size object holding the dimensions of the requested Image.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
Size getImageSize(const String& name) const {return getImage(name).getSize();}
/*!
\brief
return the width of the named image.
\param name
String object holding the name of the Image.
\return
float value equalling the width of the requested Image.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
float getImageWidth(const String& name) const {return getImage(name).getWidth();}
/*!
\brief
return the height of the named image.
\param name
String object holding the name of the Image.
\return
float value equalling the height of the requested Image.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
float getImageHeight(const String& name) const {return getImage(name).getHeight();}
/*!
\brief
return the rendering offsets applied to the named image.
\param name
String object holding the name of the Image.
\return
Point object that holds the rendering offsets for the requested Image.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
Point getImageOffset(const String& name) const {return getImage(name).getOffsets();}
/*!
\brief
return the x rendering offset for the named image.
\param name
String object holding the name of the Image.
\return
float value equal to the x rendering offset applied when drawing the requested Image.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
float getImageOffsetX(const String& name) const {return getImage(name).getOffsetX();}
/*!
\brief
return the y rendering offset for the named image.
\param name
String object holding the name of the Image.
\return
float value equal to the y rendering offset applied when drawing the requested Image.
\exception UnknownObjectException thrown if no Image named \a name is defined for the Imageset
*/
float getImageOffsetY(const String& name) const {return getImage(name).getOffsetY();}
/*!
\brief
Define a new Image for this Imageset
\param name
String object holding the name that will be assigned to the new Image, which must be unique within the Imageset.
\param position
Point object describing the pixel location of the Image on the image file / texture associated with this Imageset.
\param size
Size object describing the dimensions of the Image, in pixels.
\param render_offset
Point object describing the offsets, in pixels, that are to be applied to the Image when it is drawn.
\return
Nothing
\exception AlreadyExistsException thrown if an Image named \a name is already defined for this Imageset
*/
void defineImage(const String& name, const Point& position, const Size& size, const Point& render_offset)
{
defineImage(name, Rect(position.d_x, position.d_y, position.d_x + size.d_width, position.d_y + size.d_height), render_offset);
}
/*!
\brief
Define a new Image for this Imageset
\param name
String object holding the name that will be assigned to the new Image, which must be unique within the Imageset.
\param image_rect
Rect object describing the area on the image file / texture associated with this Imageset that will be used for the Image.
\param render_offset
Point object describing the offsets, in pixels, that are to be applied to the Image when it is drawn.
\return
Nothing
\exception AlreadyExistsException thrown if an Image named \a name is already defined for this Imageset
*/
void defineImage(const String& name, const Rect& image_rect, const Point& render_offset);
/*!
\brief
Queues an area of the associated Texture the be drawn on the screen.
Low-level routine to be used carefully!
\param buffer
GeometryBuffer object where the geometry for the area to be drawn will
be queued.
\param source_rect
Rect object describing the area of the image file / texture that is to
be queued for drawing
\param dest_rect
Rect describing the area of the screen that will be filled with the
imagery from \a source_rect.
\param clip_rect
Rect object describing a 'clipping rectangle' that will be applied when
drawing the requested imagery
\param colours
ColourRect object holding the ARGB colours to be applied to the four
corners of the rendered imagery.
\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& source_rect,
const Rect& dest_rect, const Rect* clip_rect,
const ColourRect& colours, QuadSplitMode quad_split_mode) const;
/*!
\brief
Queues an area of the associated Texture the be drawn on the screen.
Low-level routine to be used carefully!
\param buffer
GeometryBuffer object where the geometry for the area to be drawn will
be queued.
\param source_rect
Rect object describing the area of the image file / texture that is to
be queued for drawing.
\param dest_rect
Rect describing the area of the screen that will be filled with the
imagery from \a source_rect.
\param clip_rect
Rect object describing a 'clipping rectangle' that will be applied when
drawing the requested imagery.
\param top_left_colour
colour to be applied to the top left corner of the rendered imagery.
\param top_right_colour
colour to be applied to the top right corner of the rendered imagery.
\param bottom_left_colour
colour to be applied to the bottom left corner of the rendered imagery.
\param bottom_right_colour
colour to be applied to the bottom right corner of the rendered imagery.
\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& source_rect,
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, source_rect, dest_rect, clip_rect,
ColourRect(top_left_colour, top_right_colour,
bottom_left_colour, bottom_right_colour),
quad_split_mode);
}
/*!
\brief
Return whether this Imageset is auto-scaled.
\return
true if Imageset is auto-scaled, false if not.
*/
bool isAutoScaled(void) const {return d_autoScale;}
/*!
\brief
Return the native display size for this Imageset. This is only relevant if the Imageset is being auto-scaled.
\return
Size object describing the native display size for this Imageset.
*/
Size getNativeResolution(void) const {return Size(d_nativeHorzRes, d_nativeVertRes);}
/*!
\brief
Enable or disable auto-scaling for this Imageset.
\param setting
true to enable auto-scaling, false to disable auto-scaling.
\return
Nothing.
*/
void setAutoScalingEnabled(bool setting);
/*!
\brief
Set the native resolution for this Imageset
\param size
Size object describing the new native screen resolution for this Imageset.
\return
Nothing
*/
void setNativeResolution(const Size& size);
/*!
\brief
Notify the Imageset that the display size may have changed.
\param size
Size object describing the display resolution
*/
void notifyDisplaySizeChanged(const Size& size);
/*!
\brief
Return an Imageset::ImageIterator object that can be used to iterate over the Image objects in the Imageset.
*/
ImageIterator getIterator(void) const;
/*!
\brief
Writes an xml representation of this Imageset to \a out_stream.
\param out_stream
Stream where xml data should be output.
\param indentLevel
Current XML indentation level
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
/*!
\brief
Sets the default resource group to be used when loading imageset data
\param resourceGroup
String describing the default resource group identifier to be used.
\return
Nothing.
*/
static void setDefaultResourceGroup(const String& resourceGroup)
{ d_defaultResourceGroup = resourceGroup; }
/*!
\brief
Returns the default resource group currently set for Imagesets.
\return
String describing the default resource group identifier that will be
used when loading Imageset data.
*/
static const String& getDefaultResourceGroup()
{ return d_defaultResourceGroup; }
protected:
/*************************************************************************
Implementation Functions
*************************************************************************/
/*!
\brief
Unloads all loaded data and leaves the Imageset in a clean (but un-usable) state. This should be called for cleanup purposes only.
*/
void unload(void);
/*!
\brief
set the Texture object to be used by this Imageset. Changing textures on an Imageset that is in use is not a good idea!
\param texture
Texture object to be used by the Imageset. The old texture is NOT disposed of, that is the clients responsibility.
\return
Nothing
\exception NullObjectException thrown if \a texture is NULL
*/
void setTexture(Texture* texture);
/*!
\brief
Sets the scaling factor for all Images that are a part of this Imageset.
\return
Nothing.
*/
void updateImageScalingFactors(void);
/*************************************************************************
Implementation Data
*************************************************************************/
String d_name; //!< Holds the name of this imageset.
ImageRegistry d_images; //!< Registry of Image objects for the images defined for this Imageset
Texture* d_texture; //!< Texture object that handles imagery for this Imageset
String d_textureFilename; //!< String holding the name of the texture filename (if any).
// auto-scaling fields
bool d_autoScale; //!< true when auto-scaling is enabled.
float d_horzScaling; //!< current horizontal scaling factor.
float d_vertScaling; //!< current vertical scaling factor.
float d_nativeHorzRes; //!< native horizontal resolution for this Imageset.
float d_nativeVertRes; //!< native vertical resolution for this Imageset.
static String d_defaultResourceGroup; //!< Default resource group specifically for Imagesets.
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIImageset_h_
|