Crazy Eddies GUI System  0.7.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CEGUI::FalagardComponentBase Class Referenceabstract

Common base class used for renderable components within an ImagerySection. More...

+ Inheritance diagram for CEGUI::FalagardComponentBase:
+ Collaboration diagram for CEGUI::FalagardComponentBase:

Public Member Functions

 FalagardComponentBase ()
 Constructor.
 
virtual ~FalagardComponentBase ()
 Destructor.
 
void render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const
 Render this component. More correctly, the component is cached for rendering. More...
 
void render (Window &srcWindow, const Rect &baseRect, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const
 Render this component. More correctly, the component is cached for rendering. More...
 
const ComponentAreagetComponentArea () const
 Return the ComponentArea of this ImageryComponent. More...
 
void setComponentArea (const ComponentArea &area)
 Set the ImageryComponent's ComponentArea. More...
 
const ColourRectgetColours () const
 Return the ColourRect set for use by this ImageryComponent. More...
 
void setColours (const ColourRect &cols)
 Set the colours to be used by this ImageryComponent. More...
 
void setColoursPropertySource (const String &property)
 Set the name of the property where colour values can be obtained. More...
 
void setColoursPropertyIsColourRect (bool setting=true)
 Set whether the colours property source represents a full ColourRect. More...
 
void setVertFormattingPropertySource (const String &property)
 Set the name of the property where vertical formatting option can be obtained. More...
 
void setHorzFormattingPropertySource (const String &property)
 Set the name of the property where horizontal formatting option can be obtained. More...
 

Protected Member Functions

void initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const
 Helper method to initialise a ColourRect with appropriate values according to the way the ImageryComponent is set up. More...
 
virtual void render_impl (Window &srcWindow, Rect &destRect, const CEGUI::ColourRect *modColours, const Rect *clipper, bool clipToDisplay) const =0
 Method to do main render caching work.
 
bool writeColoursXML (XMLSerializer &xml_stream) const
 Writes xml for the colours to a OutStream. Will prefer property colours before explicit. More...
 
bool writeVertFormatXML (XMLSerializer &xml_stream) const
 Writes xml for the vertical formatting to a OutStream if such a property is defined. More...
 
bool writeHorzFormatXML (XMLSerializer &xml_stream) const
 Writes xml for the horizontal formatting to a OutStream if such a property is defined. More...
 

Protected Attributes

ComponentArea d_area
 Destination area for this component.
 
ColourRect d_colours
 base colours to be applied when rendering the image component.
 
String d_colourPropertyName
 name of property to fetch colours from.
 
bool d_colourProperyIsRect
 true if the colour property will fetch a full ColourRect.
 
String d_vertFormatPropertyName
 name of property to fetch vertical formatting setting from.
 
String d_horzFormatPropertyName
 name of property to fetch horizontal formatting setting from.
 

Detailed Description

Common base class used for renderable components within an ImagerySection.

Member Function Documentation

const ColourRect& CEGUI::FalagardComponentBase::getColours ( ) const

Return the ColourRect set for use by this ImageryComponent.

Returns
ColourRect object holding the colours currently in use by this ImageryComponent.
const ComponentArea& CEGUI::FalagardComponentBase::getComponentArea ( ) const

Return the ComponentArea of this ImageryComponent.

Returns
ComponentArea object describing the ImageryComponent's current target area.
void CEGUI::FalagardComponentBase::initColoursRect ( const Window wnd,
const ColourRect modCols,
ColourRect cr 
) const
protected

Helper method to initialise a ColourRect with appropriate values according to the way the ImageryComponent is set up.

This will try and get values from multiple places:

  • a property attached to wnd
  • or the integral d_colours value.
void CEGUI::FalagardComponentBase::render ( Window srcWindow,
const CEGUI::ColourRect modColours = 0,
const Rect clipper = 0,
bool  clipToDisplay = false 
) const

Render this component. More correctly, the component is cached for rendering.

Parameters
srcWindowWindow to use as the base for translating the component's ComponentArea into pixel values.
modColoursColourRect describing colours that are to be modulated with the component's stored colour values to calculate a set of 'final' colour values to be used. May be 0.
Returns
Nothing.
void CEGUI::FalagardComponentBase::render ( Window srcWindow,
const Rect baseRect,
const CEGUI::ColourRect modColours = 0,
const Rect clipper = 0,
bool  clipToDisplay = false 
) const

Render this component. More correctly, the component is cached for rendering.

Parameters
srcWindowWindow to use as the base for translating the component's ComponentArea into pixel values.
baseRectRect to use as the base for translating the component's ComponentArea into pixel values.
modColoursColourRect describing colours that are to be modulated with the component's stored colour values to calculate a set of 'final' colour values to be used. May be 0.
Returns
Nothing.
void CEGUI::FalagardComponentBase::setColours ( const ColourRect cols)

Set the colours to be used by this ImageryComponent.

Parameters
colsColourRect object describing the colours to be used by this ImageryComponent.
void CEGUI::FalagardComponentBase::setColoursPropertyIsColourRect ( bool  setting = true)

Set whether the colours property source represents a full ColourRect.

Parameters
setting
  • true if the colours property will access a ColourRect object.
  • false if the colours property will access a colour object.
Returns
Nothing.
void CEGUI::FalagardComponentBase::setColoursPropertySource ( const String property)

Set the name of the property where colour values can be obtained.

Parameters
propertyString containing the name of the property.
Returns
Nothing.
void CEGUI::FalagardComponentBase::setComponentArea ( const ComponentArea area)

Set the ImageryComponent's ComponentArea.

Parameters
areaComponentArea object describing a new target area for the ImageryComponent.
Returns
Nothing.
void CEGUI::FalagardComponentBase::setHorzFormattingPropertySource ( const String property)

Set the name of the property where horizontal formatting option can be obtained.

Parameters
propertyString containing the name of the property.
Returns
Nothing.
void CEGUI::FalagardComponentBase::setVertFormattingPropertySource ( const String property)

Set the name of the property where vertical formatting option can be obtained.

Parameters
propertyString containing the name of the property.
Returns
Nothing.
bool CEGUI::FalagardComponentBase::writeColoursXML ( XMLSerializer xml_stream) const
protected

Writes xml for the colours to a OutStream. Will prefer property colours before explicit.

Note
This is intended as a helper method for sub-classes when outputting xml to a stream.
Returns
  • true if xml element was written.
  • false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.)
bool CEGUI::FalagardComponentBase::writeHorzFormatXML ( XMLSerializer xml_stream) const
protected

Writes xml for the horizontal formatting to a OutStream if such a property is defined.

Note
This is intended as a helper method for sub-classes when outputting xml to a stream.
Returns
  • true if xml element was written.
  • false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.)
bool CEGUI::FalagardComponentBase::writeVertFormatXML ( XMLSerializer xml_stream) const
protected

Writes xml for the vertical formatting to a OutStream if such a property is defined.

Note
This is intended as a helper method for sub-classes when outputting xml to a stream.
Returns
  • true if xml element was written.
  • false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.)