Public Member Functions | |
ImageryComponent () | |
Constructor. | |
const Image * | getImage () const |
Return the Image object that will be drawn by this ImageryComponent. | |
void | setImage (const Image *image) |
Set the Image that will be drawn by this ImageryComponent. | |
void | setImage (const String &imageset, const String &image) |
Set the Image that will be drawn by this ImageryComponent. | |
VerticalFormatting | getVerticalFormatting () const |
Return the current vertical formatting setting for this ImageryComponent. | |
void | setVerticalFormatting (VerticalFormatting fmt) |
Set the vertical formatting setting for this ImageryComponent. | |
HorizontalFormatting | getHorizontalFormatting () const |
Return the current horizontal formatting setting for this ImageryComponent. | |
void | setHorizontalFormatting (HorizontalFormatting fmt) |
Set the horizontal formatting setting for this ImageryComponent. | |
void | writeXMLToStream (XMLSerializer &xml_stream) const |
Writes an xml representation of this ImageryComponent to out_stream. | |
bool | isImageFetchedFromProperty () const |
Return whether this ImageryComponent fetches it's image via a property on the target window. | |
const String & | getImagePropertySource () const |
Return the name of the property that will be used to determine the image for this ImageryComponent. | |
void | setImagePropertySource (const String &property) |
Set the name of the property that will be used to determine the image for this ImageryComponent. | |
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. | |
Protected Attributes | |
const Image * | d_image |
CEGUI::Image to be drawn by this image component. | |
VerticalFormatting | d_vertFormatting |
Vertical formatting to be applied when rendering the image component. | |
HorizontalFormatting | d_horzFormatting |
Horizontal formatting to be applied when rendering the image component. | |
String | d_imagePropertyName |
Name of the property to access to obtain the image to be used. |
HorizontalFormatting CEGUI::ImageryComponent::getHorizontalFormatting | ( | ) | const |
Return the current horizontal formatting setting for this ImageryComponent.
References d_horzFormatting.
const Image * CEGUI::ImageryComponent::getImage | ( | void | ) | const |
Return the Image object that will be drawn by this ImageryComponent.
References d_image.
const String & CEGUI::ImageryComponent::getImagePropertySource | ( | ) | const |
Return the name of the property that will be used to determine the image for this ImageryComponent.
References d_imagePropertyName.
VerticalFormatting CEGUI::ImageryComponent::getVerticalFormatting | ( | ) | const |
Return the current vertical formatting setting for this ImageryComponent.
References d_vertFormatting.
bool CEGUI::ImageryComponent::isImageFetchedFromProperty | ( | ) | const |
Return whether this ImageryComponent fetches it's image via a property on the target window.
References d_imagePropertyName, and CEGUI::String::empty().
Referenced by render_impl(), and writeXMLToStream().
void CEGUI::ImageryComponent::setHorizontalFormatting | ( | HorizontalFormatting | fmt | ) |
Set the horizontal formatting setting for this ImageryComponent.
fmt | One of the HorizontalFormatting enumerated values. |
References d_horzFormatting.
Set the Image that will be drawn by this ImageryComponent.
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_image, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().
void CEGUI::ImageryComponent::setImage | ( | const Image * | image | ) |
Set the Image that will be drawn by this ImageryComponent.
Pointer | to the Image object to be drawn by this ImageryComponent. |
References d_image.
void CEGUI::ImageryComponent::setImagePropertySource | ( | const String & | property | ) |
Set the name of the property that will be used to determine the image for this ImageryComponent.
property | String object holding the name of a Propery. The property should access a imageset & image specification. |
References d_imagePropertyName.
void CEGUI::ImageryComponent::setVerticalFormatting | ( | VerticalFormatting | fmt | ) |
Set the vertical formatting setting for this ImageryComponent.
fmt | One of the VerticalFormatting enumerated values. |
References d_vertFormatting.
void CEGUI::ImageryComponent::writeXMLToStream | ( | XMLSerializer & | xml_stream | ) | const |
Writes an xml representation of this ImageryComponent to out_stream.
xml_stream | Stream where xml data should be output. |
References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), CEGUI::FalagardComponentBase::d_area, d_horzFormatting, d_image, d_imagePropertyName, d_vertFormatting, CEGUI::Image::getImagesetName(), CEGUI::Image::getName(), isImageFetchedFromProperty(), CEGUI::XMLSerializer::openTag(), CEGUI::FalagardComponentBase::writeColoursXML(), CEGUI::FalagardComponentBase::writeHorzFormatXML(), CEGUI::FalagardComponentBase::writeVertFormatXML(), and CEGUI::ComponentArea::writeXMLToStream().