CEGUIImageset.h

/***********************************************************************
        filename:       CEGUIImageset.h
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines the interface for the Imageset class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIImageset_h_
#define _CEGUIImageset_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIRect.h"
#include "CEGUIColourRect.h"
#include "CEGUIImagesetManager.h"
#include "CEGUIImage.h"
#include "CEGUIIteratorBase.h"
#include "CEGUIXMLSerializer.h" 

#include <map>


#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT Imageset
{
        friend class Imageset_xmlHandler;
private:
        typedef std::map<String, Image, String::FastLessCompare>        ImageRegistry;

        /*************************************************************************
                Friends to allow access to constructors and destructors
        *************************************************************************/
        friend Imageset*        ImagesetManager::createImageset(const String& name, Texture* texture);
        friend Imageset*        ImagesetManager::createImageset(const String& filename, const String& resourceGroup);
        friend Imageset*        ImagesetManager::createImagesetFromImageFile(const String& name, const String& filename, const String& resourceGroup);
        friend void                     ImagesetManager::destroyImageset(const String& name);


        /*************************************************************************
                Construction and Destruction (private, only ImagesetManager can 
                create and destroy Imageset objects).
        *************************************************************************/
        Imageset(const String& name, Texture* texture);


        Imageset(const String& filename, const String& resourceGroup);


    Imageset(const String& name, const String& filename, const String& resourceGroup);


public: // For luabind support
        ~Imageset(void);


public:
        typedef ConstBaseIterator<ImageRegistry>        ImageIterator;  

        /*************************************************************************
                Public interface
        *************************************************************************/
        Texture*        getTexture(void) const                                          {return d_texture;}


        const String&   getName(void) const                                             {return d_name;}


        uint      getImageCount(void) const               {return (uint)d_images.size();}

 
        bool            isImageDefined(const String& name) const        {return d_images.find(name) != d_images.end();}

 
        const Image&    getImage(const String& name) const;


        void    undefineImage(const String& name);

        void    undefineAllImages(void);


        Size    getImageSize(const String& name) const                  {return getImage(name).getSize();}


        float   getImageWidth(const String& name) const                 {return getImage(name).getWidth();}


        float   getImageHeight(const String& name) const                {return getImage(name).getHeight();}


        Point   getImageOffset(const String& name) const                {return getImage(name).getOffsets();}


        float   getImageOffsetX(const String& name) const               {return getImage(name).getOffsetX();}


        float   getImageOffsetY(const String& name) const               {return getImage(name).getOffsetY();}

        
        void    defineImage(const String& name, const Point& position, const Size& size, const Point& render_offset)
        {
                defineImage(name, Rect(position.d_x, position.d_y, position.d_x + size.d_width, position.d_y + size.d_height), render_offset);
        }


        void    defineImage(const String& name, const Rect& image_rect, const Point& render_offset);


        void    draw(const Rect& source_rect, const Rect& dest_rect, float z, const Rect& clip_rect,const ColourRect& colours, QuadSplitMode quad_split_mode) const;


        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
        {
                draw(source_rect, dest_rect, z, clip_rect, ColourRect(top_left_colour, top_right_colour, bottom_left_colour, bottom_right_colour), quad_split_mode);
        }


        bool    isAutoScaled(void) const                {return d_autoScale;}


        Size    getNativeResolution(void) const {return Size(d_nativeHorzRes, d_nativeVertRes);}


        void    setAutoScalingEnabled(bool setting);


        void    setNativeResolution(const Size& size);


        void    notifyScreenResolution(const Size& size);


        ImageIterator   getIterator(void) const;


    void writeXMLToStream(XMLSerializer& xml_stream) const;

    static void setDefaultResourceGroup(const String& resourceGroup)
        { d_defaultResourceGroup = resourceGroup; }

    static const String& getDefaultResourceGroup()
        { return d_defaultResourceGroup; }

protected:
        /*************************************************************************
                Implementation Constants
        *************************************************************************/
        static const char       ImagesetSchemaName[];                   


        /*************************************************************************
                Implementation Functions
        *************************************************************************/
        void    load(const String& filename, const String& resourceGroup);


        void    unload(void);


        void    setTexture(Texture* texture);


        void    updateImageScalingFactors(void);

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        String                  d_name;                                         
        ImageRegistry   d_images;                                       
        Texture*                d_texture;                                      
    String          d_textureFilename;          

        // auto-scaling fields
        bool    d_autoScale;                    
        float   d_horzScaling;                  
        float   d_vertScaling;                  
        float   d_nativeHorzRes;                
        float   d_nativeVertRes;                
    static String d_defaultResourceGroup;   
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIImageset_h_