Crazy Eddie's GUI System
0.8.7
|
Class that encapsulates a re-usable collection of imagery specifications. More...
Public Types | |
typedef std::vector< ImageryComponent *CEGUI_VECTOR_ALLOC(ImageryComponent *)> | ImageryComponentPointerList |
Vector of ImageryComponent Pointers. | |
typedef std::vector< TextComponent *CEGUI_VECTOR_ALLOC(TextComponent *)> | TextComponentPointerList |
Vector of TextComponent Pointers. | |
typedef std::vector< FrameComponent *CEGUI_VECTOR_ALLOC(FrameComponent *)> | FrameComponentPointerList |
Vector of FrameComponent Pointers. | |
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 &imageryComponent) |
Add an ImageryComponent to this ImagerySection. More... | |
void | removeImageryComponent (const ImageryComponent &imageryComponent) |
Removes an ImageryComponent from this ImagerySection. The supplied ImagerySection reference should be retrieved via the getImageryComponentPointers function. The check to find out which ImagerySection to remove is done using memory address comparison (identity check). More... | |
void | clearImageryComponents () |
Clear all ImageryComponents from this ImagerySection. More... | |
void | addTextComponent (const TextComponent &textComponent) |
Add a TextComponent to this ImagerySection. More... | |
void | removeTextComponent (const TextComponent &textComponent) |
Removes an TextComponent from this ImagerySection. The supplied TextComponent reference should be retrieved via the getTextComponentPointers function. The check to find out which TextComponent to remove is done using memory address comparison (identity check). More... | |
void | clearTextComponents () |
Clear all TextComponents from this ImagerySection. More... | |
void | clearFrameComponents () |
Clear all FrameComponents from this ImagerySection. More... | |
void | addFrameComponent (const FrameComponent &frameComponent) |
Add a FrameComponent to this ImagerySection. More... | |
void | removeFrameComponent (const FrameComponent &frameComponent) |
Removes an FrameComponent from this ImagerySection. The supplied FrameComponent reference should be retrieved via the getFrameComponentPointers function. The check to find out which FrameComponent to remove is done using memory address comparison (identity check). More... | |
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. | |
ImageryComponentPointerList | getImageryComponentPointers () |
Returns a vector of pointers to the ImageryComponents that are currently added to this ImagerySection. If an ImageryComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers. More... | |
TextComponentPointerList | getTextComponentPointers () |
Returns a vector of pointers to the TextComponents that are currently added to this ImagerySection. If a TextComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers. More... | |
FrameComponentPointerList | getFrameComponentPointers () |
Returns a vector of pointers to the FrameComponents that are currently added to this ImagerySection. If a FrameComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers. More... | |
ImageryComponentIterator | getImageryComponentIterator () const |
Return a ImagerySection::ImageryComponentIterator object to iterate over the ImageryComponent elements currently added to the ImagerySection. More... | |
TextComponentIterator | getTextComponentIterator () const |
Return a ImagerySection::TextComponentIterator object to iterate over the TextComponent elements currently added to the ImagerySection. More... | |
FrameComponentIterator | getFrameComponentIterator () const |
Return a ImagerySection::FrameComponentIterator object to iterate over the FrameComponent elements currently added to the ImagerySection. More... | |
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.
typedef ConstVectorIterator<FrameList> CEGUI::ImagerySection::FrameComponentIterator |
typedef ConstVectorIterator<ImageryList> CEGUI::ImagerySection::ImageryComponentIterator |
typedef ConstVectorIterator<TextList> CEGUI::ImagerySection::TextComponentIterator |
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 & | frameComponent | ) |
Add a FrameComponent to this ImagerySection.
frame | FrameComponent to be added to the section (a copy is made) |
void CEGUI::ImagerySection::addImageryComponent | ( | const ImageryComponent & | imageryComponent | ) |
Add an ImageryComponent to this ImagerySection.
imageryComponent | ImageryComponent to be added to the section (a copy is made) |
void CEGUI::ImagerySection::addTextComponent | ( | const TextComponent & | textComponent | ) |
Add a TextComponent to this ImagerySection.
textComponent | 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.
FrameComponentIterator CEGUI::ImagerySection::getFrameComponentIterator | ( | ) | const |
Return a ImagerySection::FrameComponentIterator object to iterate over the FrameComponent elements currently added to the ImagerySection.
FrameComponentPointerList CEGUI::ImagerySection::getFrameComponentPointers | ( | ) |
Returns a vector of pointers to the FrameComponents that are currently added to this ImagerySection. If a FrameComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers.
ImageryComponentIterator CEGUI::ImagerySection::getImageryComponentIterator | ( | ) | const |
Return a ImagerySection::ImageryComponentIterator object to iterate over the ImageryComponent elements currently added to the ImagerySection.
ImageryComponentPointerList CEGUI::ImagerySection::getImageryComponentPointers | ( | ) |
Returns a vector of pointers to the ImageryComponents that are currently added to this ImagerySection. If an ImageryComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers.
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.
TextComponentIterator CEGUI::ImagerySection::getTextComponentIterator | ( | ) | const |
Return a ImagerySection::TextComponentIterator object to iterate over the TextComponent elements currently added to the ImagerySection.
TextComponentPointerList CEGUI::ImagerySection::getTextComponentPointers | ( | ) |
Returns a vector of pointers to the TextComponents that are currently added to this ImagerySection. If a TextComponent is added or removed from this ImagerySection, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers.
|
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::removeFrameComponent | ( | const FrameComponent & | frameComponent | ) |
Removes an FrameComponent from this ImagerySection. The supplied FrameComponent reference should be retrieved via the getFrameComponentPointers function. The check to find out which FrameComponent to remove is done using memory address comparison (identity check).
frameComponent | A reference to the FrameComponent to be removed to the section |
void CEGUI::ImagerySection::removeImageryComponent | ( | const ImageryComponent & | imageryComponent | ) |
Removes an ImageryComponent from this ImagerySection. The supplied ImagerySection reference should be retrieved via the getImageryComponentPointers function. The check to find out which ImagerySection to remove is done using memory address comparison (identity check).
imageryComponent | A reference to the ImageryComponent to be removed to the section |
void CEGUI::ImagerySection::removeTextComponent | ( | const TextComponent & | textComponent | ) |
Removes an TextComponent from this ImagerySection. The supplied TextComponent reference should be retrieved via the getTextComponentPointers function. The check to find out which TextComponent to remove is done using memory address comparison (identity check).
textComponent | A reference to the TextComponent to be removed to the section |
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. |