Common base class used for renderable components within an ImagerySection.
More...
List of all members.
Detailed Description
Common base class used for renderable components within an ImagerySection.
Member Function Documentation
const ColourRect& CEGUI::FalagardComponentBase::getColours |
( |
| ) |
const |
const ComponentArea& CEGUI::FalagardComponentBase::getComponentArea |
( |
| ) |
const |
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:
-
srcWindow | Window to use as the base for translating the component's ComponentArea into pixel values. |
modColours | ColourRect 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:
-
srcWindow | Window to use as the base for translating the component's ComponentArea into pixel values. |
baseRect | Rect to use as the base for translating the component's ComponentArea into pixel values. |
modColours | ColourRect 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 | ) |
|
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:
-
property | String containing the name of the property. |
- Returns:
- Nothing.
void CEGUI::FalagardComponentBase::setComponentArea |
( |
const ComponentArea & |
area | ) |
|
void CEGUI::FalagardComponentBase::setHorzFormattingPropertySource |
( |
const String & |
property | ) |
|
Set the name of the property where horizontal formatting option can be obtained.
- Parameters:
-
property | String 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:
-
property | String 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.)