CoordConverter.h

/***********************************************************************
    filename:   CEGUICoordConverter.h
    created:    Sun Sep 18 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   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 _CEGUICoordConverter_h_
#define _CEGUICoordConverter_h_

#include "CEGUI/UDim.h"
#include "CEGUI/Vector.h"
#include "CEGUI/Size.h"
#include "CEGUI/Rect.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT CoordConverter
{
public:
    inline static float alignToPixels(float x)
    {
        return (float)(int)(( x ) + (( x ) > 0.0f ? 0.5f : -0.5f));
    }
    
    inline static float asAbsolute(const UDim& u, float base, bool pixelAlign = true)
    {
        return pixelAlign ? alignToPixels(base * u.d_scale + u.d_offset) : base * u.d_scale + u.d_offset;
    }

    inline static float asRelative(const UDim& u, float base)
    {
        return (base != 0.0f) ? u.d_offset / base + u.d_scale : 0.0f;
    }

    inline static Vector2f asAbsolute(const Vector2<UDim>& v, const Sizef& base, bool pixelAlign = true)
    {
        return Vector2f(asAbsolute(v.d_x, base.d_width, pixelAlign), asAbsolute(v.d_y, base.d_height, pixelAlign));
    }

    inline static Vector2f asRelative(const Vector2<UDim>& v, const Sizef& base)
    {
        return Vector2f(asRelative(v.d_x, base.d_width), asRelative(v.d_y, base.d_height));
    }

    inline static Sizef asAbsolute(const Size<UDim>& v, const Sizef& base, bool pixelAlign = true)
    {
        return Sizef(asAbsolute(v.d_width, base.d_width, pixelAlign), asAbsolute(v.d_height, base.d_height, pixelAlign));
    }

    inline static Sizef asRelative(const Size<UDim>& v, const Sizef& base)
    {
        return Sizef(asRelative(v.d_width, base.d_width), asRelative(v.d_height, base.d_height));
    }

    inline static Rectf asAbsolute(const URect& r, const Sizef& base, bool pixelAlign = true)
    {
        return Rectf(
                   asAbsolute(r.d_min.d_x, base.d_width,  pixelAlign),
                   asAbsolute(r.d_min.d_y, base.d_height, pixelAlign),
                   asAbsolute(r.d_max.d_x, base.d_width,  pixelAlign),
                   asAbsolute(r.d_max.d_y, base.d_height, pixelAlign)
               );
    }

    inline static Rectf asRelative(const URect& r, const Sizef& base)
    {
        return Rectf(
                   asRelative(r.d_min.d_x, base.d_width),
                   asRelative(r.d_min.d_y, base.d_height),
                   asRelative(r.d_max.d_x, base.d_width),
                   asRelative(r.d_max.d_y, base.d_height)
               );
    }

    static float screenToWindowX(const Window& window, const UDim& x);

    static float screenToWindowX(const Window& window, const float x);

    static float screenToWindowY(const Window& window, const UDim& y);

    static float screenToWindowY(const Window& window, const float y);

    static Vector2f screenToWindow(const Window& window, const UVector2& vec);

    static Vector2f screenToWindow(const Window& window, const Vector2f& vec);

    static Rectf screenToWindow(const Window& window, const URect& rect);

    static Rectf screenToWindow(const Window& window, const Rectf& rect);

private:
    CoordConverter();

    static float getBaseXValue(const Window& window);

    static float getBaseYValue(const Window& window);

    static Vector2f getBaseValue(const Window& window);
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUICoordConverter_h_