Class the encapsulates imagery for a given widget state.
More...
List of all members.
Detailed Description
Class the encapsulates imagery for a given widget state.
Constructor & Destructor Documentation
CEGUI::StateImagery::StateImagery |
( |
const String & |
name ) |
|
Member Function Documentation
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 Rect & |
baseRect, |
|
|
const ColourRect * |
modcols = 0 , |
|
|
const Rect * |
clipper = 0 |
|
) |
| const |
Render imagery for this state.
- Parameters:
-
srcWindow | Window to use when convering BaseDim values to pixels. |
baseRect | Rect to use when convering BaseDim values to pixels. |
- Returns:
- Nothing.
void CEGUI::StateImagery::render |
( |
Window & |
srcWindow, |
|
|
const ColourRect * |
modcols = 0 , |
|
|
const Rect * |
clipper = 0 |
|
) |
| const |
Render imagery for this state.
- Parameters:
-
- 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::writeXMLToStream |
( |
XMLSerializer & |
xml_stream ) |
const |
Writes an xml representation of this StateImagery to out_stream.
- Parameters:
-
xml_stream | Stream where xml data should be output. |
- Returns:
- Nothing.