/usr/include/cegui-0.8.7/CEGUI/falagard/StateImagery.h is in libcegui-mk2-dev 0.8.7-1.3+b2.
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 | /***********************************************************************
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 _CEGUIFalStateImagery_h_
#define _CEGUIFalStateImagery_h_
#include "./LayerSpecification.h"
#include "../Window.h"
#include <set>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Class the encapsulates imagery for a given widget state.
*/
class CEGUIEXPORT StateImagery :
public AllocatedObject<StateImagery>
{
public:
//! Container type for LayerSpecification pointers
typedef std::vector<LayerSpecification*
CEGUI_VECTOR_ALLOC(LayerSpecification*)> LayerSpecificationPointerList;
/*!
\brief
Constructor
*/
StateImagery():
d_clipToDisplay(false)
{}
/*!
\brief
Constructor
\param name
Name of the state
*/
StateImagery(const String& name);
/*!
\brief
Render imagery for this state.
\param srcWindow
Window to use when convering BaseDim values to pixels.
\return
Nothing.
*/
void render(Window& srcWindow, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;
/*!
\brief
Render imagery for this state.
\param srcWindow
Window to use when convering BaseDim values to pixels.
\param baseRect
Rect to use when convering BaseDim values to pixels.
\return
Nothing.
*/
void render(Window& srcWindow, const Rectf& baseRect, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;
/*!
\brief
Add an imagery LayerSpecification to this state.
\param layer
LayerSpecification to be added to this state (will be copied)
\return
Nothing.
*/
void addLayer(const LayerSpecification& layer);
/*!
\brief
Sorts the LayerSpecifications after their priority. Whenever a LayerSpecification, which has been added
to this StateImagery, is changed, this sort function should be called.
*/
void sort();
/*!
\brief
Removed all LayerSpecifications from this state.
\return
Nothing.
*/
void clearLayers();
/*!
\brief
Return the name of this state.
\return
String object holding the name of the StateImagery object.
*/
const String& getName() const;
/*!
\brief
Set the name of this state.
\return
String object holding the name of the StateImagery object.
*/
void setName(const String& name);
/*!
\brief
Return whether this state imagery should be clipped to the display rather than the target window.
Clipping to the display effectively implies that the imagery should be rendered unclipped.
/return
- true if the imagery will be clipped to the display area.
- false if the imagery will be clipped to the target window area.
*/
bool isClippedToDisplay() const;
/*!
\brief
Set whether this state imagery should be clipped to the display rather than the target window.
Clipping to the display effectively implies that the imagery should be rendered unclipped.
\param setting
- true if the imagery should be clipped to the display area.
- false if the imagery should be clipped to the target window area.
\return
Nothing.
*/
void setClippedToDisplay(bool setting);
/*!
\brief
Writes an xml representation of this StateImagery to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
/*!
\brief
Returns a vector of pointers to the LayerSpecifications that are currently added to this StateImagery.
If a LayerSpecification is added or removed from this StateImagery, then the pointers in this vector are
not valid anymore. The function should then be called again to retrieve valid pointers.
\note
Whenever a pointer from this list is changed in a way that the multiset needs to be resorted, the sort
function of this class must be called.
\return
A vector of pointers to the LayerSpecifications that are currently added to this StateImagery
*/
LayerSpecificationPointerList getLayerSpecificationPointers();
private:
/*!
\deprecated
This type is deprecated because it doesn't use CEGUI allocators and is private and needs to be replaced with a vector that gets
sorted whenever needed. std::multisets and sets make their elements constant which introduces issues when changing them. In the next
version a new public type "LayerSpecificationList" will replace this one.
*/
typedef std::multiset<LayerSpecification> LayersList;
CEGUI::String d_stateName; //!< Name of this state.
LayersList d_layers; //!< Collection of LayerSpecification objects to be drawn for this state.
bool d_clipToDisplay; //!< true if Imagery for this state should be clipped to the display instead of winodw (effectively, not clipped).
public:
//! \deprecated This type is deprecated and will be removed in the next version. A const reference to the Container type of getLayerSpecifications will replace this.
typedef ConstVectorIterator<LayersList> LayerIterator;
//! \deprecated This function is deprecated. Instead the getLayerSpecifications will be used in the next version and getLayerSpecificationPointers can be used for editing.
LayerIterator getLayerIterator() const;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIFalStateImagery_h_
|