kfbxrenamingstrategy.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXRENAMINGSTRATEGY_H
#define FBXFILESDK_KFBXPLUGINS_KFBXRENAMINGSTRATEGY_H

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

 Copyright (C) 2001 - 2010 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/fbxfilesdk_def.h>

#include <fbxfilesdk/components/kbaselib/klib/kstring.h>
#include <fbxfilesdk/components/kbaselib/klib/kstringlist.h>
#include <fbxfilesdk/components/kbaselib/klib/krenamingstrategy.h>
#include <fbxfilesdk/components/kbaselib/klib/kcharptrset.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxNode;
class KFbxTexture;
class KFbxVideo;
class KFbxScene;
class KFbxNodeAttribute;

class KFBX_DLL KFbxRenamingStrategy : public KRenamingStrategy
{
public:
    enum EMode
    {
        eTO_FBX,
        eFROM_FBX,
        eMODE_COUNT
    };

    KFbxRenamingStrategy(EMode pMod, bool pOnCreationRun = false);

    virtual ~KFbxRenamingStrategy();
    
    virtual bool Rename(KName& pName);

    virtual void Clear();
    
    virtual KRenamingStrategy* Clone();

    //
    //  WARNING!
    //
    //  Anything beyond these lines may not be documented accurately and is
    //  subject to change without notice.
    //

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    enum EClashType
    {
        eNAMECLASH_AUTO,
        eNAMECLASH_TYPE1,
        eNAMECLASH_TYPE2
    };

    void SetClashSoverType(EClashType pType);

    static char* NoPrefixName (char const* pName);

    static char* NoPrefixName (KString& pName);

    virtual char* GetNameSpace() { return mNameSpace.Buffer(); } 

    virtual void SetInNameSpaceSymbol(KString pNameSpaceSymbol){mInNameSpaceSymbol = pNameSpaceSymbol;}
    
    virtual void SetOutNameSpaceSymbol(KString pNameSpaceSymbol){mOutNameSpaceSymbol = pNameSpaceSymbol;}    

    virtual void SetCaseSensibility(bool pIsCaseSensitive){mCaseSensitive = pIsCaseSensitive ;}

    virtual void SetReplaceNonAlphaNum(bool pReplaceNonAlphaNum){mReplaceNonAlphaNum = pReplaceNonAlphaNum;}

    virtual void SetFirstNotNum(bool pFirstNotNum){mFirstNotNum = pFirstNotNum;}

    virtual bool RenameUnparentNameSpace(KFbxNode* pNode, bool pIsRoot = false);

    virtual bool RemoveImportNameSpaceClash(KFbxNode* pNode);

    virtual void GetParentsNameSpaceList(KFbxNode* pNode, KArrayTemplate<KString*> &pNameSpaceList);
    virtual bool PropagateNameSpaceChange(KFbxNode* pNode, KString OldNS, KString NewNS);

protected:

    virtual bool RenameToFBX(KName& pName);
    virtual bool RenameFromFBX(KName& pName);
    virtual KString& ReplaceNonAlphaNum(KString& pName,    char* pReplace, bool pIgnoreNameSpace);

    EMode mMode;
    EClashType mType;

    struct NameCell
    {
        NameCell(char const* pName) :
            mName(pName),
            mInstanceCount(0)
        {
        }
            
        KString mName;
        int mInstanceCount;        
    };


    KCharPtrSet                    mStringNameArray;
    KArrayTemplate<NameCell*>    mExistingNsList;
    bool                        mOnCreationRun;
    bool                        mCaseSensitive;
    bool                        mReplaceNonAlphaNum;
    bool                        mFirstNotNum;
    KString                        mNameSpace;
    KString                        mInNameSpaceSymbol; //symbol identifying a name space
    KString                        mOutNameSpaceSymbol; 

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

class KFBX_DLL KFbxSceneRenamer
{
public:
    KFbxSceneRenamer(KFbxScene* pScene) {mScene = pScene;};

    virtual ~KFbxSceneRenamer(){};

    enum ERenamingMode
    { 
        eNONE,
        eMAYA_TO_FBX5,
        eMAYA_TO_FBX_MB75,
        eMAYA_TO_FBX_MB70,
        eFBXMB75_TO_FBXMB70,
        eFBX_TO_FBX,
        eMAYA_TO_FBX,
        eFBX_TO_MAYA,
        eLW_TO_FBX,
        eFBX_TO_LW,
        eXSI_TO_FBX,
        eFBX_TO_XSI,
        eMAX_TO_FBX,
        eFBX_TO_MAX,
        eMB_TO_FBX,
        eFBX_TO_MB,
        eDAE_TO_FBX,
        eFBX_TO_DAE
    };

    void RenameFor(ERenamingMode pMode);

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:
    
    void ResolveNameClashing(    bool pFromFbx, bool pIgnoreNS, bool pIsCaseSensitive,
                                bool pReplaceNonAlphaNum, bool pFirstNotNum,
                                KString pInNameSpaceSymbol, KString pOutNameSpaceSymbol,
                                bool pNoUnparentNS/*for MB < 7.5*/, bool pRemoveNameSpaceClash);

    KRenamingStrategy* mNodeRenamingStrategy;
    KFbxScene* mScene;

#endif // DOXYGEN_SHOULD_SKIP_THIS
};


#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXRENAMINGSTRATEGY_H