ISFVal.hpp

Go to the documentation of this file.

#ifndef ISFVal_h
#define ISFVal_h

#include "VVISF_Base.hpp"
#include "VVISF_StringUtils.hpp"

namespace VVISF
{


using namespace std;


enum ISFValType {
    ISFValType_None,    
    ISFValType_Event,   
    ISFValType_Bool,    
    ISFValType_Long,    
    ISFValType_Float,   
    ISFValType_Point2D, 
    ISFValType_Color,   
    ISFValType_Cube,    
    ISFValType_Image,   
    ISFValType_Audio,   
    ISFValType_AudioFFT 
};
string StringFromISFValType(const ISFValType & n);
inline bool ISFValTypeUsesImage(const ISFValType & n) { return (n==ISFValType_Cube || n==ISFValType_Image || n==ISFValType_Audio || n==ISFValType_AudioFFT); }



struct VVISF_EXPORT ISFVal  {
    private:
        //  this union stores the value of an ISFVal (the member of the union used depends on the ISFVal's 'type' member)
        union ISFValUnion {
            bool        boolVal;
            int32_t     longVal;
            double      floatVal;
            double      pointVal[2];
            double      colorVal[4];
        };
        ISFValType      _type = ISFValType_None;
        ISFValUnion     _val = { false };
        VVGL::GLBufferRef       _imageVal = nullptr;    //  we store the GLBufferRef as a member of the struct because storing it in the union didn't work out (a variant might work, but that has to wait to c++17)
    
    public:
        
        
        
        //  Returns a null-type ISFVal
        ISFVal();
        //  Returns an ISFVal with the passed type, and the default/unpopulated value for that type.
        ISFVal(const ISFValType & inType) : _type(inType) {}
        //  Returns an ISFVal of the passed type with the passed bool value.
        ISFVal(const ISFValType & inType, const bool & inBool);
        //  Returns an ISFVal of the passed type with the passed long value.
        ISFVal(const ISFValType & inType, const int32_t & inLong);
        //  Returns an ISFVal of the passed type with the passed float value.
        ISFVal(const ISFValType & inType, const double & inFloat);
        //  Returns an ISFVal of the passed type populated with the two passed values.  Works well for 2d points.
        ISFVal(const ISFValType & inType, const double & inX, const double & inY);
        ISFVal(const ISFValType & inType, const double * inXY, const size_t inSizeToCopy);
        //  Returns an ISFVal of the passed type populated with the four passed values.  Works well for colors.
        ISFVal(const ISFValType & inType, const double & inR, const double & inG, const double & inB, const double & inA);
        //  Returns an ISFVal of the passed type with the passed image value.  Works well for image-, audio-, and audioFFT-type values.
        ISFVal(const ISFValType & inType, const VVGL::GLBufferRef & inImage);
        
        
        

        
        inline ISFValType type() const { return _type; }
        double getDoubleVal() const;
        bool getBoolVal() const;
        int32_t getLongVal() const;
        inline double * getPointValPtr() { if (_type!=ISFValType_Point2D) return nullptr; return &(_val.pointVal[0]); }
        inline double getPointValByIndex(const int & inIndex) { if (_type!=ISFValType_Point2D || inIndex<0 || inIndex>1) return 0.; return _val.pointVal[inIndex]; }
        inline void setPointValByIndex(const int & inIndex, const double & inVal) { if (_type!=ISFValType_Point2D || inIndex<0 || inIndex>1) return; _val.pointVal[inIndex]=inVal; }
        inline double * getColorValPtr() { if (_type!=ISFValType_Color) return nullptr; return &(_val.colorVal[0]); }
        inline double getColorValByChannel(const int & inIndex) { if (_type!=ISFValType_Color || inIndex<0 || inIndex>3) return 0.; return _val.colorVal[inIndex]; }
        inline void setColorValByChannel(const int & inIndex, const double & inVal) { if (_type!=ISFValType_Color || inIndex<0 || inIndex>3) return; _val.colorVal[inIndex]=inVal; }
        VVGL::GLBufferRef imageBuffer() const;
        void setImageBuffer(const VVGL::GLBufferRef & n);
        string getTypeString() const;
        string getValString() const;
        
        
        
        
        inline bool isNullVal() const { return (_type == ISFValType_None); }
        inline bool isEventVal() const { return (_type == ISFValType_Event); }
        inline bool isBoolVal() const { return (_type == ISFValType_Bool); }
        inline bool isLongVal() const { return (_type == ISFValType_Long); }
        inline bool isFloatVal() const { return (_type == ISFValType_Float); }
        inline bool isPoint2DVal() const { return (_type == ISFValType_Point2D); }
        inline bool isColorVal() const { return (_type == ISFValType_Color); }
        inline bool isCubeVal() const { return (_type == ISFValType_Cube); }
        inline bool isImageVal() const { return (_type == ISFValType_Image); }
        inline bool isAudioVal() const { return (_type == ISFValType_Audio); }
        inline bool isAudioFFTVal() const { return (_type == ISFValType_AudioFFT); }
        
        
        friend ostream & operator<<(ostream & os, const ISFVal & n) { os << VVGL::FmtString("<ISFVal %s/%s>", n.getTypeString().c_str(), n.getValString().c_str()); return os; }
};



VVISF_EXPORT ISFVal ISFNullVal();
VVISF_EXPORT ISFVal ISFEventVal(const bool & n=false);
VVISF_EXPORT ISFVal ISFBoolVal(const bool & n);
VVISF_EXPORT ISFVal ISFLongVal(const int32_t & n);
VVISF_EXPORT ISFVal ISFFloatVal(const double & n);
VVISF_EXPORT ISFVal ISFPoint2DVal(const double & inX, const double & inY);
VVISF_EXPORT ISFVal ISFColorVal(const double & inR, const double & inG, const double & inB, const double & inA);
VVISF_EXPORT ISFVal ISFImageVal(const VVGL::GLBufferRef & n);




}


#endif /* ISFVal_h */