fbxsdk/fileio/fbxglobalsettings.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2013 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_GLOBAL_SETTINGS_H_
#define _FBXSDK_FILEIO_GLOBAL_SETTINGS_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>
#include <fbxsdk/core/base/fbxstatus.h>
#include <fbxsdk/scene/fbxaxissystem.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

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

public:
    
    void SetAxisSystem(const FbxAxisSystem& pAxisSystem);
    
    FbxAxisSystem GetAxisSystem();

    void SetOriginalUpAxis(const FbxAxisSystem& pAxisSystem);

    int GetOriginalUpAxis() const;


    void SetSystemUnit(const FbxSystemUnit& pOther);
    
    FbxSystemUnit GetSystemUnit() const;

    void SetOriginalSystemUnit(const FbxSystemUnit& pOther);

    FbxSystemUnit GetOriginalSystemUnit() const;



    void SetAmbientColor(FbxColor pAmbientColor);

    FbxColor GetAmbientColor() const;


    bool SetDefaultCamera(const char* pCameraName);

    FbxString GetDefaultCamera() const;

    void SetTimeMode(FbxTime::EMode pTimeMode);

    FbxTime::EMode GetTimeMode() const;

    void SetTimeProtocol(FbxTime::EProtocol pTimeProtocol);

    FbxTime::EProtocol GetTimeProtocol() const;

    enum ESnapOnFrameMode
    {
        eNoSnap,                        
        eSnapOnFrame,           
        ePlayOnFrame,           
        eSnapAndPlayOnFrame     
    };

    void SetSnapOnFrameMode(ESnapOnFrameMode pSnapOnFrameMode);

    ESnapOnFrameMode GetSnapOnFrameMode() const;

    void SetTimelineDefaultTimeSpan(const FbxTimeSpan& pTimeSpan);

    void GetTimelineDefaultTimeSpan(FbxTimeSpan& pTimeSpan) const;

    void SetCustomFrameRate(double pCustomFrameRate);

    double GetCustomFrameRate() const; 

        struct FBXSDK_DLL TimeMarker
        {
            TimeMarker();

            TimeMarker(const TimeMarker& pTimeMarker);

            TimeMarker& operator=(const TimeMarker& pTimeMarker);

            FbxString mName; 

            FbxTime mTime; 

            bool mLoop; 
        };

    int GetTimeMarkerCount() const;

    TimeMarker GetTimeMarker(int pIndex, FbxStatus* pStatus=NULL) const;

    void AddTimeMarker(const TimeMarker& pTimeMarker, FbxStatus* pStatus=NULL);

    void ReplaceTimeMarker(int pIndex, const TimeMarker& pTimeMarker, FbxStatus* pStatus=NULL);

    void RemoveAllTimeMarkers();

    bool SetCurrentTimeMarker(int pIndex, FbxStatus* pStatus=NULL);

    int GetCurrentTimeMarker() const;

/*****************************************************************************************************************************
** 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
        virtual FbxObject& Copy(const FbxObject& pObject);
    
protected:
        FbxPropertyT<FbxInt>    UpAxis;
        FbxPropertyT<FbxInt>    UpAxisSign;

        FbxPropertyT<FbxInt>    FrontAxis;
        FbxPropertyT<FbxInt>    FrontAxisSign;

        FbxPropertyT<FbxInt>    CoordAxis;
        FbxPropertyT<FbxInt>    CoordAxisSign;

    FbxPropertyT<FbxInt>        OriginalUpAxis;
    FbxPropertyT<FbxInt>        OriginalUpAxisSign;

        FbxPropertyT<FbxDouble> UnitScaleFactor;
    FbxPropertyT<FbxDouble>     OriginalUnitScaleFactor;

    FbxPropertyT<FbxDouble3>    AmbientColor;
    FbxPropertyT<FbxString>     DefaultCamera;
    FbxPropertyT<FbxEnum>       TimeMode;
    FbxPropertyT<FbxEnum>       TimeProtocol;
    FbxPropertyT<FbxEnum>       SnapOnFrameMode;
    FbxPropertyT<FbxTime>       TimeSpanStart;
    FbxPropertyT<FbxTime>       TimeSpanStop;
    FbxPropertyT<FbxDouble>     CustomFrameRate;

protected:
        virtual void Construct(const FbxGlobalSettings* pFrom);
        virtual void ConstructProperties(bool pForceSet);
        
private:
    void AxisSystemToProperties();
    void PropertiesToAxisSystem();

    void Init();

    FbxAxisSystem mAxisSystem;    
    int mNbTimeMarkers;

    friend class FbxWriterFbx6;
 
    FbxProperty mTimeMarkers;
    FbxPropertyT<FbxInt> mCurrentTimeMarker;
    void AddSetTimeMarker(int pIndex, const TimeMarker& pTimeMarker, FbxStatus* pStatus, bool pAdd);

#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

inline EFbxType FbxTypeOf(const FbxTime::EMode&){ return eFbxEnum; }

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_GLOBAL_SETTINGS_H_ */