Crazy Eddie's GUI System
0.8.1
|
Class that encapsulates a re-usable collection of imagery specifications. More...
Public Types | |
typedef ConstVectorIterator < ImageryList > | ImageryComponentIterator |
typedef ConstVectorIterator < TextList > | TextComponentIterator |
typedef ConstVectorIterator < FrameList > | FrameComponentIterator |
Public Member Functions | |
ImagerySection () | |
Constructor. | |
ImagerySection (const String &name) | |
ImagerySection constructor. Name must be supplied, masterColours are set to 0xFFFFFFFF by default. More... | |
void | render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const |
Render the ImagerySection. More... | |
void | render (Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const |
Render the ImagerySection. More... | |
void | addImageryComponent (const ImageryComponent &img) |
Add an ImageryComponent to this ImagerySection. More... | |
void | removeImageryComponent (const ImageryComponent &img) |
void | clearImageryComponents () |
Clear all ImageryComponents from this ImagerySection. More... | |
void | addTextComponent (const TextComponent &text) |
Add a TextComponent to this ImagerySection. More... | |
void | removeTextComponent (const TextComponent &text) |
void | clearTextComponents () |
Clear all TextComponents from this ImagerySection. More... | |
void | clearFrameComponents () |
Clear all FrameComponents from this ImagerySection. More... | |
void | addFrameComponent (const FrameComponent &frame) |
Add a FrameComponent to this ImagerySection. More... | |
void | removeFrameComponent (const FrameComponent &frame) |
const ColourRect & | getMasterColours () const |
Return the current master colours set for this ImagerySection. More... | |
void | setMasterColours (const ColourRect &cols) |
Set the master colours to be used for this ImagerySection. More... | |
const String & | getName () const |
Return the name of this ImagerySection. More... | |
void | setName (const String &name) |
Sets the name of this ImagerySection. More... | |
const String & | getMasterColoursPropertySource () const |
Get the name of the property where master colour values can be obtained. More... | |
void | setMasterColoursPropertySource (const String &property) |
Set the name of the property where master colour values can be obtained. More... | |
Rectf | getBoundingRect (const Window &wnd) const |
Return smallest Rect that could contain all imagery within this section. | |
Rectf | getBoundingRect (const Window &wnd, const Rectf &rect) const |
Return smallest Rect that could contain all imagery within this section. | |
void | writeXMLToStream (XMLSerializer &xml_stream) const |
Writes an xml representation of this ImagerySection to out_stream. More... | |
bool | handleFontRenderSizeChange (Window &window, const Font *font) const |
perform any processing required due to the given font having changed. | |
ImageryComponentIterator | getImageryComponentIterator () const |
Return a ImagerySection::ImageryComponentIterator object to iterate over the ImageryComponent elements currently added to the ImagerySection. | |
TextComponentIterator | getTextComponentIterator () const |
Return a ImagerySection::TextComponentIterator object to iterate over the TextComponent elements currently added to the ImagerySection. | |
FrameComponentIterator | getFrameComponentIterator () const |
Return a ImagerySection::FrameComponentIterator object to iterate over the FrameComponent elements currently added to the ImagerySection. | |
Protected Member Functions | |
void | initMasterColourRect (const Window &wnd, ColourRect &cr) const |
Helper method to initialise a ColourRect with appropriate values according to the way the ImagerySection is set up. More... | |
Class that encapsulates a re-usable collection of imagery specifications.
CEGUI::ImagerySection::ImagerySection | ( | const String & | name | ) |
ImagerySection constructor. Name must be supplied, masterColours are set to 0xFFFFFFFF by default.
name | Name of the new ImagerySection. |
void CEGUI::ImagerySection::addFrameComponent | ( | const FrameComponent & | frame | ) |
Add a FrameComponent to this ImagerySection.
frame | FrameComponent to be added to the section (a copy is made) |
void CEGUI::ImagerySection::addImageryComponent | ( | const ImageryComponent & | img | ) |
Add an ImageryComponent to this ImagerySection.
img | ImageryComponent to be added to the section (a copy is made) |
void CEGUI::ImagerySection::addTextComponent | ( | const TextComponent & | text | ) |
Add a TextComponent to this ImagerySection.
text | TextComponent to be added to the section (a copy is made) |
void CEGUI::ImagerySection::clearFrameComponents | ( | ) |
Clear all FrameComponents from this ImagerySection.
void CEGUI::ImagerySection::clearImageryComponents | ( | ) |
Clear all ImageryComponents from this ImagerySection.
void CEGUI::ImagerySection::clearTextComponents | ( | ) |
Clear all TextComponents from this ImagerySection.
const ColourRect& CEGUI::ImagerySection::getMasterColours | ( | ) | const |
Return the current master colours set for this ImagerySection.
const String& CEGUI::ImagerySection::getMasterColoursPropertySource | ( | ) | const |
Get the name of the property where master colour values can be obtained.
const String& CEGUI::ImagerySection::getName | ( | ) | const |
Return the name of this ImagerySection.
|
protected |
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:
void CEGUI::ImagerySection::render | ( | Window & | srcWindow, |
const CEGUI::ColourRect * | modColours = 0 , |
||
const Rectf * | clipper = 0 , |
||
bool | clipToDisplay = false |
||
) | const |
Render the ImagerySection.
srcWindow | Window object to be used when calculating pixel values from BaseDim values. |
modColours | ColourRect specifying colours to be modulated with the ImagerySection's master colours. May be 0. |
void CEGUI::ImagerySection::render | ( | Window & | srcWindow, |
const Rectf & | baseRect, | ||
const CEGUI::ColourRect * | modColours = 0 , |
||
const Rectf * | clipper = 0 , |
||
bool | clipToDisplay = false |
||
) | const |
Render the ImagerySection.
srcWindow | Window object to be used when calculating pixel values from BaseDim values. |
baseRect | Rect object to be used when calculating pixel values from BaseDim values. |
modColours | ColourRect specifying colours to be modulated with the ImagerySection's master colours. May be 0. |
void CEGUI::ImagerySection::setMasterColours | ( | const ColourRect & | cols | ) |
Set the master colours to be used for this ImagerySection.
cols | ColourRect describing the colours to be set as the master colours for this ImagerySection. |
void CEGUI::ImagerySection::setMasterColoursPropertySource | ( | const String & | property | ) |
Set the name of the property where master colour values can be obtained.
property | String containing the name of the property. |
void CEGUI::ImagerySection::setName | ( | const String & | name | ) |
Sets the name of this ImagerySection.
name | String object holding the name of the ImagerySection. |
void CEGUI::ImagerySection::writeXMLToStream | ( | XMLSerializer & | xml_stream | ) | const |
Writes an xml representation of this ImagerySection to out_stream.
xml_stream | Stream where xml data should be output. |