/usr/include/cegui-0.8.7/CEGUI/falagard/ImagerySection.h is in libcegui-mk2-dev 0.8.7-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 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 | /***********************************************************************
created: Mon Jun 13 2005
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* 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 _CEGUIFalImagerySection_h_
#define _CEGUIFalImagerySection_h_
#include "./ImageryComponent.h"
#include "./TextComponent.h"
#include "./FrameComponent.h"
#include "../XMLSerializer.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Class that encapsulates a re-usable collection of imagery specifications.
*/
class CEGUIEXPORT ImagerySection :
public AllocatedObject<ImagerySection>
{
public:
//! Vector of ImageryComponent Pointers
typedef std::vector<ImageryComponent* CEGUI_VECTOR_ALLOC(ImageryComponent*)> ImageryComponentPointerList;
//! Vector of TextComponent Pointers
typedef std::vector<TextComponent* CEGUI_VECTOR_ALLOC(TextComponent*)> TextComponentPointerList;
//! Vector of FrameComponent Pointers
typedef std::vector<FrameComponent* CEGUI_VECTOR_ALLOC(FrameComponent*)> FrameComponentPointerList;
/*!
\brief
Constructor.
*/
ImagerySection();
/*!
\brief
ImagerySection constructor. Name must be supplied, masterColours are set to 0xFFFFFFFF by default.
\param name
Name of the new ImagerySection.
*/
ImagerySection(const String& name);
/*!
\brief
Render the ImagerySection.
\param srcWindow
Window object to be used when calculating pixel values from BaseDim values.
\param modColours
ColourRect specifying colours to be modulated with the ImagerySection's master colours. May be 0.
\return
Nothing.
*/
void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0, const Rectf* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Render the ImagerySection.
\param srcWindow
Window object to be used when calculating pixel values from BaseDim values.
\param baseRect
Rect object to be used when calculating pixel values from BaseDim values.
\param modColours
ColourRect specifying colours to be modulated with the ImagerySection's master colours. May be 0.
\return
Nothing.
*/
void render(Window& srcWindow, const Rectf& baseRect, const CEGUI::ColourRect* modColours = 0, const Rectf* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Add an ImageryComponent to this ImagerySection.
\param imageryComponent
ImageryComponent to be added to the section (a copy is made)
*/
void addImageryComponent(const ImageryComponent& imageryComponent);
/*!
\brief
Removes an ImageryComponent from this ImagerySection. The supplied ImagerySection reference should be
retrieved via the getImageryComponentPointers function. The check to find out which ImagerySection to remove
is done using memory address comparison (identity check).
\param imageryComponent
A reference to the ImageryComponent to be removed to the section
*/
void removeImageryComponent(const ImageryComponent& imageryComponent);
/*!
\brief
Clear all ImageryComponents from this ImagerySection.
\return
Nothing
*/
void clearImageryComponents();
/*!
\brief
Add a TextComponent to this ImagerySection.
\param textComponent
TextComponent to be added to the section (a copy is made)
*/
void addTextComponent(const TextComponent& textComponent);
/*!
\brief
Removes an TextComponent from this ImagerySection. The supplied TextComponent reference should be
retrieved via the getTextComponentPointers function. The check to find out which TextComponent to remove
is done using memory address comparison (identity check).
\param textComponent
A reference to the TextComponent to be removed to the section
*/
void removeTextComponent(const TextComponent& textComponent);
/*!
\brief
Clear all TextComponents from this ImagerySection.
\return
Nothing
*/
void clearTextComponents();
/*!
\brief
Clear all FrameComponents from this ImagerySection.
\return
Nothing
*/
void clearFrameComponents();
/*!
\brief
Add a FrameComponent to this ImagerySection.
\param frame
FrameComponent to be added to the section (a copy is made)
*/
void addFrameComponent(const FrameComponent& frameComponent);
/*!
\brief
Removes an FrameComponent from this ImagerySection. The supplied FrameComponent reference should be
retrieved via the getFrameComponentPointers function. The check to find out which FrameComponent to remove
is done using memory address comparison (identity check).
\param frameComponent
A reference to the FrameComponent to be removed to the section
*/
void removeFrameComponent(const FrameComponent& frameComponent);
/*!
\brief
Return the current master colours set for this ImagerySection.
\return
ColourRect describing the master colour values in use for this ImagerySection.
*/
const ColourRect& getMasterColours() const;
/*!
\brief
Set the master colours to be used for this ImagerySection.
\param cols
ColourRect describing the colours to be set as the master colours for this ImagerySection.
\return
Nothing.
*/
void setMasterColours(const ColourRect& cols);
/*!
\brief
Return the name of this ImagerySection.
\return
String object holding the name of the ImagerySection.
*/
const String& getName() const;
/*!
\brief
Sets the name of this ImagerySection.
\param name
String object holding the name of the ImagerySection.
\return
Nothing.
*/
void setName(const String& name);
/*!
\brief
Get the name of the property where master colour values can be obtained.
\return
String containing the name of the property.
*/
const String& getMasterColoursPropertySource() const;
/*!
\brief
Set the name of the property where master colour values can be obtained.
\param property
String containing the name of the property.
\return
Nothing.
*/
void setMasterColoursPropertySource(const String& property);
/*!
\brief
Return smallest Rect that could contain all imagery within this section.
*/
Rectf getBoundingRect(const Window& wnd) const;
/*!
\brief
Return smallest Rect that could contain all imagery within this section.
*/
Rectf getBoundingRect(const Window& wnd, const Rectf& rect) const;
/*!
\brief
Writes an xml representation of this ImagerySection to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
//! perform any processing required due to the given font having changed.
bool handleFontRenderSizeChange(Window& window, const Font* font) const;
/*!
\brief
Returns a vector of pointers to the ImageryComponents that are currently added to this ImagerySection. If an
ImageryComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid
anymore. The function should then be called again to retrieve valid pointers.
\return
A vector of pointers to the ImageryComponents that are currently added to this ImagerySection
*/
ImageryComponentPointerList getImageryComponentPointers();
/*!
\brief
Returns a vector of pointers to the TextComponents that are currently added to this ImagerySection. If a
TextComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid
anymore. The function should then be called again to retrieve valid pointers.
\return
A vector of pointers to the TextComponents that are currently added to this ImagerySection
*/
TextComponentPointerList getTextComponentPointers();
/*!
\brief
Returns a vector of pointers to the FrameComponents that are currently added to this ImagerySection. If a
FrameComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid
anymore. The function should then be called again to retrieve valid pointers.
\return
A vector of pointers to the FrameComponents that are currently added to this ImagerySection
*/
FrameComponentPointerList getFrameComponentPointers();
protected:
/*!
\brief
Helper method to initialise a ColourRect with appropriate values according to the way the
ImagerySection is set up.
This will try and get values from multiple places:
- a property attached to \a wnd
- or the integral d_masterColours value.
*/
void initMasterColourRect(const Window& wnd, ColourRect& cr) const;
private:
typedef std::vector<ImageryComponent
CEGUI_VECTOR_ALLOC(ImageryComponent)> ImageryList;
typedef std::vector<TextComponent
CEGUI_VECTOR_ALLOC(TextComponent)> TextList;
typedef std::vector<FrameComponent
CEGUI_VECTOR_ALLOC(FrameComponent)> FrameList;
CEGUI::String d_name; //!< Holds the name of the ImagerySection.
CEGUI::ColourRect d_masterColours; //!< Naster colours for the the ImagerySection (combined with colours of each ImageryComponent).
FrameList d_frames; //!< Collection of FrameComponent objects to be drawn for this ImagerySection.
ImageryList d_images; //!< Collection of ImageryComponent objects to be drawn for this ImagerySection.
TextList d_texts; //!< Collection of TextComponent objects to be drawn for this ImagerySection.
String d_colourPropertyName; //!< name of property to fetch colours from.
public:
//! \deprecated This iterator is deprecated because the function that uses the type is deprecated
typedef ConstVectorIterator<ImageryList> ImageryComponentIterator;
//! \deprecated This iterator is deprecated because the function that uses the type is deprecated
typedef ConstVectorIterator<TextList> TextComponentIterator;
//! \deprecated This iterator is deprecated because the function that uses the type is deprecated
typedef ConstVectorIterator<FrameList> FrameComponentIterator;
/*!
\brief
Return a ImagerySection::ImageryComponentIterator object to iterate
over the ImageryComponent elements currently added to the
ImagerySection.
\deprecated
This iterator is deprecated because it will be replaced by the function getImageryComponents
in the next version.
*/
ImageryComponentIterator getImageryComponentIterator() const;
/*!
\brief
Return a ImagerySection::TextComponentIterator object to iterate
over the TextComponent elements currently added to the
ImagerySection.
\deprecated
This iterator is deprecated because it will be replaced by the function getTextComponents
in the next version.
*/
TextComponentIterator getTextComponentIterator() const;
/*!
\brief
Return a ImagerySection::FrameComponentIterator object to iterate
over the FrameComponent elements currently added to the
ImagerySection.
\deprecated
This iterator is deprecated because it will be replaced by the function getFrameComponents
in the next version.
*/
FrameComponentIterator getFrameComponentIterator() const;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIFalImagerySection_h_
|