/usr/include/cegui-0.8.7/CEGUI/falagard/ComponentBase.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 | /***********************************************************************
created: Mon Jul 18 2005
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2012 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 _CEGUIFalComponentBase_h_
#define _CEGUIFalComponentBase_h_
#include "CEGUI/falagard/Dimensions.h"
#include "CEGUI/Window.h"
#include "CEGUI/ColourRect.h"
namespace CEGUI
{
//! Common base class used for renderable components within an ImagerySection.
class CEGUIEXPORT FalagardComponentBase :
public AllocatedObject<FalagardComponentBase>
{
public:
FalagardComponentBase();
virtual ~FalagardComponentBase();
/*!
\brief
Render this component. More correctly, the component is cached for
rendering.
\param srcWindow
Window to use as the base for translating the component's ComponentArea
into pixel values.
\param modColours
ColourRect describing colours that are to be modulated with the
component's stored colour values to calculate a set of 'final' colour
values to be used. May be 0.
*/
void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0,
const Rectf* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Render this component. More correctly, the component is cached for
rendering.
\param srcWindow
Window to use as the base for translating the component's ComponentArea
into pixel values.
\param baseRect
Rect to use as the base for translating the component's ComponentArea
into pixel values.
\param modColours
ColourRect describing colours that are to be modulated with the
component's stored colour values to calculate a set of 'final' colour
values to be used. May be 0.
*/
void render(Window& srcWindow, const Rectf& baseRect,
const CEGUI::ColourRect* modColours = 0,
const Rectf* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Return the ComponentArea of this component.
\return
ComponentArea object describing the component's current target area.
*/
const ComponentArea& getComponentArea() const;
/*!
\brief
Set the conponent's ComponentArea.
\param area
ComponentArea object describing a new target area for the component.
*/
void setComponentArea(const ComponentArea& area);
/*!
\brief
Return the ColourRect used by this component.
\return
ColourRect object holding the colours currently in use by this
component.
*/
const ColourRect& getColours() const;
/*!
\brief
Set the colours to be used by this component.
\param cols
ColourRect object describing the colours to be used by this component.
*/
void setColours(const ColourRect& cols);
/*!
\brief
Returns the name of the property from which the colour values will be obtained, if set.
\return
String object holding the name of the property.
*/
const String& getColoursPropertySource() const;
/*!
\brief
Set the name of the property where colour values will be obtained, if set.
\param property
String containing the name of the property.
*/
void setColoursPropertySource(const String& property);
//! perform any processing required due to the given font having changed.
virtual bool handleFontRenderSizeChange(Window& window,
const Font* font) const;
protected:
/*!
\brief
Helper function to initialise a ColourRect with appropriate values
according to the way the component is set up.
This will try and get values from multiple places:
- a property attached to \a wnd
- or the integral d_colours value.
*/
void initColoursRect(const Window& wnd,
const ColourRect* modCols,
ColourRect& cr) const;
//! Function to do main render caching work.
virtual void render_impl(Window& srcWindow, Rectf& destRect,
const CEGUI::ColourRect* modColours,
const Rectf* clipper, bool clipToDisplay) const = 0;
/*!
\brief
Writes xml for the colours to a OutStream.
Will prefer property colours before explicit.
\note
This is intended as a helper function for sub-classes when outputting
xml to a stream.
\return
- true if xml element was written.
- false if nothing was output due to the formatting not being set
(sub-class may then choose to do something else.)
*/
bool writeColoursXML(XMLSerializer& xml_stream) const;
//! Destination area for this component.
ComponentArea d_area;
//! base colours to be applied when rendering the image component.
ColourRect d_colours;
//! name of property to fetch colours from.
String d_colourPropertyName;
};
}
#endif
|