Crazy Eddies GUI System  0.7.2
Public Member Functions | Protected Member Functions | List of all members
CEGUI::ImagerySection Class Reference

Class that encapsulates a re-usable collection of imagery specifications. More...

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 Rect *clipper=0, bool clipToDisplay=false) const
 Render the ImagerySection. More...
 
void render (Window &srcWindow, const Rect &baseRect, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const
 Render the ImagerySection. More...
 
void addImageryComponent (const ImageryComponent &img)
 Add an ImageryComponent to this ImagerySection. More...
 
void clearImageryComponents ()
 Clear all ImageryComponents from this ImagerySection. More...
 
void addTextComponent (const TextComponent &text)
 Add a TextComponent to this ImagerySection. More...
 
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...
 
const ColourRectgetMasterColours () 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 StringgetName () const
 Return the name of this ImagerySection. More...
 
void setMasterColoursPropertySource (const String &property)
 Set the name of the property where master colour values can be obtained. More...
 
void setMasterColoursPropertyIsColourRect (bool setting=true)
 Set whether the master colours property source represents a full ColourRect. More...
 
Rect getBoundingRect (const Window &wnd) const
 Return smallest Rect that could contain all imagery within this section.
 
Rect getBoundingRect (const Window &wnd, const Rect &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...
 

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...
 

Detailed Description

Class that encapsulates a re-usable collection of imagery specifications.

Constructor & Destructor Documentation

CEGUI::ImagerySection::ImagerySection ( const String name)

ImagerySection constructor. Name must be supplied, masterColours are set to 0xFFFFFFFF by default.

Parameters
nameName of the new ImagerySection.

Member Function Documentation

void CEGUI::ImagerySection::addFrameComponent ( const FrameComponent frame)

Add a FrameComponent to this ImagerySection.

Parameters
frameFrameComponent to be added to the section (a copy is made)
Returns
Nothing
void CEGUI::ImagerySection::addImageryComponent ( const ImageryComponent img)

Add an ImageryComponent to this ImagerySection.

Parameters
imgImageryComponent to be added to the section (a copy is made)
Returns
Nothing
void CEGUI::ImagerySection::addTextComponent ( const TextComponent text)

Add a TextComponent to this ImagerySection.

Parameters
textTextComponent to be added to the section (a copy is made)
Returns
Nothing
void CEGUI::ImagerySection::clearFrameComponents ( )

Clear all FrameComponents from this ImagerySection.

Returns
Nothing
void CEGUI::ImagerySection::clearImageryComponents ( )

Clear all ImageryComponents from this ImagerySection.

Returns
Nothing
void CEGUI::ImagerySection::clearTextComponents ( )

Clear all TextComponents from this ImagerySection.

Returns
Nothing
const ColourRect& CEGUI::ImagerySection::getMasterColours ( ) const

Return the current master colours set for this ImagerySection.

Returns
ColourRect describing the master colour values in use for this ImagerySection.
const String& CEGUI::ImagerySection::getName ( ) const

Return the name of this ImagerySection.

Returns
String object holding the name of the ImagerySection.
void CEGUI::ImagerySection::initMasterColourRect ( const Window wnd,
ColourRect cr 
) const
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:

  • a property attached to wnd
  • or the integral d_masterColours value.
void CEGUI::ImagerySection::render ( Window srcWindow,
const CEGUI::ColourRect modColours = 0,
const Rect clipper = 0,
bool  clipToDisplay = false 
) const

Render the ImagerySection.

Parameters
srcWindowWindow object to be used when calculating pixel values from BaseDim values.
modColoursColourRect specifying colours to be modulated with the ImagerySection's master colours. May be 0.
Returns
Nothing.
void CEGUI::ImagerySection::render ( Window srcWindow,
const Rect baseRect,
const CEGUI::ColourRect modColours = 0,
const Rect clipper = 0,
bool  clipToDisplay = false 
) const

Render the ImagerySection.

Parameters
srcWindowWindow object to be used when calculating pixel values from BaseDim values.
baseRectRect object to be used when calculating pixel values from BaseDim values.
modColoursColourRect specifying colours to be modulated with the ImagerySection's master colours. May be 0.
Returns
Nothing.
void CEGUI::ImagerySection::setMasterColours ( const ColourRect cols)

Set the master colours to be used for this ImagerySection.

Parameters
colsColourRect describing the colours to be set as the master colours for this ImagerySection.
Returns
Nothing.
void CEGUI::ImagerySection::setMasterColoursPropertyIsColourRect ( bool  setting = true)

Set whether the master colours property source represents a full ColourRect.

Parameters
setting
  • true if the master colours property will access a ColourRect object.
  • false if the master colours property will access a colour object.
Returns
Nothing.
void CEGUI::ImagerySection::setMasterColoursPropertySource ( const String property)

Set the name of the property where master colour values can be obtained.

Parameters
propertyString containing the name of the property.
Returns
Nothing.
void CEGUI::ImagerySection::writeXMLToStream ( XMLSerializer xml_stream) const

Writes an xml representation of this ImagerySection to out_stream.

Parameters
xml_streamStream where xml data should be output.
Returns
Nothing.