Crazy Eddies GUI System: CEGUIInterpolator.h Source File

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

CEGUIInterpolator.h

    00001 /***********************************************************************
    00002     filename:   CEGUIInterpolator.h
    00003     created:    7/8/2010
    00004     author:     Martin Preisler
    00005
    00006     purpose:    Defines the interface for the abstract Interpolator class
    00007 *************************************************************************/
    00008 /***************************************************************************
    00009  *   Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
    00010  *
    00011  *   Permission is hereby granted, free of charge, to any person obtaining
    00012  *   a copy of this software and associated documentation files (the
    00013  *   "Software"), to deal in the Software without restriction, including
    00014  *   without limitation the rights to use, copy, modify, merge, publish,
    00015  *   distribute, sublicense, and/or sell copies of the Software, and to
    00016  *   permit persons to whom the Software is furnished to do so, subject to
    00017  *   the following conditions:
    00018  *
    00019  *   The above copyright notice and this permission notice shall be
    00020  *   included in all copies or substantial portions of the Software.
    00021  *
    00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
    00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
    00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    00028  *   OTHER DEALINGS IN THE SOFTWARE.
    00029  ***************************************************************************/
    00030 #ifndef _CEGUIInterpolator_h_
    00031 #define _CEGUIInterpolator_h_
    00032
    00033 #include "CEGUIBase.h"
    00034
    00035
    00036 // Start of CEGUI namespace section
    00037 namespace CEGUI
    00038 {
    00039
    00054 class CEGUIEXPORT Interpolator
    00055 {
    00056 public:
    00058     virtual ~Interpolator(void) {};
    00059
    00061     virtual const String& getType() const = 0;
    00062
    00063     // interpolate methods aren't const, because the interpolator could provide
    00064     // some sort of caching mechanism if converting properties is too expensive
    00065     // that it is worth it
    00066
    00070     virtual String interpolateAbsolute(const String& value1,
    00071                                        const String& value2,
    00072                                        float position) = 0;
    00073
    00077     virtual String interpolateRelative(const String& base,
    00078                                        const String& value1,
    00079                                        const String& value2,
    00080                                        float position) = 0;
    00081
    00085     virtual String interpolateRelativeMultiply(const String& base,
    00086             const String& value1,
    00087             const String& value2,
    00088             float position) = 0;
    00089
    00090 };
    00091
    00092 } // End of  CEGUI namespace section
    00093
    00094 #endif  // end of guard _CEGUIInterpolator_h_
    00095