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

Class that encapsulates a single layer of imagery. More...

+ Inheritance diagram for CEGUI::LayerSpecification:
+ Collaboration diagram for CEGUI::LayerSpecification:

List of all members.

Public Types

typedef ConstVectorIterator
< SectionList > 
SectionIterator

Public Member Functions

 LayerSpecification (uint priority=0)
 Constructor.
void render (Window &srcWindow, const ColourRect *modcols=0, const Rectf *clipper=0, bool clipToDisplay=false) const
 Render this layer.
void render (Window &srcWindow, const Rectf &baseRect, const ColourRect *modcols=0, const Rectf *clipper=0, bool clipToDisplay=false) const
 Render this layer.
void addSectionSpecification (const SectionSpecification &section)
 Add a section specification to the layer.
void clearSectionSpecifications ()
 Clear all section specifications from this layer,.
uint getLayerPriority () const
 Return the priority of this layer.
void setLayerPriority (uint priority)
 Sets the priority of this layer.
bool operator< (const LayerSpecification &other) const
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this Layer to out_stream.
SectionIterator getSectionIterator () const

Detailed Description

Class that encapsulates a single layer of imagery.


Constructor & Destructor Documentation

Constructor.

Parameters:
prioritySpecifies the priority of the layer. Layers with higher priorities will be drawn on top of layers with lower priorities.

Member Function Documentation

Add a section specification to the layer.

A section specification is a reference to a named ImagerySection within the WidgetLook.

Parameters:
sectionSectionSpecification object descibing the section that should be added to this layer.
Returns:
Nothing,

Clear all section specifications from this layer,.

Returns:
Nothing.

Return the priority of this layer.

Returns:
uint value descibing the priority of this LayerSpecification.
void CEGUI::LayerSpecification::render ( Window srcWindow,
const ColourRect modcols = 0,
const Rectf clipper = 0,
bool  clipToDisplay = false 
) const

Render this layer.

Parameters:
srcWindowWindow to use when calculating pixel values from BaseDim values.
Returns:
Nothing.
void CEGUI::LayerSpecification::render ( Window srcWindow,
const Rectf baseRect,
const ColourRect modcols = 0,
const Rectf clipper = 0,
bool  clipToDisplay = false 
) const

Render this layer.

Parameters:
srcWindowWindow to use when calculating pixel values from BaseDim values.
baseRectRect to use when calculating pixel values from BaseDim values.
Returns:
Nothing.

Sets the priority of this layer.

Returns:
uint value descibing the priority of this LayerSpecification.

Writes an xml representation of this Layer to out_stream.

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