Crazy Eddie's GUI System
0.8.4
|
Common base class used for renderable components within an ImagerySection. More...
Inherits CEGUI::AllocatedObject< FalagardComponentBase >.
Inherited by CEGUI::FrameComponent, CEGUI::ImageryComponent, and CEGUI::TextComponent.
Public Member Functions | |
void | render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
void | render (Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
const ComponentArea & | getComponentArea () const |
Return the ComponentArea of this component. | |
void | setComponentArea (const ComponentArea &area) |
Set the conponent's ComponentArea. | |
const ColourRect & | getColours () const |
Return the ColourRect used by this component. | |
void | setColours (const ColourRect &cols) |
Set the colours to be used by this component. | |
void | setColoursPropertySource (const String &property) |
Set the name of the property where colour values can be obtained. | |
virtual bool | handleFontRenderSizeChange (Window &window, const Font *font) const |
perform any processing required due to the given font having changed. | |
Protected Member Functions | |
void | initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const |
Helper function to initialise a ColourRect with appropriate values according to the way the component is set up. | |
virtual void | render_impl (Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const =0 |
Function to do main render caching work. | |
bool | writeColoursXML (XMLSerializer &xml_stream) const |
Writes xml for the colours to a OutStream. Will prefer property colours before explicit. | |
Protected Attributes | |
ComponentArea | d_area |
Destination area for this component. | |
ColourRect | d_colours |
base colours to be applied when rendering the image component. | |
String | d_colourPropertyName |
name of property to fetch colours from. |
Common base class used for renderable components within an ImagerySection.
const ColourRect& CEGUI::FalagardComponentBase::getColours | ( | ) | const |
Return the ColourRect used by this component.
const ComponentArea& CEGUI::FalagardComponentBase::getComponentArea | ( | ) | const |
Return the ComponentArea of this component.
void CEGUI::FalagardComponentBase::initColoursRect | ( | const Window & | wnd, |
const ColourRect * | modCols, | ||
ColourRect & | cr | ||
) | const [protected] |
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:
void CEGUI::FalagardComponentBase::render | ( | Window & | srcWindow, |
const CEGUI::ColourRect * | modColours = 0 , |
||
const Rectf * | clipper = 0 , |
||
bool | clipToDisplay = false |
||
) | const |
Render this component. More correctly, the component is cached for rendering.
srcWindow | Window to use as the base for translating the component's ComponentArea into pixel values. |
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 CEGUI::FalagardComponentBase::render | ( | Window & | srcWindow, |
const Rectf & | baseRect, | ||
const CEGUI::ColourRect * | modColours = 0 , |
||
const Rectf * | clipper = 0 , |
||
bool | clipToDisplay = false |
||
) | const |
Render this component. More correctly, the component is cached for rendering.
srcWindow | Window to use as the base for translating the component's ComponentArea into pixel values. |
baseRect | Rect to use as the base for translating the component's ComponentArea into pixel values. |
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 CEGUI::FalagardComponentBase::setColours | ( | const ColourRect & | cols | ) |
Set the colours to be used by this component.
cols | ColourRect object describing the colours to be used by this component. |
void CEGUI::FalagardComponentBase::setColoursPropertySource | ( | const String & | property | ) |
Set the name of the property where colour values can be obtained.
property | String containing the name of the property. |
void CEGUI::FalagardComponentBase::setComponentArea | ( | const ComponentArea & | area | ) |
Set the conponent's ComponentArea.
area | ComponentArea object describing a new target area for the component. |
bool CEGUI::FalagardComponentBase::writeColoursXML | ( | XMLSerializer & | xml_stream | ) | const [protected] |
Writes xml for the colours to a OutStream. Will prefer property colours before explicit.