Public Member Functions | |
Size | getSize (void) const |
Return a Size object containing the dimensions of the Image. | |
float | getWidth (void) const |
Return the pixel width of the image. | |
float | getHeight (void) const |
Return the pixel height of the image. | |
Point | getOffsets (void) const |
Return a Point object that contains the offset applied when rendering this Image. | |
float | getOffsetX (void) const |
Return the X rendering offset. | |
float | getOffsetY (void) const |
Return the Y rendering offset. | |
const String & | getName (void) const |
Return the name of this Image object. | |
const String & | getImagesetName (void) const |
Return the name of the Imageset that contains this Image. | |
const Imageset * | getImageset (void) const |
Return the parent Imageset object that contains this Image. | |
const Rect & | getSourceTextureArea (void) const |
Return Rect describing the source texture area used by this Image. | |
void | draw (const Vector3 &position, const Size &size, const Rect &clip_rect, const colour &top_left_colour=0xFFFFFFFF, const colour &top_right_colour=0xFFFFFFFF, const colour &bottom_left_colour=0xFFFFFFFF, const colour &bottom_right_colour=0xFFFFFFFF, QuadSplitMode quad_split_mode=TopLeftToBottomRight) const |
Queue the image to be drawn. | |
void | draw (const Rect &dest_rect, float z, const Rect &clip_rect, const colour &top_left_colour=0xFFFFFFFF, const colour &top_right_colour=0xFFFFFFFF, const colour &bottom_left_colour=0xFFFFFFFF, const colour &bottom_right_colour=0xFFFFFFFF, QuadSplitMode quad_split_mode=TopLeftToBottomRight) const |
Queue the image to be drawn. | |
void | draw (const Vector3 &position, const Size &size, const Rect &clip_rect, const ColourRect &colours, QuadSplitMode quad_split_mode=TopLeftToBottomRight) const |
Queue the image to be drawn. | |
void | draw (const Vector3 &position, const Rect &clip_rect, const ColourRect &colours, QuadSplitMode quad_split_mode=TopLeftToBottomRight) const |
Queue the image to be drawn. | |
void | draw (const Vector3 &position, const Rect &clip_rect, const colour &top_left_colour=0xFFFFFFFF, const colour &top_right_colour=0xFFFFFFFF, const colour &bottom_left_colour=0xFFFFFFFF, const colour &bottom_right_colour=0xFFFFFFFF, QuadSplitMode quad_split_mode=TopLeftToBottomRight) const |
Queue the image to be drawn. | |
void | draw (const Rect &dest_rect, float z, const Rect &clip_rect, const ColourRect &colours, QuadSplitMode quad_split_mode=TopLeftToBottomRight) const |
Queue the image to be drawn. | |
void | writeXMLToStream (XMLSerializer &xml_stream) const |
Writes an xml representation of this Image object to out_stream. | |
Image (void) | |
Default constructor (only used by std::map). | |
Image (const Imageset *owner, const String &name, const Rect &area, const Point &render_offset, float horzScaling=1.0f, float vertScaling=1.0f) | |
Constructor for Image objects. This is not normally used directly by client code, use the Imageset interface instead. | |
Image (const Image &image) | |
Copy constructor. | |
~Image (void) | |
Destructor for Image objects. | |
Friends | |
class | std::map< String, Image, String::FastLessCompare > |
struct | std::pair< const String, Image > |
class | Imageset |
CEGUI::Image::Image | ( | const Imageset * | owner, | |
const String & | name, | |||
const Rect & | area, | |||
const Point & | render_offset, | |||
float | horzScaling = 1.0f , |
|||
float | vertScaling = 1.0f | |||
) |
Constructor for Image objects. This is not normally used directly by client code, use the Imageset interface instead.
owner | Pointer to a Imageset object that owns this Image. This must not be NULL. | |
name | String object describing the name of the image being created. | |
area | Rect object describing an area that will be associated with this image. | |
render_offset | Point object that describes the offset to be applied when rendering this image. | |
horzScaling | float value indicating the initial horizontal scaling to be applied to this image. | |
vertScaling | float value indicating the initial vertical scaling to be applied to this image. |
NullObjectException | Thrown if owner was NULL. |
void CEGUI::Image::draw | ( | const Rect & | dest_rect, | |
float | z, | |||
const Rect & | clip_rect, | |||
const ColourRect & | colours, | |||
QuadSplitMode | quad_split_mode = TopLeftToBottomRight | |||
) | const |
Queue the image to be drawn.
dest_rect | Rect object defining the area on-screen where the Image is to be drawn. The Image will be scaled to fit the area as required. | |
z | Z-order position for the image. Positions increase "into the screen", so 0.0f is at the top of the z-order. | |
clip_rect | Rect object that defines an on-screen area that the Image will be clipped to when drawing. | |
colours | ColourRect object that describes the colour values to use for each corner of the Image. | |
quad_split_mode | One of the QuadSplitMode values specifying the way quads are split into triangles |
References CEGUI::Imageset::draw(), and CEGUI::Rect::offset().
void CEGUI::Image::draw | ( | const Vector3 & | position, | |
const Rect & | clip_rect, | |||
const colour & | top_left_colour = 0xFFFFFFFF , |
|||
const colour & | top_right_colour = 0xFFFFFFFF , |
|||
const colour & | bottom_left_colour = 0xFFFFFFFF , |
|||
const colour & | bottom_right_colour = 0xFFFFFFFF , |
|||
QuadSplitMode | quad_split_mode = TopLeftToBottomRight | |||
) | const [inline] |
Queue the image to be drawn.
position | Vector3 object containing the location where the Image is to be drawn | |
clip_rect | Rect object that defines an on-screen area that the Image will be clipped to when drawing. | |
top_left_colour | Colour (as 0xAARRGGBB value) to be applied to the top-left corner of the Image. | |
top_right_colour | Colour (as 0xAARRGGBB value) to be applied to the top-right corner of the Image. | |
bottom_left_colour | Colour (as 0xAARRGGBB value) to be applied to the bottom-left corner of the Image. | |
bottom_right_colour | Colour (as 0xAARRGGBB value) to be applied to the bottom-right corner of the Image. | |
quad_split_mode | One of the QuadSplitMode values specifying the way quads are split into triangles |
References CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, and CEGUI::Vector3::d_z.
void CEGUI::Image::draw | ( | const Vector3 & | position, | |
const Rect & | clip_rect, | |||
const ColourRect & | colours, | |||
QuadSplitMode | quad_split_mode = TopLeftToBottomRight | |||
) | const [inline] |
Queue the image to be drawn.
clip_rect | Rect object that defines an on-screen area that the Image will be clipped to when drawing. | |
colours | ColourRect object that describes the colour values to use for each corner of the Image. | |
quad_split_mode | One of the QuadSplitMode values specifying the way quads are split into triangles |
References CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, and CEGUI::Vector3::d_z.
void CEGUI::Image::draw | ( | const Vector3 & | position, | |
const Size & | size, | |||
const Rect & | clip_rect, | |||
const ColourRect & | colours, | |||
QuadSplitMode | quad_split_mode = TopLeftToBottomRight | |||
) | const [inline] |
Queue the image to be drawn.
position | Vector3 object containing the location where the Image is to be drawn | |
size | Size object describing the size that the Image is to be drawn at. | |
clip_rect | Rect object that defines an on-screen area that the Image will be clipped to when drawing. | |
colours | ColourRect object that describes the colour values to use for each corner of the Image. | |
quad_split_mode | One of the QuadSplitMode values specifying the way quads are split into triangles |
References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, and CEGUI::Vector3::d_z.
void CEGUI::Image::draw | ( | const Rect & | dest_rect, | |
float | z, | |||
const Rect & | clip_rect, | |||
const colour & | top_left_colour = 0xFFFFFFFF , |
|||
const colour & | top_right_colour = 0xFFFFFFFF , |
|||
const colour & | bottom_left_colour = 0xFFFFFFFF , |
|||
const colour & | bottom_right_colour = 0xFFFFFFFF , |
|||
QuadSplitMode | quad_split_mode = TopLeftToBottomRight | |||
) | const [inline] |
Queue the image to be drawn.
dest_rect | Rect object defining the area on-screen where the Image is to be drawn. The Image will be scaled to fit the area as required. | |
z | Z-order position for the image. Positions increase "into the screen", so 0.0f is at the top of the z-order. | |
clip_rect | Rect object that defines an on-screen area that the Image will be clipped to when drawing. | |
top_left_colour | Colour (as 0xAARRGGBB value) to be applied to the top-left corner of the Image. | |
top_right_colour | Colour (as 0xAARRGGBB value) to be applied to the top-right corner of the Image. | |
bottom_left_colour | Colour (as 0xAARRGGBB value) to be applied to the bottom-left corner of the Image. | |
bottom_right_colour | Colour (as 0xAARRGGBB value) to be applied to the bottom-right corner of the Image. | |
quad_split_mode | One of the QuadSplitMode values specifying the way quads are split into triangles |
void CEGUI::Image::draw | ( | const Vector3 & | position, | |
const Size & | size, | |||
const Rect & | clip_rect, | |||
const colour & | top_left_colour = 0xFFFFFFFF , |
|||
const colour & | top_right_colour = 0xFFFFFFFF , |
|||
const colour & | bottom_left_colour = 0xFFFFFFFF , |
|||
const colour & | bottom_right_colour = 0xFFFFFFFF , |
|||
QuadSplitMode | quad_split_mode = TopLeftToBottomRight | |||
) | const [inline] |
Queue the image to be drawn.
position | Vector3 object containing the location where the Image is to be drawn | |
size | Size object describing the size that the Image is to be drawn at. | |
clip_rect | Rect object that defines an on-screen area that the Image will be clipped to when drawing. | |
top_left_colour | Colour (as 0xAARRGGBB value) to be applied to the top-left corner of the Image. | |
top_right_colour | Colour (as 0xAARRGGBB value) to be applied to the top-right corner of the Image. | |
bottom_left_colour | Colour (as 0xAARRGGBB value) to be applied to the bottom-left corner of the Image. | |
bottom_right_colour | Colour (as 0xAARRGGBB value) to be applied to the bottom-right corner of the Image. | |
quad_split_mode | One of the QuadSplitMode values specifying the way quads are split into triangles |
References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, and CEGUI::Vector3::d_z.
Referenced by CEGUI::TreeItem::draw(), CEGUI::MouseCursor::draw(), CEGUI::ListboxTextItem::draw(), CEGUI::Font::drawTextLine(), and CEGUI::Font::drawTextLineJustified().
float CEGUI::Image::getHeight | ( | void | ) | const [inline] |
Return the pixel height of the image.
Referenced by CEGUI::FontGlyph::getHeight(), CEGUI::ImageDim::getValue_impl(), and CEGUI::PixmapFont::updateFont().
const Imageset* CEGUI::Image::getImageset | ( | void | ) | const [inline] |
Return the parent Imageset object that contains this Image.
Referenced by CEGUI::FontGlyph::getImageset(), CEGUI::FrameWindow::setEWSizingCursorImage(), CEGUI::ImageryComponent::setImage(), CEGUI::FrameComponent::setImage(), CEGUI::Window::setMouseCursor(), CEGUI::FrameWindow::setNESWSizingCursorImage(), CEGUI::FrameWindow::setNSSizingCursorImage(), and CEGUI::FrameWindow::setNWSESizingCursorImage().
const String & CEGUI::Image::getImagesetName | ( | void | ) | const |
Return the name of the Imageset that contains this Image.
References CEGUI::Imageset::getName().
Referenced by CEGUI::ImageryComponent::writeXMLToStream().
const String & CEGUI::Image::getName | ( | void | ) | const |
Point CEGUI::Image::getOffsets | ( | void | ) | const [inline] |
Return a Point object that contains the offset applied when rendering this Image.
Referenced by CEGUI::FrameComponent::render_impl().
float CEGUI::Image::getOffsetX | ( | void | ) | const [inline] |
Return the X rendering offset.
Referenced by CEGUI::PixmapFont::defineMapping(), CEGUI::FontGlyph::getRenderedAdvance(), CEGUI::ImageDim::getValue_impl(), and CEGUI::FrameComponent::render_impl().
float CEGUI::Image::getOffsetY | ( | void | ) | const [inline] |
Return the Y rendering offset.
Referenced by CEGUI::Font::drawTextLine(), CEGUI::Font::drawTextLineJustified(), CEGUI::ImageDim::getValue_impl(), CEGUI::FrameComponent::render_impl(), and CEGUI::PixmapFont::updateFont().
Size CEGUI::Image::getSize | ( | void | ) | const [inline] |
Return a Size object containing the dimensions of the Image.
Referenced by CEGUI::Tooltip::positionSelf(), CEGUI::ImageryComponent::render_impl(), and CEGUI::FrameComponent::render_impl().
const Rect & CEGUI::Image::getSourceTextureArea | ( | void | ) | const |
Return Rect describing the source texture area used by this Image.
Referenced by CEGUI::ImageDim::getValue_impl().
float CEGUI::Image::getWidth | ( | void | ) | const [inline] |
Return the pixel width of the image.
Referenced by CEGUI::PixmapFont::defineMapping(), CEGUI::FontGlyph::getRenderedAdvance(), CEGUI::ImageDim::getValue_impl(), and CEGUI::FontGlyph::getWidth().
void CEGUI::Image::writeXMLToStream | ( | XMLSerializer & | xml_stream | ) | const |
Writes an xml representation of this Image object to out_stream.
xml_stream | Stream where xml data should be output. |
References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), CEGUI::Rect::d_left, CEGUI::Rect::d_top, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Rect::getHeight(), CEGUI::Rect::getWidth(), and CEGUI::XMLSerializer::openTag().