#include <CEGUIFalFrameComponent.h>
Inheritance diagram for CEGUI::FrameComponent:
Public Member Functions | |
FrameComponent () | |
Constructor. | |
VerticalFormatting | getBackgroundVerticalFormatting () const |
Return the current vertical formatting setting for this FrameComponent. | |
void | setBackgroundVerticalFormatting (VerticalFormatting fmt) |
Set the vertical formatting setting for this FrameComponent. | |
HorizontalFormatting | getBackgroundHorizontalFormatting () const |
Return the current horizontal formatting setting for this FrameComponent. | |
void | setBackgroundHorizontalFormatting (HorizontalFormatting fmt) |
Set the horizontal formatting setting for this FrameComponent. | |
const Image * | getImage (FrameImageComponent part) const |
Return the Image object that will be drawn by this FrameComponent for a specified frame part. | |
void | setImage (FrameImageComponent part, const Image *image) |
Set the Image that will be drawn by this ImageryComponent. | |
void | setImage (FrameImageComponent part, const String &imageset, const String &image) |
Set the Image that will be drawn by this FrameComponent. | |
void | writeXMLToStream (OutStream &out_stream) const |
Writes an xml representation of this FrameComponent to out_stream. | |
void | render (Window &srcWindow, float base_z, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
void | render (Window &srcWindow, const Rect &baseRect, float base_z, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const |
Render this component. More correctly, the component is cached for rendering. | |
const ComponentArea & | getComponentArea () const |
Return the ComponentArea of this ImageryComponent. | |
void | setComponentArea (const ComponentArea &area) |
Set the ImageryComponent's ComponentArea. | |
const ColourRect & | getColours () const |
Return the ColourRect set for use by this ImageryComponent. | |
void | setColours (const ColourRect &cols) |
Set the colours to be used by this ImageryComponent. | |
void | setColoursPropertySource (const String &property) |
Set the name of the property where colour values can be obtained. | |
void | setColoursPropertyIsColourRect (bool setting=true) |
Set whether the colours property source represents a full ColourRect. | |
void | setVertFormattingPropertySource (const String &property) |
Set the name of the property where vertical formatting option can be obtained. | |
void | setHorzFormattingPropertySource (const String &property) |
Set the name of the property where horizontal formatting option can be obtained. | |
Protected Member Functions | |
void | render_impl (Window &srcWindow, Rect &destRect, float base_z, const CEGUI::ColourRect *modColours, const Rect *clipper, bool clipToDisplay) const |
Method to do main render caching work. | |
void | doBackgroundRender (Window &srcWindow, Rect &destRect, float base_z, const ColourRect &colours, const Rect *clipper, bool clipToDisplay) const |
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. | |
bool | writeColoursXML (OutStream &out_stream) const |
Writes xml for the colours to a OutStream. Will prefer property colours before explicit. | |
bool | writeVertFormatXML (OutStream &out_stream) const |
Writes xml for the vertical formatting to a OutStream if such a property is defined. | |
bool | writeHorzFormatXML (OutStream &out_stream) const |
Writes xml for the horizontal formatting to a OutStream if such a property is defined. | |
Protected Attributes | |
VerticalFormatting | d_vertFormatting |
Vertical formatting to be applied when rendering the background for the component. | |
HorizontalFormatting | d_horzFormatting |
Horizontal formatting to be applied when rendering the background for the component. | |
const Image * | d_frameImages [FIC_FRAME_IMAGE_COUNT] |
Array that holds the assigned images. | |
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. |
Corner images are always drawn at their natural size, edges are stretched between the corner pieces for a particular edge, the background image will cover the inner rectangle formed by the edge images and can be stretched or tiled in either dimension.
Definition at line 40 of file CEGUIFalFrameComponent.h.
|
Constructor.
Definition at line 35 of file CEGUIFalFrameComponent.cpp. References d_frameImages, and CEGUI::FIC_FRAME_IMAGE_COUNT. |
|
|
Return the current horizontal formatting setting for this FrameComponent.
Definition at line 53 of file CEGUIFalFrameComponent.cpp. References d_horzFormatting. |
|
Return the current vertical formatting setting for this FrameComponent.
Definition at line 43 of file CEGUIFalFrameComponent.cpp. References d_vertFormatting. |
|
Return the ColourRect set for use by this ImageryComponent.
Definition at line 62 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colours. |
|
Return the ComponentArea of this ImageryComponent.
Definition at line 52 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area. |
|
Return the Image object that will be drawn by this FrameComponent for a specified frame part.
Definition at line 63 of file CEGUIFalFrameComponent.cpp. References d_frameImages, and CEGUI::FIC_FRAME_IMAGE_COUNT. |
|
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:
Definition at line 82 of file CEGUIFalComponentBase.cpp. References CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::FalagardComponentBase::d_colourPropertyName, CEGUI::FalagardComponentBase::d_colourProperyIsRect, CEGUI::FalagardComponentBase::d_colours, 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 CEGUI::TextComponent::render_impl(), CEGUI::ImageryComponent::render_impl(), and render_impl(). |
|
Render this component. More correctly, the component is cached for rendering.
Definition at line 46 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area, CEGUI::ComponentArea::getPixelRect(), and CEGUI::FalagardComponentBase::render_impl(). |
|
Render this component. More correctly, the component is cached for rendering.
Definition at line 40 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area, CEGUI::ComponentArea::getPixelRect(), and CEGUI::FalagardComponentBase::render_impl(). |
|
|
Set the horizontal formatting setting for this FrameComponent.
Definition at line 58 of file CEGUIFalFrameComponent.cpp. References d_horzFormatting. |
|
Set the vertical formatting setting for this FrameComponent.
Definition at line 48 of file CEGUIFalFrameComponent.cpp. References d_vertFormatting. |
|
Set the colours to be used by this ImageryComponent.
Definition at line 67 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colours. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set whether the colours property source represents a full ColourRect.
Definition at line 77 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colourProperyIsRect. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the name of the property where colour values can be obtained.
Definition at line 72 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_colourPropertyName. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the ImageryComponent's ComponentArea.
Definition at line 57 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_area. Referenced by CEGUI::Falagard_xmlHandler::elementEnd(). |
|
Set the name of the property where horizontal formatting option can be obtained.
Definition at line 120 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_horzFormatPropertyName. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the Image that will be drawn by this FrameComponent.
Definition at line 77 of file CEGUIFalFrameComponent.cpp. References d_frameImages, CEGUI::FIC_FRAME_IMAGE_COUNT, CEGUI::Imageset::getImage(), CEGUI::ImagesetManager::getImageset(), and CEGUI::ImagesetManager::getSingleton(). |
|
Set the Image that will be drawn by this ImageryComponent.
Definition at line 70 of file CEGUIFalFrameComponent.cpp. References d_frameImages, and CEGUI::FIC_FRAME_IMAGE_COUNT. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Set the name of the property where vertical formatting option can be obtained.
Definition at line 115 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_vertFormatPropertyName. Referenced by CEGUI::Falagard_xmlHandler::elementStart(). |
|
Writes xml for the colours to a OutStream. Will prefer property colours before explicit.
Definition at line 125 of file CEGUIFalComponentBase.cpp. References CEGUI::PropertyHelper::colourToString(), CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::FalagardComponentBase::d_colourPropertyName, CEGUI::FalagardComponentBase::d_colourProperyIsRect, CEGUI::FalagardComponentBase::d_colours, CEGUI::ColourRect::d_top_left, CEGUI::ColourRect::d_top_right, CEGUI::String::empty(), and CEGUI::ColourRect::isMonochromatic(). Referenced by CEGUI::TextComponent::writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and writeXMLToStream(). |
|
Writes xml for the horizontal formatting to a OutStream if such a property is defined.
Definition at line 163 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_horzFormatPropertyName, and CEGUI::String::empty(). Referenced by CEGUI::TextComponent::writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and writeXMLToStream(). |
|
Writes xml for the vertical formatting to a OutStream if such a property is defined.
Definition at line 152 of file CEGUIFalComponentBase.cpp. References CEGUI::FalagardComponentBase::d_vertFormatPropertyName, and CEGUI::String::empty(). Referenced by CEGUI::TextComponent::writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and writeXMLToStream(). |
|
Writes an xml representation of this FrameComponent to out_stream.
Definition at line 484 of file CEGUIFalFrameComponent.cpp. References CEGUI::FalagardComponentBase::d_area, d_frameImages, d_horzFormatting, d_vertFormatting, CEGUI::FIC_FRAME_IMAGE_COUNT, CEGUI::FalagardXMLHelper::frameImageComponentToString(), CEGUI::Image::getImagesetName(), CEGUI::Image::getName(), CEGUI::FalagardXMLHelper::horzFormatToString(), CEGUI::FalagardXMLHelper::vertFormatToString(), CEGUI::FalagardComponentBase::writeColoursXML(), CEGUI::FalagardComponentBase::writeHorzFormatXML(), CEGUI::FalagardComponentBase::writeVertFormatXML(), and CEGUI::ComponentArea::writeXMLToStream(). |
|
Destination area for this component.
Definition at line 242 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::getComponentArea(), CEGUI::FalagardComponentBase::render(), CEGUI::FalagardComponentBase::setComponentArea(), CEGUI::TextComponent::writeXMLToStream(), CEGUI::ImageryComponent::writeXMLToStream(), and writeXMLToStream(). |
|
name of property to fetch colours from.
Definition at line 244 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardComponentBase::setColoursPropertySource(), and CEGUI::FalagardComponentBase::writeColoursXML(). |
|
true if the colour property will fetch a full ColourRect.
Definition at line 245 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardComponentBase::setColoursPropertyIsColourRect(), and CEGUI::FalagardComponentBase::writeColoursXML(). |
|
base colours to be applied when rendering the image component.
Definition at line 243 of file CEGUIFalComponentBase.h. Referenced by CEGUI::FalagardComponentBase::getColours(), CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::FalagardComponentBase::setColours(), and CEGUI::FalagardComponentBase::writeColoursXML(). |
|
Array that holds the assigned images.
Definition at line 159 of file CEGUIFalFrameComponent.h. Referenced by doBackgroundRender(), FrameComponent(), getImage(), render_impl(), setImage(), and writeXMLToStream(). |
|
name of property to fetch horizontal formatting setting from.
Definition at line 247 of file CEGUIFalComponentBase.h. Referenced by doBackgroundRender(), CEGUI::TextComponent::render_impl(), CEGUI::ImageryComponent::render_impl(), CEGUI::FalagardComponentBase::setHorzFormattingPropertySource(), and CEGUI::FalagardComponentBase::writeHorzFormatXML(). |
|
Horizontal formatting to be applied when rendering the background for the component.
Definition at line 157 of file CEGUIFalFrameComponent.h. Referenced by doBackgroundRender(), getBackgroundHorizontalFormatting(), setBackgroundHorizontalFormatting(), and writeXMLToStream(). |
|
name of property to fetch vertical formatting setting from.
Definition at line 246 of file CEGUIFalComponentBase.h. Referenced by doBackgroundRender(), CEGUI::TextComponent::render_impl(), CEGUI::ImageryComponent::render_impl(), CEGUI::FalagardComponentBase::setVertFormattingPropertySource(), and CEGUI::FalagardComponentBase::writeVertFormatXML(). |
|
Vertical formatting to be applied when rendering the background for the component.
Definition at line 156 of file CEGUIFalFrameComponent.h. Referenced by doBackgroundRender(), getBackgroundVerticalFormatting(), setBackgroundVerticalFormatting(), and writeXMLToStream(). |