Class that encapsulates information for a frame with background (9 images in total)
More...
Public Member Functions |
void | setLeftEdgeFormatting (VerticalFormatting fmt) |
| Set the formatting to be used for the left edge image.
|
void | setRightEdgeFormatting (VerticalFormatting fmt) |
| Set the formatting to be used for the right edge image.
|
void | setTopEdgeFormatting (HorizontalFormatting fmt) |
| Set the formatting to be used for the top edge image.
|
void | setBottomEdgeFormatting (HorizontalFormatting fmt) |
| Set the formatting to be used for the bottom edge image.
|
void | setBackgroundVerticalFormatting (VerticalFormatting fmt) |
| Set the vertical formatting to be used for the background image.
|
void | setBackgroundHorizontalFormatting (HorizontalFormatting fmt) |
| Set the horizontal formatting to be used for the background image.
|
void | setLeftEdgeFormattingPropertySource (const String &property_name) |
| Set the name of a property that will be used to obtain the formatting to use for the left edge image.
|
void | setRightEdgeFormattingPropertySource (const String &property_name) |
| Set the name of a property that will be used to obtain the formatting to use for the right edge image.
|
void | setTopEdgeFormattingPropertySource (const String &property_name) |
| Set the name of a property that will be used to obtain the formatting to use for the top edge image.
|
void | setBottomEdgeFormattingPropertySource (const String &property_name) |
| Set the name of a property that will be used to obtain the formatting to use for the bottom edge image.
|
void | setBackgroundVerticalFormattingPropertySource (const String &property_name) |
| Set the name of a property that will be used to obtain the vertical formatting to use for the backdround image.
|
void | setBackgroundHorizontalFormattingPropertySource (const String &property_name) |
| Set the name of a property that will be used to obtain the horizontal formatting to use for the backdround image.
|
VerticalFormatting | getLeftEdgeFormatting (const Window &wnd) const |
| Return the formatting to be used for the left edge image.
|
VerticalFormatting | getRightEdgeFormatting (const Window &wnd) const |
| Return the formatting to be used for the right edge image.
|
HorizontalFormatting | getTopEdgeFormatting (const Window &wnd) const |
| Return the formatting to be used for the top edge image.
|
HorizontalFormatting | getBottomEdgeFormatting (const Window &wnd) const |
| Return the formatting to be used for the bottom edge image.
|
VerticalFormatting | getBackgroundVerticalFormatting (const Window &wnd) const |
| Return the vertical formatting to be used for the background image.
|
HorizontalFormatting | getBackgroundHorizontalFormatting (const Window &wnd) const |
| Return the horizontal formatting to be used for the background image.
|
const Image * | getImage (FrameImageComponent part, const Window &wnd) 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 an Image that will be drawn by this FrameComponent.
|
void | setImage (FrameImageComponent part, const String &name) |
| Set an Image that will be drawn by this FrameComponent.
|
void | setImagePropertySource (FrameImageComponent part, const String &name) |
| Set the name of the Property that will be accesssed on the target Window to determine the Image that will be drawn by the FrameComponent.
|
bool | isImageSpecified (FrameImageComponent part) const |
| Return whether the given component image has been specified.
|
bool | isImageFetchedFromProperty (FrameImageComponent part) const |
| Return whether the given component image is specified via a property.
|
const String & | getImagePropertySource (FrameImageComponent part) const |
| Return the name of the property that will be used to determine the image to use for the given component image.
|
void | writeXMLToStream (XMLSerializer &xml_stream) const |
| Writes an xml representation of this FrameComponent to out_stream.
|
bool | operator== (const FrameComponent &rhs) const |
void | render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const |
| Render this component. More correctly, the component is cached for rendering.
|
void | render (Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *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 component.
|
void | setComponentArea (const ComponentArea &area) |
| Set the conponent's ComponentArea.
|
const ColourRect & | getColours () const |
| Return the ColourRect used by this component.
|
void | setColours (const ColourRect &cols) |
| Set the colours to be used by this component.
|
void | setColoursPropertySource (const String &property) |
| Set the name of the property where colour values can be obtained.
|
virtual bool | handleFontRenderSizeChange (Window &window, const Font *font) const |
| perform any processing required due to the given font having changed.
|
Protected Member Functions |
void | render_impl (Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const |
| Function to do main render caching work.
|
void | renderImage (GeometryBuffer &buffer, const Image *image, VerticalFormatting vertFmt, HorizontalFormatting horzFmt, Rectf &destRect, const ColourRect &colours, const Rectf *clipper, bool clipToDisplay) const |
void | initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const |
| Helper function to initialise a ColourRect with appropriate values according to the way the component is set up.
|
bool | writeColoursXML (XMLSerializer &xml_stream) const |
| Writes xml for the colours to a OutStream. Will prefer property colours before explicit.
|
Class that encapsulates information for a frame with background (9 images in total)
Corner images are always drawn at their natural size, edges can be fomatted (stretched, tiled or aligned) between the corner pieces for a particular edge, the background image will cover the inner rectangle formed by the edge images and can be formatted in both dimensions.