Crazy Eddie's GUI System 0.8.7
|
Class that encapsulates information for a single image component. More...
#include <ImageryComponent.h>
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 &name) |
Set the Image that will be drawn by this ImageryComponent. | |
VerticalFormatting | getVerticalFormatting (const Window &wnd) const |
Return the current vertical formatting setting for this ImageryComponent. | |
VerticalFormatting | getVerticalFormattingFromComponent () const |
Directly returns the vertical formatting which was set for the ImageryComponent. | |
void | setVerticalFormatting (VerticalFormatting fmt) |
Set the vertical formatting setting for this ImageryComponent. | |
HorizontalFormatting | getHorizontalFormatting (const Window &wnd) const |
Return the current horizontal formatting setting for this ImageryComponent. | |
HorizontalFormatting | getHorizontalFormattingFromComponent () const |
Directly returns the horizontal formatting which was set for the ImageryComponent. | |
void | setHorizontalFormatting (HorizontalFormatting fmt) |
Set the horizontal formatting setting for this ImageryComponent. | |
const String & | getHorizontalFormattingPropertySource () const |
Returns the name of the property that will be used to obtain the horizontal formatting to use for this ImageryComponent or an empty string if none is set. | |
void | setHorizontalFormattingPropertySource (const String &property_name) |
Set the name of a property that will be used to obtain the horizontal formatting to use for this ImageryComponent. | |
const String & | getVerticalFormattingPropertySource () const |
Returns the name of the property that will be used to obtain the vertical formatting to use for this ImageryComponent or an empty string if none is set. | |
void | setVerticalFormattingPropertySource (const String &property_name) |
Set the name of a property that will be used to obtain the vertical formatting to use 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. | |
![]() | |
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. | |
const String & | getColoursPropertySource () const |
Returns the name of the property from which the colour values will be obtained, if set. | |
void | setColoursPropertySource (const String &property) |
Set the name of the property where colour values will be obtained, if set. | |
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 | 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. | |
Protected Attributes | |
const Image * | d_image |
FormattingSetting< VerticalFormatting > | d_vertFormatting |
Vertical formatting to be applied when rendering the image component. | |
FormattingSetting< 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. | |
![]() | |
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. | |
Class that encapsulates information for a single image component.
HorizontalFormatting CEGUI::ImageryComponent::getHorizontalFormatting | ( | const Window & | wnd | ) | const |
Return the current horizontal formatting setting for this ImageryComponent.
HorizontalFormatting CEGUI::ImageryComponent::getHorizontalFormattingFromComponent | ( | ) | const |
Directly returns the horizontal formatting which was set for the ImageryComponent.
Returns the name of the property that will be used to obtain the horizontal formatting to use for this ImageryComponent or an empty string if none is set.
Return the Image object that will be drawn by this ImageryComponent.
Return the name of the property that will be used to determine the image for this ImageryComponent.
VerticalFormatting CEGUI::ImageryComponent::getVerticalFormatting | ( | const Window & | wnd | ) | const |
Return the current vertical formatting setting for this ImageryComponent.
VerticalFormatting CEGUI::ImageryComponent::getVerticalFormattingFromComponent | ( | ) | const |
Directly returns the vertical formatting which was set for the ImageryComponent.
Returns the name of the property that will be used to obtain the vertical formatting to use for this ImageryComponent or an empty string if none is set.
bool CEGUI::ImageryComponent::isImageFetchedFromProperty | ( | ) | const |
Return whether this ImageryComponent fetches it's image via a property on the target window.
|
protectedvirtual |
Function to do main render caching work.
Implements CEGUI::FalagardComponentBase.
void CEGUI::ImageryComponent::setHorizontalFormatting | ( | HorizontalFormatting | fmt | ) |
Set the horizontal formatting setting for this ImageryComponent.
fmt | One of the HorizontalFormatting enumerated values. |
Set the Image that will be drawn by this ImageryComponent.
Pointer | to the Image object to be drawn by this ImageryComponent. |
Set the Image that will be drawn by this ImageryComponent.
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. |
void CEGUI::ImageryComponent::setVerticalFormatting | ( | VerticalFormatting | fmt | ) |
Set the vertical formatting setting for this ImageryComponent.
fmt | One of the VerticalFormatting enumerated values. |
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. |
CEGUI::Image to be drawn by this image component.