fbxglobaltimesettings.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_GLOBAL_TIME_SETTINGS_H_
#define _FBXSDK_FILEIO_GLOBAL_TIME_SETTINGS_H_

#include <fbxsdk/fbxsdk_def.h>

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

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxGlobalTimeSettingsProperties;

class FBXSDK_DLL FbxGlobalTimeSettings
{

public:
    FBXSDK_FRIEND_NEW();

    void RestoreDefaultSettings();

    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 SetTimelineDefautTimeSpan(const FbxTimeSpan& pTimeSpan);

    void GetTimelineDefautTimeSpan(FbxTimeSpan& pTimeSpan) const;



    struct FBXSDK_DLL TimeMarker
    {
        TimeMarker();

        TimeMarker(const TimeMarker& pTimeMarker);

        TimeMarker& operator=(const TimeMarker& pTimeMarker);

        FbxString mName; 

        FbxTime mTime; 

        bool mLoop; 
    };

    int GetTimeMarkerCount() const;

    bool SetCurrentTimeMarker(int pIndex);

    int GetCurrentTimeMarker() const;

    TimeMarker* GetTimeMarker(int pIndex) const;

    void AddTimeMarker(TimeMarker pTimeMarker);

    void RemoveAllTimeMarkers();


    const FbxGlobalTimeSettings& operator=(const FbxGlobalTimeSettings& pGlobalTimeSettings);


    FbxError& GetError();

    enum EErrorCode
    {
        eIndexOutOfRange,
        eErrorCount
    };

    EErrorCode GetLastErrorID() const;

    const char* GetLastErrorString() const;



    void SetSnapOnFrame(bool pSnapOnFrame);

    bool GetSnapOnFrame() const;


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:

    FbxGlobalTimeSettings();
    ~FbxGlobalTimeSettings();

    FbxGlobalTimeSettingsProperties* mPH;

    friend class FbxScene;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_GLOBAL_TIME_SETTINGS_H_ */