fbxprocessorxref.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2015 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_UTILS_PROCESSOR_XREF_H_
#define _FBXSDK_UTILS_PROCESSOR_XREF_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxmap.h>
#include <fbxsdk/utils/fbxprocessor.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxProcessorXRefCopy : public FbxProcessor
{
    FBXSDK_OBJECT_DECLARE(FbxProcessorXRefCopy, FbxProcessor);

public:
    class FBXSDK_DLL MissingUrlHandler
    {
    public:
        virtual ~MissingUrlHandler();
        virtual void MissingUrl(const FbxString& pUrl, const FbxProperty&) = 0;
    };

        FbxPropertyT<FbxString>    OutputDirectory;

        FbxPropertyT<FbxBool>     UpdateProperties;

        FbxPropertyT<FbxBool>     TrackUpdatedProperties;

        FbxPropertyT<FbxBool>     ForceCopy;

        FbxPropertyT<FbxBool>     CopyFileTimes;

        MissingUrlHandler*          MissingUrlHandler;

    struct PropertyUpdate
    {
        FbxProperty mProperty;
        FbxString    mOriginalValue;

        inline PropertyUpdate() {}
        inline PropertyUpdate(const FbxProperty& pProp, const FbxString& pVal) :
            mProperty(pProp), mOriginalValue(pVal) {}

        inline bool operator <(const PropertyUpdate& pOther) const
        {
            return strcmp(mProperty.GetName(), pOther.mProperty.GetName()) < 0;
        }
    };
    typedef FbxSet<PropertyUpdate>           UpdateSet;
    typedef FbxMap<FbxObject*, UpdateSet>    PropertyUpdateMap;

    PropertyUpdateMap& GetUpdatedProperties();

    void RevertPropertyChanges();

    struct FBXSDK_DLL AutoRevertPropertyChanges
    {
        AutoRevertPropertyChanges(FbxProcessorXRefCopy* pCopy) : mXRefCopy(pCopy) {}
        ~AutoRevertPropertyChanges()
        {
            if( mXRefCopy )
                mXRefCopy->RevertPropertyChanges();
        }

        FbxProcessorXRefCopy* mXRefCopy;
    };

/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    virtual void Construct(const FbxObject* pFrom);
    virtual void ConstructProperties(bool pForceSet);

    PropertyUpdateMap mUpdatedProperties;

    // Implements the rules specified for the ForceCopy property.
    // Also checks the ForceCopy property.
    bool ShouldCopyFile(const FbxString& pTarget, const FbxString& pSource) const;

    virtual bool    internal_ProcessCollectionBegin (FbxCollection*     pObject);
    virtual bool    internal_ProcessCollectionEnd   (FbxCollection*     pObject);
    virtual bool    internal_ProcessObject          (FbxObject*     pObject);
    bool            ProcessPathProperty(FbxProperty &pProperty);
    virtual bool    ValidPropertyForXRefCopy(FbxObject* pObject, FbxProperty& lProperty) const;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_UTILS_PROCESSOR_XREF_H_ */