fbxgloballightsettings.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_LIGHT_SETTINGS_H_
#define _FBXSDK_FILEIO_GLOBAL_LIGHT_SETTINGS_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxarray.h>
#include <fbxsdk/core/base/fbxerror.h>
#include <fbxsdk/core/math/fbxvector4.h>
#include <fbxsdk/core/fbxpropertytypes.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxGlobalLightSettingsProperties;

class FBXSDK_DLL FbxGlobalLightSettings
{

public:
    FBXSDK_FRIEND_NEW();

    void SetAmbientColor(FbxColor pAmbientColor);

    FbxColor GetAmbientColor() const;



    void SetFogEnable(bool pEnable);

    bool GetFogEnable() const;

    void SetFogColor(FbxColor pColor);

    FbxColor GetFogColor() const;

    enum EFogMode
    {
        eLinear,                
        eExponential,           
        eExponentialSquareRoot  
    };

    void SetFogMode(EFogMode pMode);

    EFogMode GetFogMode() const;

    void SetFogDensity(double pDensity);

    double GetFogDensity() const;

    void SetFogStart(double pStart);

    double GetFogStart() const;

    void SetFogEnd(double pEnd);

    double GetFogEnd() const;



    struct FBXSDK_DLL ShadowPlane
    {
        ShadowPlane();

        bool mEnable;

        FbxVector4 mOrigin;

        FbxVector4 mNormal; 
    };

    void SetShadowEnable(bool pShadowEnable);

    bool GetShadowEnable() const;

    void SetShadowIntensity(double pShadowIntensity);

    double GetShadowIntensity() const;

    int GetShadowPlaneCount() const;

    ShadowPlane* GetShadowPlane(int pIndex);

    void AddShadowPlane(ShadowPlane pShadowPlane);

    void RemoveAllShadowPlanes();



    FbxError& GetError();

    enum EErrorCode
    {
        eIndexOutOfRange,   
        eErrorCount         
    };

    EErrorCode GetLastErrorID() const;

    const char* GetLastErrorString() const;


    void RestoreDefaultSettings();

    const FbxGlobalLightSettings& operator=(const FbxGlobalLightSettings& pGlobalLightSettings);


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:

    FbxGlobalLightSettings();
    ~FbxGlobalLightSettings();

    FbxGlobalLightSettingsProperties* mPH;

    friend class FbxScene;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_GLOBAL_LIGHT_SETTINGS_H_ */