/usr/include/CEGUI/falagard/CEGUIFalImagerySection.h is in libcegui-mk2-dev 0.7.6-2ubuntu4.
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 | /***********************************************************************
filename: CEGUIFalImagerySection.h
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 "CEGUIFalImageryComponent.h"
#include "CEGUIFalTextComponent.h"
#include "CEGUIFalFrameComponent.h"
#include "../CEGUIXMLSerializer.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:
/*!
\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 Rect* 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 Rect& baseRect, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Add an ImageryComponent to this ImagerySection.
\param img
ImageryComponent to be added to the section (a copy is made)
\return
Nothing
*/
void addImageryComponent(const ImageryComponent& img);
/*!
\brief
Clear all ImageryComponents from this ImagerySection.
\return
Nothing
*/
void clearImageryComponents();
/*!
\brief
Add a TextComponent to this ImagerySection.
\param text
TextComponent to be added to the section (a copy is made)
\return
Nothing
*/
void addTextComponent(const TextComponent& text);
/*!
\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)
\return
Nothing
*/
void addFrameComponent(const FrameComponent& frame);
/*!
\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
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
Set whether the master colours property source represents a full ColourRect.
\param setting
- true if the master colours property will access a ColourRect object.
- false if the master colours property will access a colour object.
\return
Nothing.
*/
void setMasterColoursPropertyIsColourRect(bool setting = true);
/*!
\brief
Return smallest Rect that could contain all imagery within this section.
*/
Rect getBoundingRect(const Window& wnd) const;
/*!
\brief
Return smallest Rect that could contain all imagery within this section.
*/
Rect getBoundingRect(const Window& wnd, const Rect& 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;
//! return number of TextComponents in the ImagerySection.
size_t getTextComponentCount() const;
//! return a reference to a TextComponent (via index).
const TextComponent& getTextComponent(const size_t idx) const;
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> ImageryList;
typedef std::vector<TextComponent> TextList;
typedef std::vector<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.
bool d_colourProperyIsRect; //!< true if the colour property will fetch a full ColourRect.
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIFalImagerySection_h_
|