YiVariant.h

Go to the documentation of this file.

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

#include "framework/YiPredef.h"
#include "framework/YiAny.h"
#include "utility/YiString.h"

#include <glm/fwd.hpp>


class CYIVariant
{
public:
    enum TYPE
    {
        TYPE_INVALID,
        TYPE_FLOAT,
        TYPE_FLOAT_ARRAY,
        TYPE_FLOAT_VECTOR,
        TYPE_INT,
        TYPE_INT_ARRAY,
        TYPE_QUATERNION,
        TYPE_STRING
    };

    CYIVariant() {}
    CYIVariant(const CYIVariant &rOther) : m_any(rOther.m_any) {}
    ~CYIVariant() {}

    CYIVariant(float fValue);

    CYIVariant(const float pfValue[], uint32_t uCount);

    CYIVariant(const glm::vec3 &rvValue);
    
    CYIVariant(float fX, float fY, float fZ);

    CYIVariant(int32_t nValue);

    CYIVariant(const int32_t pnValue[], uint32_t uCount);

    CYIVariant(const glm::quat &rValue);
    
    CYIVariant(const CYIString &rsValue);

    
    void Set(float fValue);

    void Set(const float pfValue[], uint32_t uCount);

    void Set(const glm::vec3 &rvValue);

    void Set(float fX, float fY, float fZ);

    void Set(int32_t nValue);

    void Set(const int32_t pnValue[], uint32_t uCount);

    void Set(const glm::quat &rValue);

    void Set(const CYIString &rsValue);
    
    void SetInvalid();

    float GetAsFloat() const;

    const float *GetAsFloatPointer(size_t *pSize = nullptr) const;

    glm::vec3 GetAsFloatVector() const;
    
    int32_t GetAsInt() const;

    const int32_t *GetAsIntPointer(size_t *pSize = nullptr) const;

    glm::quat GetAsQuaternion() const;
    
    CYIString GetAsString() const;
    
    bool      IsValid() const;

    TYPE      GetType() const;

    bool operator+=(const CYIVariant &rOther); 
    bool operator-=(const CYIVariant &rOther); 
    bool operator*=(const CYIVariant &rOther); 
    bool operator/=(const CYIVariant &rOther); 
    CYIVariant operator+(const CYIVariant &rOther) const; 
    CYIVariant operator-(const CYIVariant &rOther) const; 
    CYIVariant operator*(const CYIVariant &rOther) const; 
    CYIVariant operator/(const CYIVariant &rOther) const; 
    
    CYIVariant LogOf() const;

    CYIVariant ExpOf() const;

    static void Lerp(const CYIVariant &start, const CYIVariant &end, float *pfPercentages, uint32_t uPercentageCount, CYIVariant &out_variant);

    int32_t GetApproximateSize() const;

private:
    friend bool operator==(const CYIVariant &rLHS, const CYIVariant &rRHS);
    friend bool operator!=(const CYIVariant &rLHS, const CYIVariant &rRHS);

    CYIAny m_any;
};

bool operator==(const CYIVariant &rLHS, const CYIVariant &rRHS); 
bool operator!=(const CYIVariant &rLHS, const CYIVariant &rRHS); 

#endif // _YI_VARIANT_H_