Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::StateImagery Class Reference

Class the encapsulates imagery for a given widget state. More...

+ Inheritance diagram for CEGUI::StateImagery:
+ Collaboration diagram for CEGUI::StateImagery:

Public Types

typedef ConstVectorIterator
< LayersList > 
LayerIterator
 

Public Member Functions

 StateImagery ()
 Constructor.
 
 StateImagery (const String &name)
 Constructor. More...
 
void render (Window &srcWindow, const ColourRect *modcols=0, const Rectf *clipper=0) const
 Render imagery for this state. More...
 
void render (Window &srcWindow, const Rectf &baseRect, const ColourRect *modcols=0, const Rectf *clipper=0) const
 Render imagery for this state. More...
 
void addLayer (const LayerSpecification &layer)
 Add an imagery LayerSpecification to this state. More...
 
void clearLayers ()
 Removed all LayerSpecifications from this state. More...
 
const StringgetName () const
 Return the name of this state. More...
 
void setName (const String &name)
 Set the name of this state. More...
 
bool isClippedToDisplay () const
 Return whether this state imagery should be clipped to the display rather than the target window. More...
 
void setClippedToDisplay (bool setting)
 Set whether this state imagery should be clipped to the display rather than the target window. More...
 
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this StateImagery to out_stream. More...
 
LayerIterator getLayerIterator () const
 

Detailed Description

Class the encapsulates imagery for a given widget state.

Constructor & Destructor Documentation

CEGUI::StateImagery::StateImagery ( const String name)

Constructor.

Parameters
nameName of the state

Member Function Documentation

void CEGUI::StateImagery::addLayer ( const LayerSpecification layer)

Add an imagery LayerSpecification to this state.

Parameters
layerLayerSpecification to be added to this state (will be copied)
Returns
Nothing.
void CEGUI::StateImagery::clearLayers ( )

Removed all LayerSpecifications from this state.

Returns
Nothing.
const String& CEGUI::StateImagery::getName ( ) const

Return the name of this state.

Returns
String object holding the name of the StateImagery object.
bool CEGUI::StateImagery::isClippedToDisplay ( ) const

Return whether this state imagery should be clipped to the display rather than the target window.

Clipping to the display effectively implies that the imagery should be rendered unclipped.

/return

  • true if the imagery will be clipped to the display area.
  • false if the imagery will be clipped to the target window area.
void CEGUI::StateImagery::render ( Window srcWindow,
const ColourRect modcols = 0,
const Rectf clipper = 0 
) const

Render imagery for this state.

Parameters
srcWindowWindow to use when convering BaseDim values to pixels.
Returns
Nothing.
void CEGUI::StateImagery::render ( Window srcWindow,
const Rectf baseRect,
const ColourRect modcols = 0,
const Rectf clipper = 0 
) const

Render imagery for this state.

Parameters
srcWindowWindow to use when convering BaseDim values to pixels.
baseRectRect to use when convering BaseDim values to pixels.
Returns
Nothing.
void CEGUI::StateImagery::setClippedToDisplay ( bool  setting)

Set whether this state imagery should be clipped to the display rather than the target window.

Clipping to the display effectively implies that the imagery should be rendered unclipped.
Parameters
setting
  • true if the imagery should be clipped to the display area.
  • false if the imagery should be clipped to the target window area.
Returns
Nothing.
void CEGUI::StateImagery::setName ( const String name)

Set the name of this state.

Returns
String object holding the name of the StateImagery object.
void CEGUI::StateImagery::writeXMLToStream ( XMLSerializer xml_stream) const

Writes an xml representation of this StateImagery to out_stream.

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