|
Crazy Eddies GUI System 0.7.6
|
Class providing a shared library of Imageset objects to the system. More...
Inheritance diagram for CEGUI::ImagesetManager:
Collaboration diagram for CEGUI::ImagesetManager:Public Types | |
|
typedef ConstBaseIterator < ObjectRegistry > | ImagesetIterator |
| ImagesetIterator type definition. | |
Public Member Functions | |
| ImagesetManager () | |
| Constructor for ImagesetManager objects. | |
| ~ImagesetManager () | |
| Destructor for ImagesetManager objects. | |
| Imageset & | create (const String &name, Texture &texture, XMLResourceExistsAction action=XREA_RETURN) |
| Create a Imageset object with the given name and Texture. | |
| Imageset & | createFromImageFile (const String &name, const String &filename, const String &resourceGroup="", XMLResourceExistsAction action=XREA_RETURN) |
| Create an Imageset object from the specified image file. The Imageset will initially have a single image defined named "full_image" which is an image that represents the entire area of the loaded image. | |
| void | notifyDisplaySizeChanged (const Size &size) |
| Notify the ImagesetManager that the display size may have changed. | |
| void | writeImagesetToStream (const String &imageset, OutStream &out_stream) const |
| Writes a full XML imageset for the specified Imageset to the given OutStream. | |
| ImagesetIterator | getIterator () const |
| Return a ImagesetManager::ImagesetIterator object to iterate over the available Imageset objects. | |
Class providing a shared library of Imageset objects to the system.
The ImagesetManager is used to create, access, and destroy Imageset objects. The idea is that the ImagesetManager will function as a central repository for imagery used within the GUI system, and that such imagery can be accessed, via a unique name, by any interested party within the system.
| Imageset& CEGUI::ImagesetManager::create | ( | const String & | name, |
| Texture & | texture, | ||
| XMLResourceExistsAction | action = XREA_RETURN |
||
| ) |
Create a Imageset object with the given name and Texture.
The created Imageset will be of limited use, and will require one or more images to be defined for the set.
| name | String object containing the unique name for the Imageset being created. |
| texture | Texture object to be associated with the Imageset |
| action | One of the XMLResourceExistsAction enumerated values indicating what action should be taken when an Imageset with the specified name already exists. |
| AlreadyExistsException | thrown if an Imageset named name is already present in the system. |
| Imageset& CEGUI::ImagesetManager::createFromImageFile | ( | const String & | name, |
| const String & | filename, | ||
| const String & | resourceGroup = "", |
||
| XMLResourceExistsAction | action = XREA_RETURN |
||
| ) |
Create an Imageset object from the specified image file. The Imageset will initially have a single image defined named "full_image" which is an image that represents the entire area of the loaded image.
| name | String object containing the unique name for the Imageset being created. |
| filename | String object holding the name of the image file to be loaded. |
| resourceGroup | Resource group identifier to be passed to the resource manager when loading the image file. |
| action | One of the XMLResourceExistsAction enumerated values indicating what action should be taken when an Imageset with the specified name already exists. |
| AlreadyExistsException | thrown if an Imageset named name is already present in the system. |
| FileIOException | thrown if something goes wrong while reading the image file filename. |
| void CEGUI::ImagesetManager::notifyDisplaySizeChanged | ( | const Size & | size | ) |
Notify the ImagesetManager that the display size may have changed.
| size | Size object describing the display resolution |
1.7.4