CImageManager.hpp

Go to the documentation of this file.

#ifndef __CImageManager__
#define __CImageManager__

//  ===========================================================================

#include <Collections/TCountedPointerArray.hpp>
#include <Basics/CString.hpp>
#include "IImage.hpp"

using Exponent::Basics::CString;
using Exponent::Collections::TCountedPointerArray;
using Exponent::GUI::Graphics::IImage;

//  ===========================================================================

namespace Exponent
{
    namespace GUI
    {
        namespace Graphics
        {
            class CImageManager
            {

            public:

//  ===========================================================================

                const static char CIMAGE_MANAGER_XML_TAG_ROOT[];                            
                const static char CIMAGE_MANAGER_XML_TAG_VERSION[];                         
                const static char CIMAGE_MANAGER_XML_TAG_IMAGES[];                          
                const static char CIMAGE_MANAGER_XML_TAG_ANIMATIONS[];                      
                const static char CIMAGE_MANAGER_XML_TAG_CHILD_IMAGE[];                     
                const static char CIMAGE_MANAGER_XML_ATTRIBUTE_IMAGE_RELATIVE_PATH[];       
                const static char CIMAGE_MANAGER_XML_ATTRIBUTE_IMAGE_FILENAME[];            
                const static char CIMAGE_MANAGER_XML_ATTRIBUTE_IMAGE_NAME[];                
                const static char CIMAGE_MANAGER_XML_ATTRIBUTE_ANIMATION_FRAME_HEIGHT[];    
                const static char CIMAGE_MANAGER_XML_ATTRIBUTE_ANIMATION_NUM_FRAMES[];      
//  ===========================================================================

                class CImageReference : public CCountedObject
                {
                    EXPONENT_CLASS_DECLARATION;
                public:

//  ===========================================================================

                    CImageReference();

                    CImageReference(IImage *image, const CString &referenceName);

                    virtual ~CImageReference();

//  ===========================================================================

                    void setImage(IImage *image) { EXCHANGE_COUNTED_OBJECTS(m_image, image); }

                    void setReferenceName(const CString &referenceName) { m_referenceName = referenceName; }

//  ===========================================================================

                    IImage *getImage() { return m_image; }

                    const CString &getReferenceName() const { return m_referenceName; }

//  ===========================================================================

                protected:

//  ===========================================================================

                    IImage *m_image;                
                    CString m_referenceName;        
                };


                class CAnimationReference: public CCountedObject
                {
                    EXPONENT_CLASS_DECLARATION;
//  ===========================================================================

                public:

//  ===========================================================================

                    CAnimationReference();

                    CAnimationReference(IImage *image, const CString &referenceName, const long frameHeight, const long numberOfFrames);

                    virtual ~CAnimationReference();

//  ===========================================================================

                    void setImage(IImage *image) { m_image.setImage(image); }

                    void setReferenceName(const CString &referenceName) { m_image.setReferenceName(referenceName); }

                    void setAnimationSizes(const long frameHeight, const long numberOfFrames) { m_frameHeight = frameHeight; m_numberOfFrames = numberOfFrames; }

//  ===========================================================================

                    IImage *getImage() { return m_image.getImage(); }

                    const CString &getReferenceName() const { return m_image.getReferenceName(); }

                    void getAnimationSizes(long &frameHeight, long &numberOfFrames) { frameHeight = m_frameHeight; numberOfFrames = m_numberOfFrames; }

//  ===========================================================================

                protected:

//  ===========================================================================

                    CImageReference m_image;                                                    
                    long m_frameHeight;                                                         
                    long m_numberOfFrames;                                                      
                };

//  ===========================================================================

                static void setDefaultPathToImages(const CSystemString &defaultPath);

                static const CSystemString &getDefaultPathToImages() { return CIMAGE_MANAGER_DEFAULT_RESOURCE_PATH; }

//  ===========================================================================

                static bool addImage(const CSystemString &path, const CString &filename, const CString &referenceName);

                static bool addAnimation(const CSystemString &path, const CString &filename, const CString &referenceName, const long frameHeight, const long numberOfFrames);

//  ===========================================================================

                static bool loadFromDefinitionFile(const CSystemString &filename);

//  ===========================================================================

                static IImage *getImage(const CString &referenceName);

                static CString getReferenceNameForImage(const IImage *image);

                static IImage *getAnimation(const CString &referenceName, long &frameHeight, long &numberOfFrames);

                static CImageManager::CAnimationReference *getAnimation(const CString &referenceName);

//  ===========================================================================

                static void clearImageLibrary();

//  ===========================================================================
                
                static IImage *getImageOnPath(const CSystemString &path);

//  ===========================================================================

            protected:

//  ===========================================================================

                static bool readFromXML(const CSystemString &filename);

//  ===========================================================================

                static TCountedPointerArray<CImageReference> CIMAGE_MANAGER_IMAGES;             
                static TCountedPointerArray<CAnimationReference> CIMAGE_MANAGER_ANIMATIONS;     
                static CSystemString CIMAGE_MANAGER_DEFAULT_RESOURCE_PATH;                      
            };
        }
    }
}
#endif      // End of CImageManager.hpp

---