CULayout.h

//
//  CULayout.h
//  Cornell University Game Library (CUGL)
//
//  This module provides an abstract class interface for Java-style Layout
//  managers.  This gives us more flexibility for creating scene graphs
//  on different resolution devices.
//
//
//  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: Walker White and Enze Zhou
//  Version: 1/8/18
//
#ifndef __CU_LAYOUT_H__
#define __CU_LAYOUT_H__
#include <cugl/2d/CUNode.h>
#include <cugl/assets/CUJsonValue.h>
 
namespace  cugl {
 
 
class Layout {
#pragma mark -
#pragma mark Constructors
public:
    enum class Anchor : int {
        BOTTOM_LEFT     = 0,
        MIDDLE_LEFT     = 1,
        TOP_LEFT        = 2,
        BOTTOM_CENTER   = 3,
        CENTER          = 4,
        TOP_CENTER      = 5,
        BOTTOM_RIGHT    = 6,
        MIDDLE_RIGHT    = 7,
        TOP_RIGHT       = 8,
        BOTTOM_FILL     = 9,
        MIDDLE_FILL     = 10,
        TOP_FILL        = 11,
        LEFT_FILL       = 12,
        CENTER_FILL     = 13,
        RIGHT_FILL      = 14,
        TOTAL_FILL      = 15,
        NONE            = 16
    };
    
    Layout() {}
    
    ~Layout() { dispose(); }
    
    virtual void dispose() {}
    
    virtual bool init() { return true; }
    
    virtual bool initWithData(const std::shared_ptr<JsonValue>& data) { return false; }
 
#pragma mark Layout
 
    virtual bool add(const std::string key, const std::shared_ptr<JsonValue>& data) { return false; }
    
    virtual bool remove(const std::string key) { return false; }
    
    virtual void layout(Node* node) {}
    
#pragma mark Layout Helpers
 
    static Anchor getAnchor(const std::string& x_anchor, const std::string& y_anchor);
    
    static void placeNode(Node* node, Anchor anchor, const Rect& bounds, const Vec2& offset);
    
    static void reanchor(Node* node, Anchor anchor);
 
};
 
}
#endif /* __CU_LAYOUT_H__ */