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

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

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

Public Types

typedef std::vector< SectionSpecification *CEGUI_VECTOR_ALLOC(SectionSpecification *)> SectionSpecificationPointerList
 The container type for SectionSpecifications.
 
typedef ConstVectorIterator< SectionList > SectionIterator
 

Public Member Functions

 LayerSpecification (uint priority=0)
 Constructor. More...
 
void render (Window &srcWindow, const ColourRect *modcols=0, const Rectf *clipper=0, bool clipToDisplay=false) const
 Render this layer. More...
 
void render (Window &srcWindow, const Rectf &baseRect, const ColourRect *modcols=0, const Rectf *clipper=0, bool clipToDisplay=false) const
 Render this layer. More...
 
void addSectionSpecification (const SectionSpecification &section)
 Add a section specification to the layer. More...
 
void clearSectionSpecifications ()
 Clear all section specifications from this layer,. More...
 
uint getLayerPriority () const
 Return the priority of this layer. More...
 
void setLayerPriority (uint priority)
 Sets the priority of this layer. More...
 
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this Layer to out_stream. More...
 
SectionSpecificationPointerList getSectionSpecificationPointers ()
 Returns a vector of pointers to the SectionSpecifications that are currently added to this LayerSpecification. If a SectionSpecification is added or removed from this LayerSpecification, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers. More...
 
bool operator< (const LayerSpecification &otherLayerSpec) const
 The comparison operator, which is used for sorting.
 
SectionIterator getSectionIterator () const
 

Detailed Description

Class that encapsulates a single layer of imagery.

Member Typedef Documentation

Deprecated:
This type will be removed in the next version and replaced by a const list in the getSectionSpecifications function.

Constructor & Destructor Documentation

CEGUI::LayerSpecification::LayerSpecification ( uint  priority = 0)

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

void CEGUI::LayerSpecification::addSectionSpecification ( const SectionSpecification section)

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,
void CEGUI::LayerSpecification::clearSectionSpecifications ( )

Clear all section specifications from this layer,.

Returns
Nothing.
uint CEGUI::LayerSpecification::getLayerPriority ( ) const

Return the priority of this layer.

Returns
uint value descibing the priority of this LayerSpecification.
SectionIterator CEGUI::LayerSpecification::getSectionIterator ( ) const
Deprecated:
This function will be replaced by the getSectionSpecifications function in the next version. For editing getSectionSpecificationPointers can be used.
SectionSpecificationPointerList CEGUI::LayerSpecification::getSectionSpecificationPointers ( )

Returns a vector of pointers to the SectionSpecifications that are currently added to this LayerSpecification. If a SectionSpecification is added or removed from this LayerSpecification, then the pointers in this vector are not valid anymore. The function should then be called again to retrieve valid pointers.

Returns
A vector of pointers to the SectionSpecifications that are currently added to 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.
void CEGUI::LayerSpecification::setLayerPriority ( uint  priority)

Sets the priority of this layer.

Returns
uint value descibing the priority of this LayerSpecification.
void CEGUI::LayerSpecification::writeXMLToStream ( XMLSerializer xml_stream) const

Writes an xml representation of this Layer to out_stream.

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