kfbxglobaltimesettings.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXGLOBALTIMESETTINGS_H
#define FBXFILESDK_KFBXPLUGINS_KFBXGLOBALTIMESETTINGS_H

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

 Copyright (C) 2001 - 2009 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/karrayul.h>
#include <fbxfilesdk/components/kbaselib/klib/ktime.h>
#include <fbxfilesdk/components/kbaselib/klib/kerror.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxGlobalTimeSettingsProperties;

class KFBX_DLL KFbxGlobalTimeSettings
{

public:
    KFBXNEW_DECLARE_FRIEND

    void RestoreDefaultSettings();

    void SetTimeMode(KTime::ETimeMode pTimeMode);

    KTime::ETimeMode GetTimeMode() const;

    void SetTimeProtocol(KTime::ETimeProtocol pTimeProtocol);

    KTime::ETimeProtocol GetTimeProtocol() const;

    typedef enum
    {
        eNO_SNAP,
        eSNAP_ON_FRAME,
        ePLAY_ON_FRAME,
        eSNAP_PLAY_ON_FRAME
    } ESnapOnFrameMode;

    void SetSnapOnFrameMode(ESnapOnFrameMode pSnapOnFrameMode);

    ESnapOnFrameMode GetSnapOnFrameMode() const;


    void SetTimelineDefautTimeSpan(const KTimeSpan& pTimeSpan);

    void GetTimelineDefautTimeSpan(KTimeSpan& pTimeSpan) const;



    struct KFBX_DLL KFbxTimeMarker
    {
        KFbxTimeMarker();

        KFbxTimeMarker(const KFbxTimeMarker& pTimeMarker);

        KFbxTimeMarker& operator=(const KFbxTimeMarker& pTimeMarker);

        KString mName; 

        KTime mTime; 

        bool mLoop; 
    };

    int GetTimeMarkerCount() const;

    bool SetCurrentTimeMarker(int pIndex);

    int GetCurrentTimeMarker() const;

    KFbxTimeMarker* GetTimeMarker(int pIndex) const;

    void AddTimeMarker(KFbxTimeMarker pTimeMarker);

    void RemoveAllTimeMarkers();


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


    KError& GetError();

    typedef enum
    {
        eINDEX_OUT_OF_RANGE,
        eERROR_COUNT
    } EError;

    EError 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:

    KFbxGlobalTimeSettings();
    ~KFbxGlobalTimeSettings();

    KFbxGlobalTimeSettingsProperties* mPH;

    friend class KFbxScene;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXGLOBALTIMESETTINGS_H