kfbxproperty.h

Go to the documentation of this file.

#ifndef _KFbxProperty_h
#define _KFbxProperty_h

/**************************************************************************************

 Copyright © 2004 - 2007 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material
 (collectively the "Data") in these files contain unpublished information
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by
 Canada and United States of America federal copyright law and by international
 treaties.

 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE,
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE.
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE.

 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE.

**************************************************************************************/

#include <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#ifndef MB_FBXSDK
#include <kbaselib_nsuse.h>
#endif
#include <kbaselib_forward.h>

#include <klib/kstring.h>
#include <kfbxplugins/kfbxplug.h>
#include <kfbxplugins/kfbxtypes.h>
#include <kfcurve/kfcurvenode.h>
#include <fbxfilesdk_nsbegin.h>

    class KFbxObject;

    class KFbxColor;
    class KFbxObject;
    class KFbxObject_internal;
    class KFbxProperty_internal;
    class KFbxSdkManager;

    class KFBX_DLL KFbxProperty : public KFbxPlug
    {
        KFBXPLUG_DECLARE(KFbxProperty);

        public:
            static KFbxProperty Create(KFbxObject* pObject, char const* pName, KFbxDataType const &pDataType=KFbxDataType(), char const* pLabel="");

            static KFbxProperty Create(KFbxObject* pObject, KFbxProperty& pFromProperty);

            static KFbxProperty Create(KFbxProperty const &pCompoundProperty, char const* pName, KFbxDataType const &pDataType=KFbxDataType(), char const* pLabel="");

            KFbxProperty const & StaticInit(KFbxObject* pObject, char const* pName, KFbxDataType const &pDataType, char const* pLabel);

            void Destroy(bool pRecursive = true, bool pDependents = false);

            KFbxProperty();

            KFbxProperty(KFbxProperty const &pProperty);

            ~KFbxProperty();

        public:

        public:
            KFbxDataType        GetPropertyDataType() const;

            KString             GetName() const;

            KString             GetLabel(bool pReturnNameIfEmpty=true);


            void                SetLabel(KString pLabel);

            KFbxObject*         GetFbxObject();

            void                SetUserTag(int pTag);
            int                 GetUserTag();


            typedef enum
            {
                eNO_FLAG    = 0,
                eANIMATABLE = 1, 
                eUSER       = 1<<1,
                eTEMPORARY  = 1<<2,  // System property
                ePUBLISHED  = 1<<3, 
                eSTATIC     = 1<<4, 
            } EFlags;

            void                ModifyFlag(EFlags pFlag, bool pValue);

            bool                GetFlag(EFlags pFlag);

        KFbxProperty &      operator=  (KFbxProperty const &pKProperty);
        bool                operator==(KProperty const* pKProperty) const;
        bool                operator== (KFbxProperty const &pKProperty) const;
        bool                operator!= (KFbxProperty const &pKProperty) const;
        bool CompareValue(KFbxProperty const& pProp) const;

        bool CopyValue(KFbxProperty const& pProp);


            bool            IsValid() const; 

            bool Set(void const *pValue,EFbxType pValueType);

            bool Get(void *pValue,EFbxType pValueType) const;

            // usefull set and get functions
            template <class T> inline bool  Set( T const &pValue )  { return Set( &pValue,FbxTypeOf(pValue) ); }
            template <class T> inline T     Get( T const *pFBX_TYPE) const { T lValue; Get( &lValue,FbxTypeOf(lValue) ); return lValue; }
//          template <class T> inline T     Get( T *pValue) const           { T lValue; Get( &lValue,FbxTypeOf(lValue) ); if (pValue) { *pValue= lValue; } return lValue; }

            void                SetMinLimit(double pMin);

            double              GetMinLimit();

            void                SetMaxLimit(double pMax);
            double              GetMaxLimit();

            void                SetLimits(double pMin, double pMax);

            int                 AddEnumValue(char const *pStringValue);

            void                InsertEnumValue(int pIndex, char const *pStringValue);

            int                 GetEnumCount();

            void                SetEnumValue(int pIndex, char const *pStringValue);

            void                RemoveEnumValue(int pIndex);

            char *              GetEnumValue(int pIndex);

            int             GetPropertyCount();
            KFbxProperty    GetProperty(int pIndex);

            bool            SetArraySize( int pSize, bool pVariableArray );
            int             GetArraySize();
            KFbxProperty    GetArrayItem(int pIndex);
            inline KFbxProperty operator[](int pIndex) { return GetArrayItem(pIndex); }

            KFCurveNode* CreateKFCurveNode(const char* pTakeName=NULL);

            KFCurveNode* GetKFCurveNode(bool pCreateAsNeeded=false, const char* pTakeName=NULL);
            


            // Properties
            inline int          GetSrcPropertyCount     ()                                      { return GetFbxSrcCount(KFbxProperty::ClassId); }
            inline KFbxProperty GetSrcProperty          (int pIndex=0)                          { return *((KFbxProperty *)GetFbxSrc(pIndex,KFbxProperty::ClassId)); }
            inline KFbxProperty FindSrcProperty         (const char *pName,int pStartIndex=0)   { return *((KFbxProperty *)FindFbxSrc(pName,KFbxProperty::ClassId,pStartIndex)); }
            inline bool         ConnectSrcProperty      (KFbxProperty const & pProperty)        { return ConnectFbxSrc((KFbxPlug *)&pProperty);     }
            inline bool         IsConnectedSrcProperty      (KFbxProperty const & pProperty)    { return IsConnectedFbxSrc((KFbxPlug *)&pProperty); }
            inline bool         DisconnectSrcProperty   (KFbxProperty const & pProperty)        { return DisconnectFbxSrc((KFbxPlug *)&pProperty);  }

            inline int          GetDstPropertyCount     ()                                      { return GetFbxDstCount(KFbxProperty::ClassId); }
            inline KFbxProperty GetDstProperty          (int pIndex=0)                          { return *((KFbxProperty *)GetFbxDst(pIndex,KFbxProperty::ClassId)); }
            inline KFbxProperty FindDstProperty         (const char *pName,int pStartIndex=0)   { return *((KFbxProperty *)FindFbxDst(pName,KFbxProperty::ClassId,pStartIndex)); }
            inline bool         ConnectDstProperty      (KFbxProperty const & pProperty)        { return ConnectFbxDst((KFbxPlug *)&pProperty);     }
            inline bool         IsConnectedDstProperty  (KFbxProperty const & pProperty)        { return IsConnectedFbxDst((KFbxPlug *)&pProperty); }
            inline bool         DisconnectDstProperty   (KFbxProperty const & pProperty)        { return DisconnectFbxDst((KFbxPlug *)&pProperty);  }

        virtual void  SetUserDataPtr(void* pUserData);
        virtual void* GetUserDataPtr();


        // Deprecated function calls
        typedef enum {   eUNIDENTIFIED,eBOOL,eREAL,eCOLOR,eINTEGER,eVECTOR,eLIST, eMATRIX} EUserPropertyType;

//      K_DEPRECATED static             KFbxProperty Create(KFbxSdkManager& pManager, char const* pName, KFbxDataType const &pDataType=KFbxDataType(), char const* pLabel="");
        K_DEPRECATED static char*       GetPropertyTypeName(EUserPropertyType pType);
        K_DEPRECATED char *             GetPropertyTypeName();
        K_DEPRECATED EUserPropertyType  GetPropertyType();

        K_DEPRECATED void               SetDefaultValue(bool pValue);
        K_DEPRECATED void               SetDefaultValue(double pValue);
        K_DEPRECATED void               SetDefaultValue(KFbxColor& pValue);
        K_DEPRECATED void               SetDefaultValue(int pValue);
        K_DEPRECATED void               SetDefaultValue(double pValue1, double pValue2, double pValue3);
        K_DEPRECATED void               GetDefaultValue(bool& pValue);
        K_DEPRECATED void               GetDefaultValue(double& pValue);
        K_DEPRECATED void               GetDefaultValue(KFbxColor& pValue);
        K_DEPRECATED void               GetDefaultValue(int& pValue);
        K_DEPRECATED void               GetDefaultValue(double& pValue1, double& pValue2, double& pValue3);

        //
        //  WARNING!
        //
        //  Anything beyond these lines may not be documented accurately and is 
        //  subject to change without notice.
        //
        #ifndef DOXYGEN_SHOULD_SKIP_THIS
        protected:
             /* The pLabel parameter is defined for backward compatibility. Older FBX files
                saved it along with the other attributes. Now, the label attribute exists only while
                the property object is in memory and is lost when saving to the FBX file.
              */

            static KFbxProperty* Create(KFbxSdkManager& pManager, KProperty* pProperty);
            KFbxProperty(KFbxSdkManager& pManager, KProperty* pProperty);
            KFbxProperty(KFbxSdkManager& pManager, char const* pName, KFbxDataType const &pDataType=KFbxDataType(), char const* pLabel="");
            KFbxProperty(KFbxObject* pObject, char const* pName, KFbxDataType const &pDataType=KFbxDataType(), char const* pLabel="");
            KFbxProperty(KFbxProperty_internal *pPropertyInfo);

            void Init(KFbxSdkManager& pManager, char const* pName, KFbxDataType const &pDataType=KFbxDataType(), char const* pLabel="");

            // Virtual plug overides
            virtual KFbxSdkManager*     GetFbxSdkManager();
            virtual KPlug*              GetInternalPlug(bool pCreateOnDemand=false);
            virtual KPlug const*        GetInternalPlug(bool pCreateOnDemand=false) const;
            bool                        CreateKProperty();
            bool                        DestroyKProperty();
            KProperty*                  GetKProperty();
            bool                        FbxPlugNotify(KFbxPlugEvent const &pEvent);

            void                        SetFbxObject(KFbxObject* pKFbxObject);

//          void                        SetKFbxObject_internal(KFbxObject_internal* pKFbxObject_internal);

            private:
                KFbxProperty_internal* mData;

            // Needed internal 
            friend class KFbxObject;
            friend class KFbxTakeNodeContainer;
            friend class KFbxObject_internal;
            friend class KFbxReaderFbx;

        #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 
    };

    typedef KFbxProperty* HKFbxProperty;

    template <class T> inline bool  KFbxSet( KFbxProperty &pProperty,T const &pValue )  { return pProperty.Set( &pValue,FbxTypeOf(pValue) ); }
    template <class T> inline bool  KFbxGet( KFbxProperty const& pProperty,T &pValue )      { return pProperty.Get( &pValue,FbxTypeOf(pValue) ); }
    template <class T> inline T     KFbxGet( KFbxProperty const& pProperty)                 { T pValue; pProperty.Get( &pValue,FbxTypeOf(pValue) ); return pValue; }

    template <class T> class KFbxTypedProperty : public KFbxProperty {
        public:
            inline KFbxTypedProperty() : KFbxProperty()                                         {}
            inline KFbxTypedProperty(KFbxProperty const &pProperty) : KFbxProperty(pProperty)   {}
            inline ~KFbxTypedProperty()                                                         {}

            inline KFbxProperty const & StaticInit(KFbxObject* pObject, char const* pName,EFlags pFlags=eNO_FLAG) 
            {
                KFbxProperty::StaticInit(pObject, pName, GetFbxDataType(FbxTypeOf(*((T *)0))), "");
                ModifyFlag(pFlags, true);
                return *this;
            }
            inline KFbxProperty const & StaticInit(KFbxObject* pObject, char const* pName,T const &pValue,EFlags pFlags=eNO_FLAG) 
            {
                KFbxProperty::StaticInit(pObject, pName, GetFbxDataType(FbxTypeOf(*((T *)0))), "");
                Set(pValue);
                ModifyFlag(pFlags, true);
                return *this;
            }

            inline KFbxProperty const & StaticInit(KFbxObject* pObject, char const* pName, KFbxDataType const &pDataType,EFlags pFlags=eNO_FLAG) 
            {
                KFbxProperty::StaticInit(pObject, pName, pDataType, "");
                ModifyFlag(pFlags, true);
                return *this;
            }
            inline KFbxProperty const & StaticInit(KFbxObject* pObject, char const* pName, KFbxDataType const &pDataType,T const &pValue,EFlags pFlags=eNO_FLAG)
            {
                KFbxProperty::StaticInit(pObject, pName, pDataType, "");
                Set(pValue);
                ModifyFlag(pFlags, true);
                return *this;
            }
        public:
            KFbxTypedProperty &operator =(T const &pValue)      { KFbxSet(*this,pValue); return *this; }
            bool     Set(T const &pValue)   { return KFbxSet(*this,pValue); }
            T        Get() const            { T lValue; KFbxGet(*this,lValue); return lValue; }

        friend class KFbxObject;
    };

    // For use with deprecated type functions 
    KFbxDataType                        EUserPropertyTypeToDataType(KFbxProperty::EUserPropertyType);
    KFbxProperty::EUserPropertyType     DataTypeToEUserPropertyType(const KFbxDataType &pDataType);


    typedef KFbxTypedProperty<fbxBool1>         KFbxPropertyBool1;
    typedef KFbxTypedProperty<fbxInteger1>      KFbxPropertyInteger1;
    typedef KFbxTypedProperty<fbxDouble1>       KFbxPropertyDouble1;
    typedef KFbxTypedProperty<fbxDouble3>       KFbxPropertyDouble3;
    typedef KFbxTypedProperty<fbxDouble4>       KFbxPropertyDouble4;
    typedef KFbxTypedProperty<fbxString>        KFbxPropertyString;
 

#include <fbxfilesdk_nsend.h>

#endif // _KFbxProperty_h