fbxiosettings.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 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_FILEIO_IO_SETTINGS_H_
#define _FBXSDK_FILEIO_IO_SETTINGS_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxarray.h>
#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/fbxobject.h>

// undef the macro mkdir, since it conflict with function mkdir in Qt\4.2.3\src\corelib\io\qdir.h
#if (defined(_MSC_VER) || defined(__MINGW32__)) && defined(mkdir)
    #undef mkdir
#endif

#include <fbxsdk/core/fbxpropertytypes.h>

#include <fbxsdk/fileio/fbxiosettingspath.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

#define IOSVisible    true
#define IOSHidden     false

#define IOSSavable    true
#define IOSNotSavable false

#define IOSEnabled    true
#define IOSDisabled   false

#define IOSBinary     0
#define IOSASCII      1

class FbxIOSettings;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

class FBXSDK_DLL FbxIOInfo
{
public:
    enum EImpExp
    {
        eImport,
        eExport
    };

public:
    FbxIOInfo();

    void Reset(EImpExp pImpExp);
    
    void SetTimeMode(FbxTime::EMode pTimeMode, double pCustomFrameRate = 0.0);

    FbxTime::EMode GetTimeMode(){ return mTimeMode; }

    FbxTime GetFramePeriod();
    
    void SetASFScene(FbxObject* pASFScene, bool pASFSceneOwned = false);
    FbxObject* GetASFScene(){ return mASFScene; }

    void Set_IOS(FbxIOSettings* pIOS){ios = pIOS;}

    void SetImportExportMode(EImpExp pImpExp){mImpExp = pImpExp;}

private: 

    FbxTime::EMode mTimeMode;
    FbxObject* mASFScene;

    EImpExp mImpExp;

    FbxIOSettings* ios;
};

#endif // DOXYGEN_SHOULD_SKIP_THIS

class FbxManager;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

// http://www.microsoft.com/globaldev/reference/winxp/langtla.mspx

//  LOCALE                            TLA  LCID

//  English - United States           ENU  0409
//  German - Germany                  DEU  0407
//  French - France                   FRA  040c
//  Japanese - Japan                  JPN  0411
//  Korean(Extended Wansung) - Korea  KOR  0412
//  Chinese - PRC                     CHS  0804

enum EFbxUILanguage
{
    eENU = 0,                   // MAX 409 English - United States
    eDEU,                       // MAX 407 German - Germany
    eFRA,                       // MAX 40c French - France
    eJPN,                       // MAX 411 Japanese - Japan
    eKOR,                       // MAX 412 Korean(Extended Wansung) - Korea 
    eCHS,                       // MAX 804 Chinese - PRC
    eFbxUILanguageCount
};

// this class is located in the UserDataPtr of each FbxIOSettings properties
class PropInfo
{
public:
    PropInfo();
    ~PropInfo();

    void*           UIWidget;            // UI widget for showing the property
    void*           cbValueChanged;      // call back when value changed
    void*           cbDirty;             // call back when value changed
    FbxStringList   labels;              // list of labels in many languages
};
#endif // DOXYGEN_SHOULD_SKIP_THIS

class FBXSDK_DLL FbxIOSettings : public FbxObject
{
    FBXSDK_OBJECT_DECLARE(FbxIOSettings,FbxObject);

public:

    virtual void Destruct(bool pRecursive, bool pDependents);

    FbxProperty AddPropertyGroup(const char* pName, const FbxDataType& pDataType=FbxDataType(), const char* pLabel="");

    FbxProperty AddPropertyGroup(const FbxProperty& pParentProperty, const char* pName, const FbxDataType& pDataType = FbxDataType(), 
                                  const char* pLabel  = "", bool pVisible = true, bool pSavable = true, bool pEnabled = true );

    FbxProperty AddProperty(const FbxProperty& pParentProperty, const char* pName, const FbxDataType& pDataType = FbxDataType(), 
                             const char* pLabel = "", const void* pValue = NULL, bool pVisible = true,
                             bool pSavable = true, bool pEnabled = true );

    FbxProperty AddPropertyMinMax(const FbxProperty& pParentProperty, const char* pName, const FbxDataType& pDataType = FbxDataType(), 
                                   const char* pLabel = "", const void* pValue = NULL, const double* pMinValue = NULL, const double* pMaxValue = NULL,
                                   bool pVisible = true, bool pSavable = true, bool pEnabled = true );


    FbxProperty GetProperty(const char* pName) const;

    FbxProperty GetProperty(const FbxProperty& pParentProperty, const char* pName) const;

    bool GetBoolProp(const char* pName, bool pDefValue) const;

    void SetBoolProp(const char* pName, bool pValue);

    double GetDoubleProp(const char* pName, double pDefValue) const;

    void   SetDoubleProp(const char* pName, double pValue);

    int    GetIntProp(const char* pName, int pDefValue) const;

    void   SetIntProp(const char* pName, int pValue);

    FbxTime  GetTimeProp(const char* pName, FbxTime pDefValue) const;

    void   SetTimeProp(const char* pName, FbxTime pValue);

    
    FbxString GetEnumProp(const char* pName, FbxString pDefValue) const;

    int     GetEnumProp(const char* pName, int pDefValue) const;

    int     GetEnumIndex(const char* pName, FbxString pValue) const;

    void    SetEnumProp(const char* pName, FbxString pValue);

    void    SetEnumProp(const char* pName, int pValue);

    void    RemoveEnumPropValue(const char* pName, FbxString pValue);

    void    EmptyEnumProp(const char* pName);

    bool    IsEnumExist(FbxProperty& pProp, const FbxString& enumString) const;

    int     GetEnumIndex(FbxProperty& pProp, const FbxString& enumString, bool pNoCase = false) const;

    bool    SetFlag(const char* pName, FbxPropertyAttr::EFlags propFlag, bool pValue);

    FbxString GetStringProp(const char* pName, FbxString pDefValue) const;

    void    SetStringProp(const char* pName, FbxString pValue);

     
    virtual bool ReadXMLFile(const FbxString& path);

    virtual bool WriteXMLFile(const FbxString& path);

    bool WriteXmlPropToFile(const FbxString& pFullPath, const FbxString& propPath);

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
    PropInfo* GetPropInfo(FbxProperty &pProp);

    EFbxUILanguage UILanguage;
    FbxString GetLanguageLabel(FbxProperty& pProp);
    void SetLanguageLabel(FbxProperty& pProp, FbxString& pLabel);
    EFbxUILanguage Get_Max_Runtime_Language(FbxString pRegLocation);

    FbxIOInfo impInfo;
    FbxIOInfo expInfo;

    static FbxString GetUserMyDocumentDir();
    void SetPropVisible(FbxProperty& pProp, bool pWithChildren, bool pVisible);

    virtual bool ConstructProperties(bool pForceSet);

            // Read an XML file from MyDocument dir
    bool ReadXmlPropFromMyDocument(const FbxString& subDir, const FbxString& filename);

            // Write property branch to an XML file in MyDocument dir
    bool WriteXmlPropToMyDocument(const FbxString& subDir, const FbxString& filename, const FbxString& propPath);

    static const char* GetFileMergeDescription(int pIndex);

    enum ELoadMode         
    { 
        eCreate,          
        eMerge,           
        eExclusiveMerge  
    };


    enum EQuaternionMode   { eAsQuaternion, eAsEuler, eResample };
    enum EObjectDerivation { eByLayer, eByEntity, eByBlock }; 

    enum ESysUnits
    {
        eUnitsUser,
        eUnitsInches, 
        eUnitsFeet,
        eUnitYards,
        eUnitsMiles,
        eUnitsMillimeters,
        eUnitsCentimeters,
        eUnitsMeters,
        eUnitsKilometers
    };

    enum ESysFrameRate  
    {
        eFrameRateUser,
        eFrameRateHours,
        eFrameRateMinutes,
        eFrameRateSeconds,
        eFrameRateMilliseconds,
        eFrameRateGames15,
        eFrameRateFilm24,
        eFrameRatePAL25,
        eFrameRateNTSC30,
        eFrameRateShowScan48,
        eFrameRatePALField50,
        eFrameRateNTSCField60
    };
    
// Max
    enum EEnveloppeSystem
    {
        eSkinModifier,
        ePhysic,
        eBonePro,
        eEnveloppeSystemCount
    };

// Max
    enum EGeometryType
    {
        eTriangle,
        eSimplifiedPoly,
        ePolygon,
        eNurbs,
        ePatch,
        eGeometryTypeCount
    };

// Maya IK type
    enum EIKType
    {
        eNone,
        eFBIK,      
        eHumanIK
    };

protected:
    FbxIOSettings(FbxManager& pManager,const char* pName);

private:
    void AddNewPropInfo(FbxProperty& pProp);
    void DeletePropInfo(FbxProperty& pProp);
    void DeleteAllPropInfo(FbxProperty& pProp);

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_IO_SETTINGS_H_ */