Collaboration diagram for CEGUI::Imageset:
Public Types | |
typedef ConstBaseIterator< ImageRegistry > | ImageIterator |
Iterator type for this collection. | |
Public Member Functions | |
~Imageset (void) | |
Destroys Imageset objects. | |
Texture * | getTexture (void) const |
return Texture object for this Imageset | |
const String & | getName (void) const |
return String object holding the name of the Imageset | |
uint | getImageCount (void) const |
return number of images defined for this Imageset | |
bool | isImageDefined (const String &name) const |
return true if an Image with the specified name exists. | |
const Image & | getImage (const String &name) const |
return a copy of the Image object for the named image | |
void | undefineImage (const String &name) |
remove the definition for the Image with the specified name. If no such Image exists, nothing happens. | |
void | undefineAllImages (void) |
Removes the definitions for all Image objects currently defined in the Imageset. | |
Size | getImageSize (const String &name) const |
return a Size object describing the dimensions of the named image. | |
float | getImageWidth (const String &name) const |
return the width of the named image. | |
float | getImageHeight (const String &name) const |
return the height of the named image. | |
Point | getImageOffset (const String &name) const |
return the rendering offsets applied to the named image. | |
float | getImageOffsetX (const String &name) const |
return the x rendering offset for the named image. | |
float | getImageOffsetY (const String &name) const |
return the y rendering offset for the named image. | |
void | defineImage (const String &name, const Point &position, const Size &size, const Point &render_offset) |
Define a new Image for this Imageset. | |
void | defineImage (const String &name, const Rect &image_rect, const Point &render_offset) |
Define a new Image for this Imageset. | |
void | draw (const Rect &source_rect, const Rect &dest_rect, float z, const Rect &clip_rect, const ColourRect &colours, QuadSplitMode quad_split_mode) const |
Queues an area of the associated Texture the be drawn on the screen. Low-level routine to be used carefully! | |
void | draw (const Rect &source_rect, 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 |
Queues an area of the associated Texture the be drawn on the screen. Low-level routine to be used carefully! | |
bool | isAutoScaled (void) const |
Return whether this Imageset is auto-scaled. | |
Size | getNativeResolution (void) const |
Return the native display size for this Imageset. This is only relevant if the Imageset is being auto-scaled. | |
void | setAutoScalingEnabled (bool setting) |
Enable or disable auto-scaling for this Imageset. | |
void | setNativeResolution (const Size &size) |
Set the native resolution for this Imageset. | |
void | notifyScreenResolution (const Size &size) |
Notify the Imageset of the current (usually new) display resolution. | |
ImageIterator | getIterator (void) const |
Return an Imageset::ImageIterator object that can be used to iterate over the Image objects in the Imageset. | |
void | writeXMLToStream (OutStream &out_stream) const |
Writes an xml representation of this Imageset to out_stream. | |
Protected Member Functions | |
void | load (const String &filename, const String &resourceGroup) |
Initialise the Imageset with information taken from the specified file. | |
void | unload (void) |
Unloads all loaded data and leaves the Imageset in a clean (but un-usable) state. This should be called for cleanup purposes only. | |
void | setTexture (Texture *texture) |
set the Texture object to be used by this Imageset. Changing textures on an Imageset that is in use is not a good idea! | |
void | updateImageScalingFactors (void) |
Sets the scaling factor for all Images that are a part of this Imageset. | |
Protected Attributes | |
String | d_name |
Holds the name of this imageset. | |
ImageRegistry | d_images |
Registry of Image objects for the images defined for this Imageset. | |
Texture * | d_texture |
Texture object that handles imagery for this Imageset. | |
String | d_textureFilename |
String holding the name of the texture filename (if any). | |
bool | d_autoScale |
true when auto-scaling is enabled. | |
float | d_horzScaling |
current horizontal scaling factor. | |
float | d_vertScaling |
current vertical scaling factor. | |
float | d_nativeHorzRes |
native horizontal resolution for this Imageset. | |
float | d_nativeVertRes |
native vertical resolution for this Imageset. | |
Static Protected Attributes | |
static const char | ImagesetSchemaName [] = "Imageset.xsd" |
Filename of the XML schema used for validating Imageset files. | |
Friends | |
class | Imageset_xmlHandler |
Imageset * | ImagesetManager::createImageset (const String &name, Texture *texture) |
Imageset * | ImagesetManager::createImageset (const String &filename, const String &resourceGroup) |
Imageset * | ImagesetManager::createImagesetFromImageFile (const String &name, const String &filename, const String &resourceGroup) |
void | ImagesetManager::destroyImageset (const String &name) |
Imageset objects are a means by which a single graphical image (file, Texture, etc), can be split into a number of 'components' which can later be accessed via name. The components of an Imageset can queried for various details, and sent to the Renderer object for drawing.
|
Define a new Image for this Imageset.
|
|
Define a new Image for this Imageset.
|
|
Queues an area of the associated Texture the be drawn on the screen. Low-level routine to be used carefully!
|
|
Queues an area of the associated Texture the be drawn on the screen. Low-level routine to be used carefully!
|
|
return a copy of the Image object for the named image
|
|
return number of images defined for this Imageset
|
|
return the height of the named image.
|
|
return the rendering offsets applied to the named image.
|
|
return the x rendering offset for the named image.
|
|
return the y rendering offset for the named image.
|
|
return a Size object describing the dimensions of the named image.
|
|
return the width of the named image.
|
|
return String object holding the name of the Imageset
|
|
Return the native display size for this Imageset. This is only relevant if the Imageset is being auto-scaled.
|
|
return Texture object for this Imageset
|
|
Return whether this Imageset is auto-scaled.
|
|
return true if an Image with the specified name exists.
|
|
Initialise the Imageset with information taken from the specified file.
|
|
Notify the Imageset of the current (usually new) display resolution.
|
|
Enable or disable auto-scaling for this Imageset.
|
|
Set the native resolution for this Imageset.
|
|
set the Texture object to be used by this Imageset. Changing textures on an Imageset that is in use is not a good idea!
|
|
Removes the definitions for all Image objects currently defined in the Imageset.
|
|
remove the definition for the Image with the specified name. If no such Image exists, nothing happens.
|
|
Sets the scaling factor for all Images that are a part of this Imageset.
|
|
Writes an xml representation of this Imageset to out_stream.
|