#include <CEGUIFalSectionSpecification.h>
Collaboration diagram for CEGUI::SectionSpecification:
Public Member Functions | |
SectionSpecification (const String &owner, const String §ionName) | |
Constructor. | |
SectionSpecification (const String &owner, const String §ionName, const ColourRect &cols) | |
Constructor. | |
void | render (Window &srcWindow, float base_z, const ColourRect *modcols=0, const Rect *clipper=0, bool clipToDisplay=false) const |
Render the section specified by this SectionSpecification. | |
void | render (Window &srcWindow, const Rect &baseRect, float base_z, const ColourRect *modcols=0, const Rect *clipper=0, bool clipToDisplay=false) const |
Render the section specified by this SectionSpecification. | |
const String & | getOwnerWidgetLookFeel () const |
Return the name of the WidgetLookFeel object containing the target section. | |
const String & | getSectionName () const |
Return the name of the target ImagerySection. | |
const ColourRect & | getOverrideColours () const |
Return the current override colours. | |
void | setOverrideColours (const ColourRect &cols) |
Set the override colours to be used by this SectionSpecification. | |
bool | isUsingOverrideColours () const |
return whether the use of override colours is enabled on this SectionSpecification. | |
void | setUsingOverrideColours (bool setting=true) |
Enable or disable the use of override colours for this section. | |
void | setOverrideColoursPropertySource (const String &property) |
Set the name of the property where override colour values can be obtained. | |
void | setOverrideColoursPropertyIsColourRect (bool setting=true) |
Set whether the override colours property source represents a full ColourRect. | |
void | writeXMLToStream (OutStream &out_stream) const |
Writes an xml representation of this SectionSpecification to out_stream. | |
Protected Member Functions | |
void | initColourRectForOverride (const Window &wnd, ColourRect &cr) const |
Helper method to initialise a ColourRect with appropriate values according to the way the section sepcification is set up. |
This class enables sections to be easily re-used, by different states and/or layers, by allowing sections to be specified by name rather than having mutiple copies of the same thing all over the place.
Definition at line 43 of file CEGUIFalSectionSpecification.h.
|
Constructor.
Definition at line 35 of file CEGUIFalSectionSpecification.cpp. |
|
Constructor.
Definition at line 42 of file CEGUIFalSectionSpecification.cpp. |
|
Return the current override colours.
Definition at line 108 of file CEGUIFalSectionSpecification.cpp. |
|
Return the name of the WidgetLookFeel object containing the target section.
Definition at line 98 of file CEGUIFalSectionSpecification.cpp. |
|
Return the name of the target ImagerySection.
Definition at line 103 of file CEGUIFalSectionSpecification.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Helper method to initialise a ColourRect with appropriate values according to the way the section sepcification is set up. This will try and get values from multiple places:
Definition at line 133 of file CEGUIFalSectionSpecification.cpp. References CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::ColourRect::d_top_left, CEGUI::ColourRect::d_top_right, CEGUI::String::empty(), CEGUI::PropertySet::getProperty(), CEGUI::PropertyHelper::stringToColour(), and CEGUI::PropertyHelper::stringToColourRect(). Referenced by render(). |
|
return whether the use of override colours is enabled on this SectionSpecification.
Definition at line 118 of file CEGUIFalSectionSpecification.cpp. |
|
Render the section specified by this SectionSpecification.
Definition at line 74 of file CEGUIFalSectionSpecification.cpp. References CEGUI::Window::getEffectiveAlpha(), CEGUI::WidgetLookFeel::getImagerySection(), CEGUI::WidgetLookManager::getSingleton(), CEGUI::WidgetLookManager::getWidgetLook(), initColourRectForOverride(), CEGUI::ColourRect::modulateAlpha(), and CEGUI::ImagerySection::render(). |
|
Render the section specified by this SectionSpecification.
Definition at line 50 of file CEGUIFalSectionSpecification.cpp. References CEGUI::Window::getEffectiveAlpha(), CEGUI::WidgetLookFeel::getImagerySection(), CEGUI::WidgetLookManager::getSingleton(), CEGUI::WidgetLookManager::getWidgetLook(), initColourRectForOverride(), CEGUI::ColourRect::modulateAlpha(), and CEGUI::ImagerySection::render(). |
|
Set the override colours to be used by this SectionSpecification.
Definition at line 113 of file CEGUIFalSectionSpecification.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set whether the override colours property source represents a full ColourRect.
Definition at line 169 of file CEGUIFalSectionSpecification.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the name of the property where override colour values can be obtained.
Definition at line 128 of file CEGUIFalSectionSpecification.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Enable or disable the use of override colours for this section.
Definition at line 123 of file CEGUIFalSectionSpecification.cpp. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Writes an xml representation of this SectionSpecification to out_stream.
Definition at line 174 of file CEGUIFalSectionSpecification.cpp. References CEGUI::PropertyHelper::colourToString(), CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::ColourRect::d_top_left, CEGUI::ColourRect::d_top_right, CEGUI::String::empty(), and CEGUI::ColourRect::isMonochromatic(). |