Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::LayerSpecification Class Reference

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

#include <CEGUIFalLayerSpecification.h>

List of all members.

Public Member Functions

 LayerSpecification (uint priority)
 Constructor.
void render (Window &srcWindow, float base_z, const ColourRect *modcols=0, const Rect *clipper=0, bool clipToDisplay=false) const
 Render this layer.
void render (Window &srcWindow, const Rect &baseRect, float base_z, const ColourRect *modcols=0, const Rect *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.
bool operator< (const LayerSpecification &other) const
void writeXMLToStream (OutStream &out_stream) const
 Writes an xml representation of this Layer to out_stream.


Detailed Description

Class that encapsulates a single layer of imagery.

Definition at line 42 of file CEGUIFalLayerSpecification.h.


Constructor & Destructor Documentation

CEGUI::LayerSpecification::LayerSpecification uint  priority  ) 
 

Constructor.

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

Definition at line 30 of file CEGUIFalLayerSpecification.cpp.


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:
section SectionSpecification object descibing the section that should be added to this layer.
Returns:
Nothing,

Definition at line 52 of file CEGUIFalLayerSpecification.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementEnd().

void CEGUI::LayerSpecification::clearSectionSpecifications  ) 
 

Clear all section specifications from this layer,.

Returns:
Nothing.

Definition at line 57 of file CEGUIFalLayerSpecification.cpp.

uint CEGUI::LayerSpecification::getLayerPriority  )  const
 

Return the priority of this layer.

Returns:
uint value descibing the priority of this LayerSpecification.

Definition at line 62 of file CEGUIFalLayerSpecification.cpp.

bool CEGUI::LayerSpecification::operator< const LayerSpecification other  )  const
 

Definition at line 67 of file CEGUIFalLayerSpecification.cpp.

References d_layerPriority.

void CEGUI::LayerSpecification::render Window srcWindow,
const Rect baseRect,
float  base_z,
const ColourRect modcols = 0,
const Rect clipper = 0,
bool  clipToDisplay = false
const
 

Render this layer.

Parameters:
srcWindow Window to use when calculating pixel values from BaseDim values.
baseRect Rect to use when calculating pixel values from BaseDim values.
base_z base level z value to use for all imagery in the layer.
Returns:
Nothing.

Definition at line 43 of file CEGUIFalLayerSpecification.cpp.

void CEGUI::LayerSpecification::render Window srcWindow,
float  base_z,
const ColourRect modcols = 0,
const Rect clipper = 0,
bool  clipToDisplay = false
const
 

Render this layer.

Parameters:
srcWindow Window to use when calculating pixel values from BaseDim values.
base_z base level z value to use for all imagery in the layer.
Returns:
Nothing.

Definition at line 34 of file CEGUIFalLayerSpecification.cpp.

void CEGUI::LayerSpecification::writeXMLToStream OutStream out_stream  )  const
 

Writes an xml representation of this Layer to out_stream.

Parameters:
out_stream Stream where xml data should be output.
Returns:
Nothing.

Definition at line 72 of file CEGUIFalLayerSpecification.cpp.


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:10:07 2005 for Crazy Eddies GUI System by  doxygen 1.4.3