CEGUIImage.h

/***********************************************************************
        filename:       CEGUIImage.h
        created:        13/3/2004
        author:         Paul D Turner
        
        purpose:        Defines interface for Image 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 _CEGUIImage_h_
#define _CEGUIImage_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIRect.h"
#include "CEGUIColourRect.h"
#include "CEGUIVector.h"
#include "CEGUISize.h"
#include "CEGUIRenderer.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 Image
{
public:
        Size    getSize(void) const                     {return Size(d_scaledWidth, d_scaledHeight);}
        

        float   getWidth(void) const            {return d_scaledWidth;}


        float   getHeight(void) const           {return d_scaledHeight;}


        Point   getOffsets(void) const          {return d_scaledOffset;}


        float   getOffsetX(void) const          {return d_scaledOffset.d_x;}


        float   getOffsetY(void) const          {return d_scaledOffset.d_y;}


        const String&   getName(void) const;


        const String&   getImagesetName(void) const;

        const Imageset* getImageset(void) const {return d_owner;}

    const Rect& getSourceTextureArea(void) const;

    void draw(GeometryBuffer& buffer, const Vector2& 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
    {
        draw(buffer, Rect(position.d_x, position.d_y,
                          position.d_x + size.d_width,
                          position.d_y + size.d_height),
             clip_rect,
             ColourRect(top_left_colour, top_right_colour, bottom_left_colour,
                        bottom_right_colour),
             quad_split_mode);
    }

    void draw(GeometryBuffer& buffer, const Rect& dest_rect,
              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(buffer, dest_rect, clip_rect,
             ColourRect(top_left_colour, top_right_colour,
                        bottom_left_colour, bottom_right_colour),
             quad_split_mode);
    }

    void draw(GeometryBuffer& buffer, const Vector2& position, const Size& size,
              const Rect* clip_rect, const ColourRect& colours,
              QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
    {
        draw(buffer, Rect(position.d_x, position.d_y,
                          position.d_x + size.d_width,
                          position.d_y + size.d_height),
             clip_rect, colours, quad_split_mode);
    }

    void draw(GeometryBuffer& buffer, const Vector2& position,
              const Rect* clip_rect, const ColourRect& colours,
              QuadSplitMode quad_split_mode = TopLeftToBottomRight) const
    {
        draw(buffer, Rect(position.d_x, position.d_y,
                          position.d_x + getWidth(),
                          position.d_y + getHeight()),
             clip_rect, colours, quad_split_mode);
    }

    void draw(GeometryBuffer& buffer, const Vector2& 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
    {
        draw(buffer, Rect(position.d_x, position.d_y,
                          position.d_x + getWidth(),
                          position.d_y + getHeight()),
             clip_rect,
             ColourRect(top_left_colour, top_right_colour,
                        bottom_left_colour, bottom_right_colour),
             quad_split_mode);
    }

    void draw(GeometryBuffer& buffer, const Rect& dest_rect,
              const Rect* clip_rect, const ColourRect& colours,
              QuadSplitMode quad_split_mode = TopLeftToBottomRight) const;

    void writeXMLToStream(XMLSerializer& xml_stream) const;


        friend class std::map<String, Image, String::FastLessCompare>;
        friend struct std::pair<const String, Image>;


        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        Image(void) {}


        Image(const Imageset* owner, const String& name, const Rect& area, const Point& render_offset, float horzScaling = 1.0f, float vertScaling = 1.0f);



        Image(const Image& image);


        ~Image(void);


private:
        /*************************************************************************
                Friends
        *************************************************************************/
        friend class Imageset;

                
        /*************************************************************************
                Implementation Methods
        *************************************************************************/
        void    setHorzScaling(float factor);


        void    setVertScaling(float factor);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        const Imageset* d_owner;                
        Rect                    d_area;                 
        Point                   d_offset;               

        // image auto-scaling fields.
        float   d_scaledWidth;          
        float   d_scaledHeight;         
        Point   d_scaledOffset;         
        String  d_name;                         
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIImage_h_