RTFXProperty.h

Go to the documentation of this file.

#ifndef __RTFX_PROPERTY__
#define __RTFX_PROPERTY__



#include "RTFXBoostIncludes.h"

#include "RTFXMath.h"
#include "RTFXRecorder.h"
#include "RTFXHelpers.h"
#include "RTFXError.h"

using namespace std;

namespace RTFX
{
    class RTFXAPI RTFXProperty
    {
        public:
            enum RTFXPropertyType
            {
                BASICTYPE = 0,          
                STRING = 1,             
                CHARARRAY = 2,          
                VECTOR3 = 3,            
                POINT3 = 4,             
                MATRIX4 = 5,            
                RAWDATA = 6,            
                VECTOROF = 7,           
                COLOUR = 8,             
                BASICARRAY = 9,         
                DELETEOBJECT = 10,          
            };

            enum RTFXPropertyData
            {
                CHAR = 0,
                BOOL = 1,
                INT = 2,
                UNSIGNEDINT = 3,
                DOUBLE = 4,
                FLOAT = 5,
                DATASTRING = 6,
                UNKNOWN = 7,
            };

            RTFXProperty() 
            { 
                // verbose( ostringstream().flush() << "RTFXProperty Constructor" << endl );
                canChangeBasis = false; 
                isOwnedByObject = false;
                isChanged = false;
                name = "";
                description = "";
                id = 0;
                owner = boost::uuids::nil_uuid();
                dataType = UNKNOWN;
                isToBeDeleted = false;
                localFrame = XLEFT_YUP_ZBACKWARD;
                dataLock = new boost::mutex();
            }   

            virtual ~RTFXProperty() 
            { 
                debug( ostringstream().flush() << "RTFXProperty::Destructor: " << name << endl );
                delete dataLock;
            }

            virtual RTFXBIGINT GetLength() { return 0; }

            void SetType( RTFXPropertyType _type ) { type = _type; }

            void SetName( string _name ) { name = _name; }

            void SetOwner( boost::uuids::uuid _owner ) { owner = _owner; }

            void SetChanged( bool _changed ) { isChanged = _changed; }

            void SetDescription( string _description ) { description = _description; }

            void SetID( unsigned int _id ) { id = _id; }

            void SetDelete( bool _v ) { isToBeDeleted = _v; }

            bool GetDelete() { return isToBeDeleted; }

            void SetAll( string _name, string _description, bool _changed, unsigned int _id )
            {
                name = _name;
                description = _description;
                isChanged = _changed;
                id = _id;
            }

            RTFXPropertyType GetType() { return type; }

            string GetName() { return name; }

            boost::uuids::uuid GetOwner() { return owner; }

            bool GetChanged() { return isChanged; }

            string GetDescription() { return description; }

            unsigned int GetID() { return id; }

            virtual bool EqualTo( RTFXProperty * other ) = 0;

            virtual void ChangeFrame( AXISFRAME frameA, AXISFRAME frameB ) {};

            void SetBasis( bool _basis ){ canChangeBasis = _basis; }

            bool GetBasis() { return canChangeBasis; }

            virtual void Copy( RTFXProperty * p ) = 0;

            void SetOwnedByObject( bool _ownedByObject ) { isOwnedByObject = _ownedByObject; }

            bool GetOwnedByObject() { return isOwnedByObject; }

            RTFXPropertyData GetDataType() { return dataType; }

            void SetDataType( RTFXPropertyData _dt ) { dataType = _dt; }

            AXISFRAME GetAxis() { return localFrame; }

            void SetAxis( AXISFRAME _frame ) { localFrame = _frame; }

            static void EncodeLong( RTFXBIGINT _encodeMe, char * _data )
            {
                memcpy( _data, &_encodeMe, sizeof( RTFXBIGINT ) );
            }

            static void DecodeLong( RTFXBIGINT &_decodeTo, char * _data )
            {
                RTFXBIGINT ret_;
                memcpy( &ret_, _data, sizeof( RTFXBIGINT ) );
                _decodeTo = ret_;
            }

        protected:

            boost::mutex * dataLock;

        private:

            AXISFRAME localFrame;

            RTFXPropertyData dataType;

            bool isOwnedByObject;

            RTFXPropertyType type;

            string name;

            string description;         

            bool isChanged;

            boost::uuids::uuid owner;

            unsigned int id;

            bool canChangeBasis;

            bool isToBeDeleted;

            friend class boost::serialization::access;

            template<class Archive>
            void serialize( Archive &_ar, const unsigned int _version )
            {
                //verbose( ostringstream().flush() << "RTFXProperty::serialize" << endl );
                _ar & type & owner & id & isChanged & canChangeBasis & isToBeDeleted & name & description & isOwnedByObject & dataType;
            };
    };
    BOOST_SERIALIZATION_ASSUME_ABSTRACT( RTFXProperty );
}

#endif