CUButton.h

//
//  CUButton.h
//  Cornell University Game Library (CUGL)
//
//  This module provides support for a simple clickable button. The button may
//  either be represented by two images (one up and one down), or a single
//  image and two different color tints.
//
//  The button can track its own state, relieving you of having to manually
//  check mouse presses. However, it can only do this when the button is part
//  of a scene graph, as the scene graph maps mouse coordinates to screen
//  coordinates.
//
//  This class uses 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 zlib 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: Walker White
//  Version: 1/8/17
//
#ifndef __CU_BUTTON_H__
#define __CU_BUTTON_H__
#include <cugl/2d/CUNode.h>
#include <cugl/2d/CUPolygonNode.h>
#include <cugl/math/CUColor4.h>
#include <unordered_map>

namespace cugl {

#pragma mark -
#pragma mark ButtonListener

typedef std::function<void(const std::string& name, bool down)> ButtonListener;

#pragma mark -
#pragma mark Button

class Button : public Node {
protected:
    bool _down;
    std::shared_ptr<Node> _upnode;
    std::shared_ptr<Node> _downnode;
    Color4 _upcolor;
    Color4 _downcolor;
    
    bool _active;
    bool _mouse;
    Uint32 _inputkey;
    ButtonListener _listener;
    
    
public:
#pragma mark Constructors

    Button() : _down(false), _active(false), _mouse(false), _listener(nullptr) {}
    
    ~Button() {}
    
    virtual void dispose() override;
  
    virtual bool init() override {
        CUAssertLog(false,"This node does not support the empty initializer");
        return false;
    }
    
    bool init(const std::shared_ptr<Node>& up) {
        return init(up,up->getColor()*Color4::GRAY);
    }
    
    bool init(const std::shared_ptr<Node>& up, Color4 down);
    
    bool init(const std::shared_ptr<Node>& up, const std::shared_ptr<Node>& down);
    
#pragma mark Static Constructors

    static std::shared_ptr<Button> alloc(const std::shared_ptr<Node>& up) {
        std::shared_ptr<Button> node = std::make_shared<Button>();
        return (node->init(up) ? node : nullptr);
    }

    static std::shared_ptr<Button> alloc(const std::shared_ptr<Node>& up, Color4 down) {
        std::shared_ptr<Button> node = std::make_shared<Button>();
        return (node->init(up,down) ? node : nullptr);
    }

    static std::shared_ptr<Button> alloc(const std::shared_ptr<Node>& up, const std::shared_ptr<Node>& down) {
        std::shared_ptr<Button> node = std::make_shared<Button>();
        return (node->init(up,down) ? node : nullptr);
    }

#pragma mark Button State

    bool containsScreen(const Vec2& point) {
        Vec2 local = screenToNodeCoords(point);
        return Rect(Vec2::ZERO, getContentSize()).contains(local);
    }

    bool contains(float x, float y) {
        Vec2 local = screenToNodeCoords(Vec2(x,y));
        return Rect(Vec2::ZERO, getContentSize()).contains(local);
    }

    bool isDown() const { return _down; }
    
    void setDown(bool down);
    
    
#pragma mark Listeners

    bool hasListener() const { return _listener != nullptr; }
    
    const ButtonListener getListener() const { return _listener; }
    
    void setListener(ButtonListener listener) { _listener = listener; }
    
    bool removeListener();
    
    bool activate(Uint32 key);

    bool deactivate();
};

}

#endif /* __CU_BUTTON_H__ */