Action.h

Go to the documentation of this file.

//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
 
#pragma once
 
#include "Utility/Math/Bezier.h"
 
class Entity;

class Action
{
public:
    Action() = default;
    Action(const Action&) = default;
    auto operator=(const Action&) -> Action& = default;
    virtual ~Action()                                 = default;
    Action(Action&& other) noexcept = default;
    auto operator=(Action&& other) noexcept -> Action& = default;
    auto operator==(const Action& other) const -> bool;
    
    Action(std::string name);
    Action(std::string name, float duration);
    Action(std::string name, float duration, const th::Bezier& bezierCurve, float initialDelay, float endingDelay);

    auto update(float dt) -> void;   
    
    virtual auto init() -> void;
    
    virtual auto execute() -> void;
    
    virtual auto end() -> void;
    
    virtual auto ActionShowMenu() -> void;
    
    virtual auto render() const -> void;
    
    auto shouldRemove() const -> bool;
 
    auto getOwner() const -> Entity*;
    auto setOwner(Entity* newObject) -> void;
    
    auto getHasInitialized() const -> bool;
    
    
    auto getHasExecuted() const -> bool;
    auto getHasEnded() const -> bool;
 
    auto isPaused() const -> bool;
    auto setPaused(bool newState) -> void;
    
    auto isBlocking() const -> bool;
    auto setBlocking(bool newState) -> void;
    
    auto setInitialDelay(float delay) -> void;
    auto setEndingDelay(float delay) -> void;
    
    auto getName() -> std::string;

    auto getCompletionPercentage() const -> float;
    
    
    // These are protected so derived Actions can access them
protected:
    
    Entity* changingObject = nullptr;
    std::string actionName = "BaseAction";
    
    auto percentageComplete() const -> float;
 
    template<typename T>
    auto lerpBasedOnTime(const T& start, const T& end) -> T
    {
        return curve.value(normalizedTime, start, end);
    }
 
private:
    float totalDuration = 0.1f;
    float currentTime = 0.f;
    
    // Age of the Action on a scale of 0-1. Note that this is after applying the curve
    float normalizedTime = 0.f;
    
    float initialDelay = 0.f;
    float endingDelay = 0.f;
    
    bool hasInitialized = false;
    bool hasExecuted = false;
    bool hasEnded = false;
    
    bool paused = false;
 
    bool blocking = false;
    
    th::Bezier curve;
};