Crazy Eddies GUI System  0.6.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CEGUI::ImageryComponent Class Reference

Class that encapsulates information for a single image component. More...

+ Inheritance diagram for CEGUI::ImageryComponent:
+ Collaboration diagram for CEGUI::ImageryComponent:

Public Member Functions

 ImageryComponent ()
 Constructor.
 
const ImagegetImage () const
 Return the Image object that will be drawn by this ImageryComponent. More...
 
void setImage (const Image *image)
 Set the Image that will be drawn by this ImageryComponent. More...
 
void setImage (const String &imageset, const String &image)
 Set the Image that will be drawn by this ImageryComponent. More...
 
VerticalFormatting getVerticalFormatting () const
 Return the current vertical formatting setting for this ImageryComponent. More...
 
void setVerticalFormatting (VerticalFormatting fmt)
 Set the vertical formatting setting for this ImageryComponent. More...
 
HorizontalFormatting getHorizontalFormatting () const
 Return the current horizontal formatting setting for this ImageryComponent. More...
 
void setHorizontalFormatting (HorizontalFormatting fmt)
 Set the horizontal formatting setting for this ImageryComponent. More...
 
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this ImageryComponent to out_stream. More...
 
bool isImageFetchedFromProperty () const
 Return whether this ImageryComponent fetches it's image via a property on the target window. More...
 
const StringgetImagePropertySource () const
 Return the name of the property that will be used to determine the image for this ImageryComponent. More...
 
void setImagePropertySource (const String &property)
 Set the name of the property that will be used to determine the image for this ImageryComponent. More...
 
- Public Member Functions inherited from CEGUI::FalagardComponentBase
 FalagardComponentBase ()
 Constructor.
 
virtual ~FalagardComponentBase ()
 Destructor.
 
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. More...
 
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. More...
 
const ComponentAreagetComponentArea () const
 Return the ComponentArea of this ImageryComponent. More...
 
void setComponentArea (const ComponentArea &area)
 Set the ImageryComponent's ComponentArea. More...
 
const ColourRectgetColours () const
 Return the ColourRect set for use by this ImageryComponent. More...
 
void setColours (const ColourRect &cols)
 Set the colours to be used by this ImageryComponent. More...
 
void setColoursPropertySource (const String &property)
 Set the name of the property where colour values can be obtained. More...
 
void setColoursPropertyIsColourRect (bool setting=true)
 Set whether the colours property source represents a full ColourRect. More...
 
void setVertFormattingPropertySource (const String &property)
 Set the name of the property where vertical formatting option can be obtained. More...
 
void setHorzFormattingPropertySource (const String &property)
 Set the name of the property where horizontal formatting option can be obtained. More...
 

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 Member Functions inherited from CEGUI::FalagardComponentBase
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. More...
 
bool writeColoursXML (XMLSerializer &xml_stream) const
 Writes xml for the colours to a OutStream. Will prefer property colours before explicit. More...
 
bool writeVertFormatXML (XMLSerializer &xml_stream) const
 Writes xml for the vertical formatting to a OutStream if such a property is defined. More...
 
bool writeHorzFormatXML (XMLSerializer &xml_stream) const
 Writes xml for the horizontal formatting to a OutStream if such a property is defined. More...
 

Protected Attributes

const Imaged_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.
 
- Protected Attributes inherited from CEGUI::FalagardComponentBase
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.
 

Detailed Description

Class that encapsulates information for a single image component.

Member Function Documentation

HorizontalFormatting CEGUI::ImageryComponent::getHorizontalFormatting ( ) const

Return the current horizontal formatting setting for this ImageryComponent.

Returns
One of the HorizontalFormatting enumerated values.

References d_horzFormatting.

const Image * CEGUI::ImageryComponent::getImage ( void  ) const

Return the Image object that will be drawn by this ImageryComponent.

Returns
Image object.

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.

Returns
String object holding the name of a Propery.

References d_imagePropertyName.

VerticalFormatting CEGUI::ImageryComponent::getVerticalFormatting ( ) const

Return the current vertical formatting setting for this ImageryComponent.

Returns
One of the VerticalFormatting enumerated values.

References d_vertFormatting.

bool CEGUI::ImageryComponent::isImageFetchedFromProperty ( ) const

Return whether this ImageryComponent fetches it's image via a property on the target window.

Returns
  • true if the image comes via a Propery.
  • false if the image is defined explicitly.

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.

Parameters
fmtOne of the HorizontalFormatting enumerated values.
Returns
Nothing.

References d_horzFormatting.

void CEGUI::ImageryComponent::setImage ( const Image image)

Set the Image that will be drawn by this ImageryComponent.

Parameters
Pointerto the Image object to be drawn by this ImageryComponent.
Returns
Nothing.

References d_image.

void CEGUI::ImageryComponent::setImage ( const String imageset,
const String image 
)

Set the Image that will be drawn by this ImageryComponent.

Parameters
imagesetString holding the name of the Imagset that contains the Image to be rendered.
imageString holding the name of the Image to be rendered.
Returns
Nothing.

References d_image, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().

void CEGUI::ImageryComponent::setImagePropertySource ( const String property)

Set the name of the property that will be used to determine the image for this ImageryComponent.

Parameters
propertyString object holding the name of a Propery. The property should access a imageset & image specification.
Returns
Nothing.

References d_imagePropertyName.

void CEGUI::ImageryComponent::setVerticalFormatting ( VerticalFormatting  fmt)

Set the vertical formatting setting for this ImageryComponent.

Parameters
fmtOne of the VerticalFormatting enumerated values.
Returns
Nothing.

References d_vertFormatting.

void CEGUI::ImageryComponent::writeXMLToStream ( XMLSerializer xml_stream) const