kfbxpropertyhandle.h

Go to the documentation of this file.

#ifndef FBXFILESDK_FBXCORE_KFBXPROPERTYHANDLE_H
#define FBXFILESDK_FBXCORE_KFBXPROPERTYHANDLE_H

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

 Copyright (C) 2001 - 2009 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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
#include <fbxfilesdk/kfbxplugins/kfbxtypes.h>
#include <fbxfilesdk/fbxcore/kfbxpropertydef.h>


#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

    // Forwards
    class   KFbxPropertyPage;
    class   KFbxPropertyHandle;
    class   KFbxConnectionPointFilter;

    /***********************************************
      KFbxPropertyHandle
    ************************************************/
    typedef KFbxPropertyHandle  KFbxTypeInfoHandle;
    typedef KFbxPropertyHandle  KFbxObjectHandle;
    typedef int                 kFbxPropertyId;

    class KFBX_DLL KFbxPropertyHandle
    {
    public:

        static KFbxObjectHandle     Create();

        static KFbxObjectHandle     Create(KFbxObjectHandle const &pInstanceOf);

        static KFbxTypeInfoHandle   Create(char const *pName,EFbxType pType=eUNIDENTIFIED);

        static KFbxTypeInfoHandle   Create(char const *pName,KFbxTypeInfoHandle pTypeInfo);

        bool                        Destroy();
    public:
        KFbxPropertyHandle();
        KFbxPropertyHandle(KFbxPropertyHandle const &pAddress);

        ~KFbxPropertyHandle();

    public:
        KFbxPropertyHandle(KFbxPropertyPage* pPage,kFbxPropertyId pId=kFbxProperyIdRoot);



    public:
        // Assignment
        KFbxPropertyHandle &operator =  (KFbxPropertyHandle const &pHandle);

        bool                operator == (KFbxPropertyHandle const &pHandle) const;

        bool                operator != (KFbxPropertyHandle const &pHandle) const;

        bool                Is          (KFbxPropertyHandle const &pHandle) const;

        bool                Valid() const;

        const char *            GetName() const;
        EFbxType                GetType() const;
        KFbxTypeInfoHandle      GetTypeInfo() const;
        const char *            GetLabel() const;

        bool                    SetLabel(char const *pLabel);

        // Flag management
        FbxPropertyFlags::eFbxPropertyFlags     GetFlags() const;

        bool                                    ModifyFlags(FbxPropertyFlags::eFbxPropertyFlags pFlags, bool pValue);

        KFbxInheritType                         GetFlagsInheritType( FbxPropertyFlags::eFbxPropertyFlags pFlags, bool pCheckReferences ) const;

        bool                                    SetFlagsInheritType( FbxPropertyFlags::eFbxPropertyFlags pFlags, KFbxInheritType pType );

        void *                  GetUserData() const;

        bool                    SetUserData(void const *pUserData);

        int                     GetUserTag() const;

        bool                    SetUserTag(int pUserData);

    public:

        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);


    public:
        KFbxPropertyHandle      Add(char const * pName,KFbxTypeInfoHandle const &pTypeInfo);

        void                    BeginCreateOrFindProperty();
        void                    EndCreateOrFindProperty();

        inline bool             IsRoot() const              { return (mPage && (mId==0)) ? true : false; }

        bool                    IsChildOf(KFbxPropertyHandle    const & pParent) const;

        bool                    IsDescendentOf(KFbxPropertyHandle   const & pParent) const;

        KFbxPropertyHandle      GetParent() const;

        bool                    SetParent( KFbxPropertyHandle const& pOther );

        KFbxPropertyHandle      GetChild()  const;

        KFbxPropertyHandle      GetSibling() const;

        KFbxPropertyHandle      GetFirstDescendent()  const;

        KFbxPropertyHandle      GetNextDescendent(KFbxPropertyHandle const &pHandle) const;

        KFbxPropertyHandle      Find (char const *pName,bool pCaseSensitive) const;

        KFbxPropertyHandle      Find (char const *pName,KFbxTypeInfoHandle const &pTypeInfo,bool pCaseSensitive) const;

        KFbxPropertyHandle      Find (char const *pName, const char* pChildrenSeparator,bool pCaseSensitive) const;

        KFbxPropertyHandle      Find (char const *pName, const char* pChildrenSeparator,KFbxTypeInfoHandle const &pTypeInfo,bool pCaseSensitive) const;

    public:

        bool                ConnectSrc      (KFbxPropertyHandle const &pSrc,kFbxConnectionType const pType=eFbxConnectionDefault); 

        int                 GetSrcCount     (KFbxConnectionPointFilter* pFilter=0) const; 

        KFbxPropertyHandle  GetSrc          (KFbxConnectionPointFilter* pFilter=0,int pIndex=0) const; 

        bool                DisconnectSrc   (KFbxPropertyHandle const &pSrc);

        bool                IsConnectedSrc  (KFbxPropertyHandle const &pSrc);

        bool                ConnectDst      (KFbxPropertyHandle const &pDst,kFbxConnectionType const pType=eFbxConnectionDefault); 

        int                 GetDstCount     (KFbxConnectionPointFilter* pFilter=0) const; 

        KFbxPropertyHandle  GetDst          (KFbxConnectionPointFilter* pFilter=0,int pIndex=0) const; 

        bool                DisconnectDst   (KFbxPropertyHandle const &pDst);

        bool                IsConnectedDst  (KFbxPropertyHandle const &pDst);

        void                ClearConnectCache();

    public:

        bool                    HasMin() const;

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

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

        template <class T> inline bool  SetMin      ( T const &pValue )         { return SetMin( &pValue,FbxTypeOf(pValue) ); }

        template <class T> inline T     GetMin      ( T const *pFBX_TYPE) const { T lValue; GetMin( &lValue,FbxTypeOf(lValue) ); return lValue; }

        bool                    HasSoftMin() const;

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

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

        template <class T> inline bool  SetSoftMin  ( T const &pValue )         { return SetSoftMin( &pValue,FbxTypeOf(pValue) ); }

        template <class T> inline T     GetSoftMin  ( T const *pFBX_TYPE) const { T lValue; GetSoftMin( &lValue,FbxTypeOf(lValue) ); return lValue; }

        bool                    HasMax() const;

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

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

        template <class T> inline bool  SetMax      ( T const &pValue )         { return SetMax( &pValue,FbxTypeOf(pValue) ); }

        template <class T> inline T     GetMax      ( T const *pFBX_TYPE) const { T lValue; GetMax( &lValue,FbxTypeOf(lValue) ); return lValue; }

        bool                    HasSoftMax() const;

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

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

        template <class T> inline bool  SetSoftMax  ( T const &pValue )         { return SetSoftMax( &pValue,FbxTypeOf(pValue) ); }

        template <class T> inline T     GetSoftMax  ( T const *pFBX_TYPE) const { T lValue; GetSoftMax( &lValue,FbxTypeOf(lValue) ); return lValue; }


    public:

        KFbxInheritType GetValueInheritType(bool pCheckReferences) const;

        bool            SetValueInheritType(KFbxInheritType pType);

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

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

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

        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; }

    public:

        void    SetPageDataPtr(void *pData);

        void*   GetPageDataPtr() const;



        bool PushPropertiesToParentInstance();



    public:
        bool    IsAReferenceTo(void) const;

        void*   GetReferenceTo(void) const;

        bool    IsReferencedBy(void) const;

        int     GetReferencedByCount(void) const;

        void*   GetReferencedBy(int pIndex) const; 


    private:
        KFbxPropertyPage*       mPage;
        kFbxPropertyId          mId;

    };

    // Internal Allocator Function
    KFBX_DLL KMemoryAllocator & GetConnectionPointAllocator();

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_FBXCORE_KFBXPROPERTYHANDLE_H