#include <CEGUIRenderableImage.h>
Inheritance diagram for CEGUI::RenderableImage:
Public Types | |
enum | HorzFormatting { LeftAligned, RightAligned, HorzCentred, HorzStretched, HorzTiled } |
Enumeration of horizontal formatting options for a RenderableImage. More... | |
enum | VertFormatting { TopAligned, BottomAligned, VertCentred, VertStretched, VertTiled } |
Enumeration of vertical formatting options for a RenderableImage. More... | |
Public Member Functions | |
RenderableImage (void) | |
Default constructor for RenderableImage objects. | |
virtual | ~RenderableImage (void) |
Destructor for RenderableImage objects. | |
void | setImage (const Image *image) |
Set the Image object to be drawn by this RenderableImage. | |
void | setHorzFormatting (HorzFormatting formatting) |
Set the required horizontal formatting. | |
void | setVertFormatting (VertFormatting formatting) |
Set the required vertical formatting. | |
void | setQuadSplitMode (QuadSplitMode split_mode) |
Set the required quad split mode. | |
const Image * | getImage (void) const |
Return the Image object currently set to be rendered. | |
HorzFormatting | getHorzFormatting (void) const |
Return current horizontal formatting setting. | |
VertFormatting | getVertFormatting (void) const |
Return current vertical formatting setting. | |
QuadSplitMode | getQuadSplitMode (void) const |
Return current quad split mode setting. | |
void | draw (const Vector3 &position, const Rect &clip_rect) |
Draw the element chain starting with this element. | |
void | draw (RenderCache &renderCache) const |
Draw the element chain into the given RenderCache. | |
RenderableElement * | getNextElement (void) const |
Return a pointer to the next RenderableElement in the chain. | |
const ColourRect & | getColours (void) const |
Return the rendering colours set for this RenderableElement. | |
Point | getPosition (void) const |
Return the offset position of this RenderableElement. | |
Size | getSize (void) const |
Return the current size of the element. | |
const Rect & | getRect (void) const |
Return the area for the element. | |
bool | isColourRectPerImage (bool setting) const |
return whether the element colours will be applied locally to each image drawn as part of the RenderableElement, or applied across the whole of the RenderableElement area. | |
void | setNextElement (RenderableElement *element) |
Link another RenderableElement to this one. | |
void | setColours (const ColourRect &colours) |
Sets the colours to be applied when rendering the element. | |
void | setColours (const colour &top_left_colour, const colour &top_right_colour, const colour &bottom_left_colour, const colour &bottom_right_colour) |
Sets the colours to be applied when rendering the element. | |
void | setPosition (const Point &position) |
Set the rendering offset position for this element. | |
void | setSize (const Size &size) |
set the dimensions for the frame. | |
void | setRect (const Rect &area) |
Set the area for the frame. | |
void | setColourRectPerImage (bool setting) |
set whether the element colours should be applied locally to each image drawn as part of the RenderableElement, or applied across the whole of the RenderableElement area. | |
Protected Member Functions | |
void | draw_impl (const Vector3 &position, const Rect &clip_rect) const |
Renders the imagery for a RenderableImage element. | |
void | draw_impl (RenderCache &renderCache) const |
Implementation method to draw the element into the given RenderCache. | |
uint | getHorzTileCount () const |
return number of horizontal tiles required. | |
uint | getVertTileCount () const |
return number of vertical tiles required. | |
float | getBaseXCoord (const Size &sz) const |
Return base x co-ord for first tile. | |
float | getBaseYCoord (const Size &sz) const |
Return base y co-ord for first tile. | |
Size | getDestinationSize () const |
Return target size to be used for each tile. | |
Protected Attributes | |
HorzFormatting | d_horzFormat |
Currently set horizontal formatting option. | |
VertFormatting | d_vertFormat |
Currently set vertical formatting option. | |
QuadSplitMode | d_quadSplitMode |
Currently set quad split mode. | |
const Image * | d_image |
Pointer to the actual Image to be displayed. | |
RenderableElement * | d_next |
Link to another RenderableElement. | |
ColourRect | d_colours |
Colours to be used for this element;. | |
Rect | d_area |
Currently defined area for this element. | |
bool | d_useColoursPerImage |
true if d_colours should be applied separately to each Image drawn (false to interpolate across d_area). |
This class is intended to be used where a (usually top-level) GUI element needs to draw an image that requires some additional formatting. It is possible to specify the Image that is to be rendered, as well as the horizontal and vertical formatting required.
Definition at line 44 of file CEGUIRenderableImage.h.
|
Enumeration of horizontal formatting options for a RenderableImage.
Definition at line 54 of file CEGUIRenderableImage.h. |
|
Enumeration of vertical formatting options for a RenderableImage.
Definition at line 68 of file CEGUIRenderableImage.h. |
|
Default constructor for RenderableImage objects.
Definition at line 37 of file CEGUIRenderableImage.cpp. |
|
Destructor for RenderableImage objects.
Definition at line 49 of file CEGUIRenderableImage.cpp. |
|
Draw the element chain into the given RenderCache.
Definition at line 84 of file CEGUIRenderableElement.cpp. References CEGUI::RenderableElement::d_next, CEGUI::RenderableElement::draw(), and CEGUI::RenderableElement::draw_impl(). |
|
Draw the element chain starting with this element.
Definition at line 67 of file CEGUIRenderableElement.cpp. References CEGUI::RenderableElement::d_area, CEGUI::Rect::d_left, CEGUI::RenderableElement::d_next, CEGUI::Rect::d_top, CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, CEGUI::RenderableElement::draw(), and CEGUI::RenderableElement::draw_impl(). Referenced by CEGUI::RenderableElement::draw(), CEGUI::StaticImage::populateRenderCache(), and CEGUI::Static::populateRenderCache(). |
|
Implementation method to draw the element into the given RenderCache.
Implements CEGUI::RenderableElement. Definition at line 107 of file CEGUIRenderableImage.cpp. References CEGUI::RenderCache::cacheImage(), CEGUI::RenderableElement::d_area, CEGUI::Rect::d_bottom, CEGUI::RenderableElement::d_colours, CEGUI::Size::d_height, d_image, CEGUI::Rect::d_left, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::RenderableElement::d_useColoursPerImage, CEGUI::Size::d_width, getBaseXCoord(), getBaseYCoord(), getDestinationSize(), CEGUI::Rect::getHeight(), getHorzTileCount(), CEGUI::Image::getOffsetX(), CEGUI::Image::getOffsetY(), CEGUI::ColourRect::getSubRectangle(), getVertTileCount(), CEGUI::Rect::getWidth(), and CEGUI::ColourRect::isMonochromatic(). |
|
|
Return base x co-ord for first tile.
Definition at line 173 of file CEGUIRenderableImage.cpp. References CEGUI::RenderableElement::d_area, d_horzFormat, CEGUI::Size::d_width, CEGUI::Rect::getWidth(), HorzCentred, HorzStretched, HorzTiled, LeftAligned, PixelAligned, and RightAligned. Referenced by draw_impl(). |
|
Return base y co-ord for first tile.
Definition at line 196 of file CEGUIRenderableImage.cpp. References BottomAligned, CEGUI::RenderableElement::d_area, CEGUI::Size::d_height, d_vertFormat, CEGUI::Rect::getHeight(), PixelAligned, TopAligned, VertCentred, VertStretched, and VertTiled. Referenced by draw_impl(). |
|
Return the rendering colours set for this RenderableElement.
Definition at line 94 of file CEGUIRenderableElement.h. |
|
Return target size to be used for each tile.
Definition at line 219 of file CEGUIRenderableImage.cpp. References CEGUI::RenderableElement::d_area, d_horzFormat, d_image, d_vertFormat, CEGUI::Image::getHeight(), CEGUI::Rect::getHeight(), CEGUI::Image::getWidth(), CEGUI::Rect::getWidth(), HorzStretched, and VertStretched. Referenced by draw_impl(). |
|
Return current horizontal formatting setting.
Definition at line 167 of file CEGUIRenderableImage.h. |
|
return number of horizontal tiles required.
Definition at line 163 of file CEGUIRenderableImage.cpp. References CEGUI::RenderableElement::d_area, d_horzFormat, d_image, CEGUI::Image::getWidth(), CEGUI::Rect::getWidth(), and HorzTiled. Referenced by draw_impl(). |
|
Return the Image object currently set to be rendered.
Definition at line 157 of file CEGUIRenderableImage.h. Referenced by CEGUI::PushButtonProperties::DisabledImage::get(), CEGUI::PushButtonProperties::HoverImage::get(), CEGUI::PushButtonProperties::PushedImage::get(), and CEGUI::PushButtonProperties::NormalImage::get(). |
|
Return a pointer to the next RenderableElement in the chain.
Definition at line 84 of file CEGUIRenderableElement.h. |
|
Return the offset position of this RenderableElement.
Definition at line 106 of file CEGUIRenderableElement.h. |
|
Return current quad split mode setting.
Definition at line 187 of file CEGUIRenderableImage.h. |
|
Return the area for the element.
Definition at line 126 of file CEGUIRenderableElement.h. |
|
Return the current size of the element.
Definition at line 116 of file CEGUIRenderableElement.h. |
|
Return current vertical formatting setting.
Definition at line 177 of file CEGUIRenderableImage.h. |
|
return number of vertical tiles required.
Definition at line 168 of file CEGUIRenderableImage.cpp. References CEGUI::RenderableElement::d_area, d_image, d_vertFormat, CEGUI::Image::getHeight(), CEGUI::Rect::getHeight(), and VertTiled. Referenced by draw_impl(). |
|
return whether the element colours will be applied locally to each image drawn as part of the RenderableElement, or applied across the whole of the RenderableElement area.
Definition at line 138 of file CEGUIRenderableElement.h. |
|
set whether the element colours should be applied locally to each image drawn as part of the RenderableElement, or applied across the whole of the RenderableElement area.
Definition at line 246 of file CEGUIRenderableElement.h. |
|
Sets the colours to be applied when rendering the element.
Definition at line 55 of file CEGUIRenderableElement.cpp. References CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::RenderableElement::d_colours, CEGUI::ColourRect::d_top_left, and CEGUI::ColourRect::d_top_right. |
|
Sets the colours to be applied when rendering the element.
Definition at line 171 of file CEGUIRenderableElement.h. Referenced by CEGUI::Static::updateRenderableFrameColours(), and CEGUI::StaticImage::updateRenderableImageColours(). |
|
Set the required horizontal formatting.
Definition at line 121 of file CEGUIRenderableImage.h. Referenced by CEGUI::PushButtonProperties::DisabledImage::set(), CEGUI::PushButtonProperties::HoverImage::set(), CEGUI::PushButtonProperties::PushedImage::set(), CEGUI::PushButtonProperties::NormalImage::set(), CEGUI::StaticImage::setFormatting(), CEGUI::StaticImage::setHorizontalFormatting(), and CEGUI::StaticImage::StaticImage(). |
|
Set the Image object to be drawn by this RenderableImage.
Definition at line 108 of file CEGUIRenderableImage.h. Referenced by CEGUI::PushButtonProperties::DisabledImage::set(), CEGUI::PushButtonProperties::HoverImage::set(), CEGUI::PushButtonProperties::PushedImage::set(), CEGUI::PushButtonProperties::NormalImage::set(), and CEGUI::StaticImage::setImage(). |
|
Link another RenderableElement to this one. The linked element will be drawn whenever this element is drawn using the same base position and clipping area as provided when the RenderableElement::draw method is called. Whole chains of Renderable Elements can be created using this system.
Definition at line 158 of file CEGUIRenderableElement.h. |
|
Set the rendering offset position for this element.
Definition at line 208 of file CEGUIRenderableElement.h. Referenced by CEGUI::StaticImage::onStaticFrameChanged(). |
|
Set the required quad split mode.
Definition at line 147 of file CEGUIRenderableImage.h. |
|
Set the area for the frame.
Definition at line 231 of file CEGUIRenderableElement.h. Referenced by CEGUI::PushButton::onSized(), CEGUI::PushButton::setCustomImageryAutoSized(), CEGUI::PushButton::setDisabledImage(), CEGUI::PushButton::setHoverImage(), CEGUI::PushButton::setNormalImage(), and CEGUI::PushButton::setPushedImage(). |
|
set the dimensions for the frame.
Definition at line 218 of file CEGUIRenderableElement.h. Referenced by CEGUI::StaticImage::onSized(), CEGUI::Static::onSized(), and CEGUI::StaticImage::onStaticFrameChanged(). |
|
Set the required vertical formatting.
Definition at line 134 of file CEGUIRenderableImage.h. Referenced by CEGUI::PushButtonProperties::DisabledImage::set(), CEGUI::PushButtonProperties::HoverImage::set(), CEGUI::PushButtonProperties::PushedImage::set(), CEGUI::PushButtonProperties::NormalImage::set(), CEGUI::StaticImage::setFormatting(), CEGUI::StaticImage::setVerticalFormatting(), and CEGUI::StaticImage::StaticImage(). |
|
Currently defined area for this element.
Definition at line 304 of file CEGUIRenderableElement.h. Referenced by CEGUI::RenderableElement::draw(), draw_impl(), CEGUI::RenderableFrame::draw_impl(), getBaseXCoord(), getBaseYCoord(), getDestinationSize(), getHorzTileCount(), and getVertTileCount(). |
|
Colours to be used for this element;.
Definition at line 303 of file CEGUIRenderableElement.h. Referenced by draw_impl(), CEGUI::RenderableFrame::draw_impl(), and CEGUI::RenderableElement::setColours(). |
|
Currently set horizontal formatting option.
Definition at line 245 of file CEGUIRenderableImage.h. Referenced by getBaseXCoord(), getDestinationSize(), and getHorzTileCount(). |
|
Pointer to the actual Image to be displayed.
Definition at line 248 of file CEGUIRenderableImage.h. Referenced by draw_impl(), getDestinationSize(), getHorzTileCount(), and getVertTileCount(). |
|
Link to another RenderableElement.
Definition at line 302 of file CEGUIRenderableElement.h. Referenced by CEGUI::RenderableElement::draw(). |
|
Currently set quad split mode.
Definition at line 247 of file CEGUIRenderableImage.h. Referenced by draw_impl(). |
|
true if d_colours should be applied separately to each Image drawn (false to interpolate across d_area).
Definition at line 305 of file CEGUIRenderableElement.h. Referenced by draw_impl(), and CEGUI::RenderableFrame::draw_impl(). |
|
Currently set vertical formatting option.
Definition at line 246 of file CEGUIRenderableImage.h. Referenced by getBaseYCoord(), getDestinationSize(), and getVertTileCount(). |