kfbxprocessorxref.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_FBXPROCESSORS_KFBXPROCESSORXREF_H
00005 #define FBXFILESDK_FBXPROCESSORS_KFBXPROCESSORXREF_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2010 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <fbxfilesdk/fbxprocessors/fbxprocessors_def.h>
00043 
00044 #include <fbxfilesdk/fbxprocessors/kfbxprocessor.h>
00045 #include <fbxfilesdk/components/kbaselib/klib/kmap.h>
00046 
00047 namespace FBXPROCESSORS_NAMESPACE {
00048 
00052     class KFBX_DLL KFbxProcessorXRefCopy : public KFbxProcessor
00053     {
00054         KFBXOBJECT_DECLARE(KFbxProcessorXRefCopy, KFbxProcessor);
00055 
00056     public:
00057         class KFBX_DLL KFbxMissingUrlHandler
00058         {
00059         public:
00060             virtual ~KFbxMissingUrlHandler();
00061             virtual void MissingUrl(const KString& pUrl, const KFbxProperty&) = 0;
00062         };
00063 
00068             KFbxTypedProperty<fbxString>    OutputDirectory;
00069 
00073             KFbxTypedProperty<fbxBool1>     UpdateProperties;
00074 
00078             KFbxTypedProperty<fbxBool1>     TrackUpdatedProperties;
00079 
00087             KFbxTypedProperty<fbxBool1>     ForceCopy;
00088 
00092             KFbxTypedProperty<fbxBool1>     CopyFileTimes;
00094 
00099             KFbxMissingUrlHandler*          MissingUrlHandler;
00100 
00105         struct KFbxPropertyUpdate
00106         {
00107             KFbxProperty mProperty;
00108             fbxString    mOriginalValue;
00109 
00110             inline KFbxPropertyUpdate() {}
00111             inline KFbxPropertyUpdate(const KFbxProperty& pProp, const fbxString& pVal) :
00112                 mProperty(pProp), mOriginalValue(pVal) {}
00113 
00114             inline bool operator <(const KFbxPropertyUpdate& pOther) const
00115             {
00116                 return strcmp(mProperty.GetName(), pOther.mProperty.GetName()) < 0;
00117             }
00118         };
00119         typedef KSet2<KFbxPropertyUpdate>           KFbxUpdateSet;
00120         typedef KMap<KFbxObject*, KFbxUpdateSet>    KFbxPropertyUpdateMap;
00121 
00127         KFbxPropertyUpdateMap& GetUpdatedProperties();
00128 
00132         void RevertPropertyChanges();
00133 
00137         struct KFBX_DLL KFbxAutoRevertPropertyChanges
00138         {
00139             KFbxAutoRevertPropertyChanges(KFbxProcessorXRefCopy* pCopy) : mXRefCopy(pCopy) {}
00140             ~KFbxAutoRevertPropertyChanges()
00141             {
00142                 if( mXRefCopy )
00143                     mXRefCopy->RevertPropertyChanges();
00144             }
00145 
00146             KFbxProcessorXRefCopy* mXRefCopy;
00147         };
00148 
00150         //  WARNING!
00151         //  Anything beyond these lines may not be documented accurately and is
00152         //  subject to change without notice.
00154         #ifndef DOXYGEN_SHOULD_SKIP_THIS
00155 
00156             protected:
00157                 KFbxPropertyUpdateMap       mUpdatedProperties;
00158 
00159             // Constructor / Destructor
00160             protected:
00161                 virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00162                 KFbxProcessorXRefCopy(KFbxSdkManager& pManager, char const* pName);
00163 
00164                 bool ConstructProperties(bool pForceSet);
00165 
00166                 // Implements the rules specified for the ForceCopy property.
00167                 // Also checks the ForceCopy property.
00168                 bool ShouldCopyFile(const KString& pTarget, const KString& pSource) const;
00169 
00173             protected:
00174                 virtual bool                internal_ProcessCollectionBegin (KFbxCollection*     pObject);
00175                 virtual bool                internal_ProcessCollectionEnd   (KFbxCollection*     pObject);
00176                 virtual bool                internal_ProcessObject          (KFbxObject*     pObject);
00177                 bool                        ProcessPathProperty(KFbxProperty &pProperty);
00178                 virtual bool                ValidPropertyForXRefCopy(KFbxObject* pObject, KFbxProperty& lProperty) const;
00180 
00181         #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00182 
00183     };
00184 }
00185 
00186 #endif // FBXFILESDK_FBXPROCESSORS_KFBXPROCESSORXREF_H
00187