YiLayoutConfig.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_LAYOUT_CONFIG_H_
#define _YI_LAYOUT_CONFIG_H_

#include "binding/YiScriptableRTTIObject.h"

#include <glm/vec3.hpp>

class IYIPropertiesSource;

class CYILayoutConfig : public CYIScriptableRTTIObject
{
public:
    enum GRAVITY
    {
        GRAVITY_NONE, 
        GRAVITY_CENTER, 
        GRAVITY_LEFT, 
        GRAVITY_RIGHT, 
        GRAVITY_TOP, 
        GRAVITY_BOTTOM, 
        GRAVITY_FRONT, 
        GRAVITY_BACK, 
        GRAVITY_TOP_LEFT, 
        GRAVITY_TOP_RIGHT, 
        GRAVITY_BOTTOM_LEFT, 
        GRAVITY_BOTTOM_RIGHT 
    };

    class CubeOffset
    {
    public:
        CubeOffset() {}
        CubeOffset(float fOffset) :
            vStart(fOffset),
            vEnd(fOffset) {}
        CubeOffset(const glm::vec3 &vOffset) : vStart(vOffset), vEnd(vOffset) {}
        static const CubeOffset zeroInstance;
        static CubeOffset CreateFromPropertiesOf(const IYIPropertiesSource *pSource, const CYIString &keyPrefix, const CubeOffset &defaultValue = zeroInstance);

        glm::vec3 vStart;
        glm::vec3 vEnd;

        inline glm::vec3 GetTotal() const   { return vStart + vEnd; }
        inline float GetTotalX() const
        {
            return vStart.x + vEnd.x;
        }
        inline float GetTotalY() const
        {
            return vStart.y + vEnd.y;
        }
        inline float GetTotalZ() const
        {
            return vStart.z + vEnd.z;
        }

        inline float GetLeft() const
        {
            return vStart.x;
        }
        inline float GetRight() const
        {
            return vEnd.x;
        }
        inline float GetTop() const
        {
            return vStart.y;
        }
        inline float GetBottom() const
        {
            return vEnd.y;
        }
        inline float GetFront() const
        {
            return vStart.z;
        }
        inline float GetBack() const
        {
            return vEnd.z;
        }
    };

    typedef CubeOffset Margin;

    class SizeConstraint
    {
    public:
        SizeConstraint() : fMinimum(-1.0f), fPreferred(-1.0f), fMaximum(-1.0f), bFillParent(false), bFitContent(false) {}

        float fMinimum;
        float fPreferred;
        float fMaximum;
        bool bFillParent;
        bool bFitContent;
    };

    class SizeConstraints
    {
    public:
        SizeConstraints() : bMaintainAspectRatio(false) {}
        static const SizeConstraints defaultInstance;

        SizeConstraint width;
        SizeConstraint height;
        SizeConstraint depth;
        
        bool bMaintainAspectRatio;
    };

    CYILayoutConfig();
    virtual ~CYILayoutConfig();

    virtual void ConfigureFrom(const IYIPropertiesSource *pSource);


    void SetSizeConstraints(const SizeConstraints &sizeConstraints);

    inline const SizeConstraints &GetSizeConstraints() const;


    void SetMargin(const Margin &margin);

    inline const Margin &GetMargin() const;

    void SetLayoutable(bool bLayoutable);

    inline bool IsLayoutable() const;


    void SetItemGravity(const glm::vec3 &vItemGravity);

    void SetItemGravity(GRAVITY eItemGravity);

    inline const glm::vec3 &GetItemGravity() const;


    void SetIsBackground(bool bBackground);

    inline bool IsBackground() const;

    static void RemoveSuffixFromNumber(CYIString &inOutNumber, CYIString &outSuffix);

    static bool ParseBooleanValue(const CYIString &value);

    static float ParseFloatValue(const CYIString &value);

    static uint32_t ParseTimeValue(const CYIString &value);

    static float ParseLengthValue(const CYIString &length);

    static glm::vec3 ReadGravityFrom(const CYIString &key, const IYIPropertiesSource *pSource, const glm::vec3 &vDefault);

    static glm::vec3 GetGravityVectorFor(GRAVITY eGravity);

private:
    static void ReadSizeConstraintFrom(const IYIPropertiesSource *pSource, const CYIString &key, SizeConstraint *pConstraint);

    bool m_bLayoutable;
    bool m_bBackground;
    SizeConstraints m_sizeConstraints;
    Margin m_margin;
    glm::vec3 m_vItemGravity; 

    YI_TYPE_BASES_WITH_SCRIPTABLE_BASE(CYILayoutConfig)
};

inline const CYILayoutConfig::SizeConstraints &CYILayoutConfig::GetSizeConstraints() const
{
    return m_sizeConstraints;
}

inline const CYILayoutConfig::Margin &CYILayoutConfig::GetMargin() const
{
    return m_margin;
}

inline bool CYILayoutConfig::IsLayoutable() const
{
    return m_bLayoutable;
}

inline const glm::vec3 &CYILayoutConfig::GetItemGravity() const
{
    return m_vItemGravity;
}

bool CYILayoutConfig::IsBackground() const
{
    return m_bBackground;
}

#endif // _YI_LAYOUT_CONFIG_H_