Interpolator.h

/***********************************************************************
    filename:   CEGUIInterpolator.h
    created:    7/8/2010
    author:     Martin Preisler

    purpose:    Defines the interface for the abstract Interpolator class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 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 _CEGUIInterpolator_h_
#define _CEGUIInterpolator_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT Interpolator :
    public AllocatedObject<Interpolator>
{
public:
    virtual ~Interpolator() {};

    virtual const String& getType() const = 0;

    // interpolate methods aren't const, because the interpolator could provide
    // some sort of caching mechanism if converting properties is too expensive
    // that it is worth it

    virtual String interpolateAbsolute(const String& value1,
                                       const String& value2,
                                       float position) = 0;

    virtual String interpolateRelative(const String& base,
                                       const String& value1,
                                       const String& value2,
                                       float position) = 0;

    virtual String interpolateRelativeMultiply(const String& base,
            const String& value1,
            const String& value2,
            float position) = 0;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIInterpolator_h_