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 (XMLSerializer &xml_stream) const |
Writes an xml representation of this FrameComponent to out_stream. | |
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 |
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. |
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.
HorizontalFormatting CEGUI::FrameComponent::getBackgroundHorizontalFormatting | ( | ) | const |
Return the current horizontal formatting setting for this FrameComponent.
References d_horzFormatting.
VerticalFormatting CEGUI::FrameComponent::getBackgroundVerticalFormatting | ( | ) | const |
Return the current vertical formatting setting for this FrameComponent.
References d_vertFormatting.
const Image * CEGUI::FrameComponent::getImage | ( | FrameImageComponent | part | ) | const |
Return the Image object that will be drawn by this FrameComponent for a specified frame part.
part | One of the FrameImageComponent enumerated values specifying the component image to be accessed. |
References d_frameImages, and CEGUI::FIC_FRAME_IMAGE_COUNT.
void CEGUI::FrameComponent::setBackgroundHorizontalFormatting | ( | HorizontalFormatting | fmt | ) |
Set the horizontal formatting setting for this FrameComponent.
fmt | One of the HorizontalFormatting enumerated values. |
References d_horzFormatting.
void CEGUI::FrameComponent::setBackgroundVerticalFormatting | ( | VerticalFormatting | fmt | ) |
Set the vertical formatting setting for this FrameComponent.
fmt | One of the VerticalFormatting enumerated values. |
References d_vertFormatting.
void CEGUI::FrameComponent::setImage | ( | FrameImageComponent | part, | |
const String & | imageset, | |||
const String & | image | |||
) |
Set the Image that will be drawn by this FrameComponent.
part | One of the FrameImageComponent enumerated values specifying the component image to be accessed. | |
imageset | String holding the name of the Imagset that contains the Image to be rendered. | |
image | String holding the name of the Image to be rendered. |
References d_frameImages, CEGUI::FIC_FRAME_IMAGE_COUNT, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().
void CEGUI::FrameComponent::setImage | ( | FrameImageComponent | part, | |
const Image * | image | |||
) |
Set the Image that will be drawn by this ImageryComponent.
part | One of the FrameImageComponent enumerated values specifying the component image to be accessed. | |
image | Pointer to the Image object to be drawn by this FrameComponent. |
References d_frameImages, and CEGUI::FIC_FRAME_IMAGE_COUNT.
void CEGUI::FrameComponent::writeXMLToStream | ( | XMLSerializer & | xml_stream | ) | const |
Writes an xml representation of this FrameComponent to out_stream.
xml_stream | Stream where xml data should be output. |
References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), CEGUI::FalagardComponentBase::d_area, d_frameImages, d_horzFormatting, d_vertFormatting, CEGUI::FIC_FRAME_IMAGE_COUNT, CEGUI::XMLSerializer::openTag(), CEGUI::FalagardComponentBase::writeColoursXML(), CEGUI::FalagardComponentBase::writeHorzFormatXML(), CEGUI::FalagardComponentBase::writeVertFormatXML(), and CEGUI::ComponentArea::writeXMLToStream().