CUFadeAction.h

//
//  CUFadeAction.h
//  Cornell University Game Library (CUGL)
//
//  This module provides support for the fading actions.  This includes fading
//  in and out.  Because they are absolute notions, these actions have no
//  addition state to them (as is the case with other actions)
//
//  These classes use our standard shared-pointer architecture.
//
//  1. The constructor does not perform any initialization; it just sets all
//     attributes to their defaults.
//
//  2. All initialization takes place via init methods, which can fail if an
//     object is initialized more than once.
//
//  3. All allocation takes place via static constructors which return a shared
//     pointer.
//
//  CUGL MIT License:
//      This software is provided 'as-is', without any express or implied
//      warranty.  In no event will the authors be held liable for any damages
//      arising from the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose,
//      including commercial applications, and to alter it and redistribute it
//      freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; you must not
//      claim that you wrote the original software. If you use this software
//      in a product, an acknowledgment in the product documentation would be
//      appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, and must not
//      be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//  Author: Sophie Huang and Walker White
//  Version: 3/12/17
//
#ifndef __CU_FADE_ACTION_H__
#define __CU_FADE_ACTION_H__

#include "CUAction.h"

namespace cugl {
    
class FadeOut : public Action {
public:
#pragma mark Constructors

    FadeOut() {}
    
    ~FadeOut() { dispose(); }
    
    void dispose() {}
    
    bool init() {
        return init(0.0f);
    }

    bool init(float time);

#pragma mark Static Constructors

    static std::shared_ptr<FadeOut> alloc() {
        std::shared_ptr<FadeOut> result = std::make_shared<FadeOut>();
        return (result->init() ? result : nullptr);
    }
    
    static std::shared_ptr<FadeOut> alloc(float time) {
        std::shared_ptr<FadeOut> result = std::make_shared<FadeOut>();
        return (result->init(time) ? result : nullptr);
    }

#pragma mark Animation Methods

    virtual std::shared_ptr<Action> clone() override;
    
    virtual void load(const std::shared_ptr<Node>& target, Uint64* state) override;
    
    virtual void update(const std::shared_ptr<Node>& target, Uint64* state, float dt) override;
    
#pragma mark Debugging Methods

    virtual std::string toString(bool verbose = false) const override;
};

    
#pragma mark -

class FadeIn : public Action {
public:
#pragma mark Constructors

    FadeIn() {}
    
    ~FadeIn() { dispose(); }
    
    void dispose() {}
    
    bool init() {
        return init(0.0f);
    }
    
    bool init(float time);

#pragma mark Static Constructors

    static std::shared_ptr<FadeIn> alloc() {
        std::shared_ptr<FadeIn> result = std::make_shared<FadeIn>();
        return (result->init() ? result : nullptr);
    }
    
    static std::shared_ptr<FadeOut> alloc(float time) {
        std::shared_ptr<FadeOut> result = std::make_shared<FadeOut>();
        return (result->init(time) ? result : nullptr);
    }
    
#pragma mark Animation Methods

    virtual std::shared_ptr<Action> clone() override;
    
    virtual void load(const std::shared_ptr<Node>& target, Uint64* state) override;
    
    virtual void update(const std::shared_ptr<Node>& target, Uint64* state, float dt) override;
    
#pragma mark Debugging Methods

    virtual std::string toString(bool verbose = false) const override;
};
    
}

#endif /* CUFadeAction_h */