CL_Easings.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        CL_Easings.h ( Clip Library, C++)
 *
 * COMMENTS:
 *    Applies Easings to input data
 */


#ifndef __CL_Easings__
#define __CL_Easings__

#include "CL_API.h"
#include <SYS/SYS_Types.h>
#include <SYS/SYS_Math.h>

enum class CL_EasingType
{
    CL_IN,
    CL_OUT,
    CL_INOUT    
};

// static methods to do easings. These functions expect the input to be 
// between 0-1

class CL_API CL_Easings
{
public:

    static fpreal sine(const fpreal input, const CL_EasingType type);

    static fpreal pow(const fpreal input, const fpreal exponent, 
                      const CL_EasingType);
    
    static fpreal quad(const fpreal input, const CL_EasingType type)
    {
        return pow(input, 2, type);
    }
    static fpreal cubic(const fpreal input, const CL_EasingType type)
    {
        return pow(input, 3, type);
    }

    static fpreal quart(const fpreal input, const CL_EasingType type)
    {
        return pow(input, 4, type);
    }
    
    static fpreal quint(const fpreal input, const CL_EasingType type)
    {
        return pow(input, 5, type);
    }

    static fpreal exp(const fpreal input, const CL_EasingType type);

    static fpreal circ(const fpreal input, const CL_EasingType type);

    static fpreal back(const fpreal input, const CL_EasingType type);

    static fpreal elastic(const fpreal input, const CL_EasingType type);

    static fpreal bounce(const fpreal input, const CL_EasingType type);
    
};

#endif