Collaboration 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. | |
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 |
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. |
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.
|
Enumeration of horizontal formatting options for a RenderableImage.
|
|
Enumeration of vertical formatting options for a RenderableImage.
|
|
Renders the imagery for a RenderableImage element.
|
|
Return current horizontal formatting setting.
|
|
Return the Image object currently set to be rendered.
|
|
Return current quad split mode setting.
|
|
Return current vertical formatting setting.
|
|
Set the required horizontal formatting.
|
|
Set the Image object to be drawn by this RenderableImage.
|
|
Set the required quad split mode.
|
|
Set the required vertical formatting.
|