Detailed Description

This class contains functions for accessing global light settings.

Remarks:: This class exists for FBX version 6.x and earlier. The new FBX v7.x file format that is now the default no longer uses it. The relevant data (a subset of this class) has been moved to the KFbxGlobalSettings object and should be used instead.

Definition at line 60 of file kfbxgloballightsettings.h.

#include <kfbxgloballightsettings.h>

Classes
struct	KFbxShadowPlane
	Struct used to define the shadow plane. More...
Public Member Functions
void	RestoreDefaultSettings ()
	Restores default settings.
const KFbxGlobalLightSettings &	operator= (const KFbxGlobalLightSettings &pGlobalLightSettings)
	Assignment operator.
Friends
class	KFbxScene
Ambient Color
void	SetAmbientColor (KFbxColor pAmbientColor)
	Sets the ambient color.
KFbxColor	GetAmbientColor () const
	Returns the ambient color.
Fog Option
enum	EFogMode { eLINEAR, eEXPONENTIAL, eSQUAREROOT_EXPONENTIAL }
	Fog types. More...
void	SetFogEnable (bool pEnable)
	Activates or disables the fog.
bool	GetFogEnable () const
	Returns the fog option's current state.
void	SetFogColor (KFbxColor pColor)
	Sets the fog color.
KFbxColor	GetFogColor () const
	Returns the fog color.
void	SetFogMode (EFogMode pMode)
	Sets the fog mode.
EFogMode	GetFogMode () const
	Returns the fog mode.
void	SetFogDensity (double pDensity)
	Sets the fog density.
double	GetFogDensity () const
	Returns the fog density.
void	SetFogStart (double pStart)
	Sets the distance from the view where the fog begins.
double	GetFogStart () const
	Returns the distance from the view where the fog begins.
void	SetFogEnd (double pEnd)
	Sets the distance from the view where the fog ends.
double	GetFogEnd () const
	Returns the distance from the view where the fog ends.
Shadow Planes
The functions in this section are supported only by FiLMBOX version 2.7 and earlier.FiLMBOX 3.0 supports shadow planes within a specific shader, which is not supported by the FBX SDK.
void	SetShadowEnable (bool pShadowEnable)
	Activates or disables the display of shadow planes.
bool	GetShadowEnable () const
	Returns the current state of the shadow enable flag.
void	SetShadowIntensity (double pShadowIntensity)
	Sets the shadow intensity that is applied to all shadow planes.
double	GetShadowIntensity () const
	Returns the shadow intensity applied to all shadow planes.
int	GetShadowPlaneCount () const
	Returns the number of shadow planes.
KFbxShadowPlane *	GetShadowPlane (int pIndex)
	Returns a shadow plane at the specified index.
void	AddShadowPlane (KFbxShadowPlane pShadowPlane)
	Adds a shadow plane.
void	RemoveAllShadowPlanes ()
	Removes all shadow planes.
Error Management
enum	EError { eINDEX_OUT_OF_RANGE, eERROR_COUNT }
	Error identification. More...
KError &	GetError ()
	Retrieves the error object.
EError	GetLastErrorID () const
	Returns the last error code.
const char *	GetLastErrorString () const
	Returns the last error string.

Member Enumeration Documentation

enum EFogMode

Search for all occurrences

Fog types.

eLINEAR
- eEXPONENTIAL
- eSQUAREROOT_EXPONENTIAL

Enumerator:

eLINEAR	Search for all occurrences
eEXPONENTIAL	Search for all occurrences
eSQUAREROOT_EXPONENTIAL	Search for all occurrences

Definition at line 115 of file kfbxgloballightsettings.h.

    {
        eLINEAR,
        eEXPONENTIAL,
        eSQUAREROOT_EXPONENTIAL
    } EFogMode;

enum EError

Search for all occurrences

Error identification.

eINDEX_OUT_OF_RANGE
eERROR_COUNT

Enumerator:

eINDEX_OUT_OF_RANGE	Search for all occurrences
eERROR_COUNT	Search for all occurrences

Definition at line 253 of file kfbxgloballightsettings.h.

    {
        eINDEX_OUT_OF_RANGE,
        eERROR_COUNT
    } EError;

Member Function Documentation

void SetAmbientColor ( KFbxColor pAmbientColor )

Search for all occurrences

Sets the ambient color.

Parameters:

pAmbientColor The ambient color to set.

Remarks:: The ambient color only use RGB channels.

KFbxColor GetAmbientColor ( ) const

Search for all occurrences

Returns the ambient color.

Returns:: The ambient color.

void SetFogEnable ( bool pEnable )

Search for all occurrences

Activates or disables the fog.

Parameters:

pEnable Set to true to activate the fog option or set to false to disable the fog option.

bool GetFogEnable ( ) const

Search for all occurrences

Returns the fog option's current state.

Returns:: True if fog is activated, returns false if fog is disabled.

void SetFogColor ( KFbxColor pColor )

Search for all occurrences

Sets the fog color.

Parameters:

pColor The fog color to be set.

Remarks:: The fog color only uses RGB channels.

KFbxColor GetFogColor ( ) const

Search for all occurrences

Returns the fog color.

Returns:: The fog color.

Remarks:: The fog color only uses RGB channels.

void SetFogMode ( EFogMode pMode )

Search for all occurrences

Sets the fog mode.

Parameters:

pMode The fog type to be set.

EFogMode GetFogMode ( ) const

Search for all occurrences

Returns the fog mode.

Returns:: The currently set fog mode.

void SetFogDensity ( double pDensity )

Search for all occurrences

Sets the fog density.

Parameters:

pDensity The fog density to be set. It can be any double value, however it can happen that other sections of FBX SDK may clamp values to reasonable values.