kfbxglobalsettings.h

Go to the documentation of this file.

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

   Copyright (C) 2010 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 FBXFILESDK_KFBXPLUGINS_KFBXGLOBALSETTINGS_H
#define FBXFILESDK_KFBXPLUGINS_KFBXGLOBALSETTINGS_H

#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/kfbxplugins/kfbxaxissystem.h>
#include <fbxfilesdk/kfbxplugins/kfbxsystemunit.h>
#include <fbxfilesdk/kfbxplugins/kfbxobject.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFBX_DLL KFbxGlobalSettings : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxGlobalSettings,KFbxObject);

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

    void SetOriginalUpAxis(const KFbxAxisSystem& pAxisSystem);

    int GetOriginalUpAxis() const;


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

    void SetOriginalSystemUnit(const KFbxSystemUnit& pOther);

    KFbxSystemUnit GetOriginalSystemUnit() const;



    void SetAmbientColor(KFbxColor pAmbientColor);

    KFbxColor GetAmbientColor() const;



    static const char* ePRODUCER_PERSPECTIVE;

    static const char* ePRODUCER_TOP;

    static const char* ePRODUCER_FRONT;

    static const char* ePRODUCER_BACK;

    static const char* ePRODUCER_RIGHT;

    static const char* ePRODUCER_LEFT;

    static const char* ePRODUCER_BOTTOM;

    bool SetDefaultCamera(const char* pCameraName);

    KString GetDefaultCamera() const;

    void SetTimeMode(KTime::ETimeMode pTimeMode);

    KTime::ETimeMode GetTimeMode() const;

    void SetTimelineDefaultTimeSpan(const KTimeSpan& pTimeSpan);

    void GetTimelineDefaultTimeSpan(KTimeSpan& pTimeSpan) const;

    void SetCustomFrameRate(double pCustomFrameRate);

    double GetCustomFrameRate() const; 

protected:

        KFbxTypedProperty<fbxInteger1>  UpAxis;
        KFbxTypedProperty<fbxInteger1>  UpAxisSign;

        KFbxTypedProperty<fbxInteger1>  FrontAxis;
        KFbxTypedProperty<fbxInteger1>  FrontAxisSign;

        KFbxTypedProperty<fbxInteger1>  CoordAxis;
        KFbxTypedProperty<fbxInteger1>  CoordAxisSign;

        KFbxTypedProperty<fbxInteger1>  OriginalUpAxis;
        KFbxTypedProperty<fbxInteger1>  OriginalUpAxisSign;

        KFbxTypedProperty<fbxDouble1>   UnitScaleFactor;
        KFbxTypedProperty<fbxDouble1>   OriginalUnitScaleFactor;

        KFbxTypedProperty<fbxDouble3>   AmbientColor;
        KFbxTypedProperty<fbxString>    DefaultCamera;
        KFbxTypedProperty<fbxEnum>      TimeMode;
        KFbxTypedProperty<fbxTime>      TimeSpanStart;
        KFbxTypedProperty<fbxTime>      TimeSpanStop;
        KFbxTypedProperty<fbxDouble1>   CustomFrameRate;

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
    virtual KFbxObject& Copy(const KFbxObject& pObject);

protected:
    virtual void Construct(const KFbxGlobalSettings* pFrom);
    virtual bool ConstructProperties(bool pForceSet);
    
private:
    KFbxGlobalSettings(KFbxSdkManager& pManager, char const* pName);

    void AxisSystemToProperties();
    void PropertiesToAxisSystem();

    void Init();

    KFbxAxisSystem mAxisSystem;
    friend class KFbxScene;    

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 
};

inline EFbxType FbxTypeOf( KTime::ETimeMode const &pItem )             { return eENUM; }


#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXGLOBALSETTINGS_H