Mutator.h

/*

Copyright (c) 2018, Johnathan Corkery. (jcorkery@umich.edu)
All rights reserved.

This file is part of the Dynacoe project (https://github.com/jcorks/Dynacoe)
Dynacoe was released under the MIT License, as detailed below.



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 OR COPYRIGHT HOLDERS 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 H_DC_COMPONENT_MUTATOR_INCLUDED
#define H_DC_COMPONENT_MUTATOR_INCLUDED




#include <Dynacoe/Component.h>
#include <Dynacoe/Components/Clock.h>
#include <set>


struct MutationState;
class StateContainer;
namespace Dynacoe {



class Mutator : public Component {
  public:

    enum class Function {
        Constant,       
        Linear,         
        Quadratic,      
        SquareRoot,     
        Cubic,          
        Sinusoidal,     
        Logarithmic,    
        RandomDistribution  
    };

    Mutator();
    Mutator(float beginValue,float endValue, Function f, float duration);
    ~Mutator();


    void Clear(float beginValue);

    void NewMutation(float when, float value, Function travelFunction);

    void NewRandomMutation(float when, float minValue, float MaxValue, Function travelFunction);


    void SetMutationDestination(int mutationIndex, float newValue);



    void Start();
    
    void Stop();

    void Loop(bool);

    bool Expired();

    float GetCurrentTime();

    float GetEnd();

    float GetAt(float time);

    float Value();
    
    
    enum class BindFunction {
        Set, 
        Add, 
        Subtract, 
        Multiply, 
        Divide 
    };
    
    void Bind(float &,    BindFunction f = BindFunction::Set);
    void Bind(int &,      BindFunction f = BindFunction::Set);
    void Bind(uint8_t &,  BindFunction f = BindFunction::Set);
    void Bind(uint32_t &, BindFunction f = BindFunction::Set);
    void Bind(uint64_t &, BindFunction f = BindFunction::Set);
    
    void Unbind(float &);
    void Unbind(int &);
    void Unbind(uint8_t &);
    void Unbind(uint32_t &);
    void Unbind(uint64_t &);
    
    
    
    

    static float StepTowards(float current,
                             float destination,
                             float step = .5f,
                             Function f = Function::Linear);
    static Vector StepTowards(Vector current,
                             Vector destination,
                             float step = .5f,
                             Function f = Function::Linear);



    void OnStep();




    std::string GetInfo();








  private:
    struct MutationState {
        MutationState(float t, Mutator::Function f, float val, float min, float max, bool ran) :
            time(t),
            func(f),
            value(val),
            minValue(min),
            maxValue(max),
            isRandom(ran) {}
        float time;
        Mutator::Function func;
        float value;
        float minValue;
        float maxValue;
        bool isRandom;

        bool operator<(const MutationState & m) const {
            return time < m.time;
        }
    };
    class CompareMutationState {
      public:
        bool operator()(const MutationState * a, const MutationState *b) const {
            return (*a < *b);
        }
    };

    std::set<MutationState*, CompareMutationState> states;
    float begin;
    Dynacoe::Clock timer;
    bool isLooping;
    bool hasBinds;
    bool accountForLastStep;
    MutationState * registr;
    
    typedef void (*BindFunctionBase)(void *, int type, float val);
    
    std::vector<std::pair<void*, BindFunctionBase>> * bindVectors;
    
    void Bind(void *, int, BindFunction);
    void Unbind(void*, int);
    static float compute(float first, float end, Function f, float ratio);

};





}


#endif