Crazy Eddie's GUI System  0.8.4
CEGUI::StateImagery Class Reference

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

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

List of all members.

Public Types

typedef ConstVectorIterator
< LayersList > 
LayerIterator

Public Member Functions

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

Detailed Description

Class the encapsulates imagery for a given widget state.


Constructor & Destructor Documentation

Constructor.

Parameters:
nameName of the state

Member Function Documentation

Add an imagery LayerSpecification to this state.

Parameters:
layerLayerSpecification to be added to this state (will be copied)
Returns:
Nothing.

Removed all LayerSpecifications from this state.

Returns:
Nothing.

Return the name of this state.

Returns:
String object holding the name of the StateImagery object.

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.

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.

Writes an xml representation of this StateImagery to out_stream.

Parameters:
xml_streamStream where xml data should be output.
Returns:
Nothing.
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends