KFbxGlobalLightSettings Class Reference

#include <kfbxgloballightsettings.h>

List of all members.

---

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.

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.
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.
Ambient Color
void	SetAmbientColor (KFbxColor pAmbientColor)
	Sets the ambient color.
KFbxColor	GetAmbientColor () const
	Returns the ambient color.
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.
Public Member Functions
void	RestoreDefaultSettings ()
	Restores default settings.
const KFbxGlobalLightSettings &	operator= (const KFbxGlobalLightSettings &pGlobalLightSettings)
	Assignment operator.
Classes
struct	KFbxShadowPlane
	Struct used to define the shadow plane. More...

---

Member Enumeration Documentation

enum EFogMode

Fog types.

• eLINEAR
  • eEXPONENTIAL
  • eSQUAREROOT_EXPONENTIAL

Enumerator:

eLINEAR
eEXPONENTIAL
eSQUAREROOT_EXPONENTIAL

Definition at line 115 of file kfbxgloballightsettings.h.

enum EError

Error identification.

• eINDEX_OUT_OF_RANGE
• eERROR_COUNT

Enumerator:

eINDEX_OUT_OF_RANGE
eERROR_COUNT

Definition at line 253 of file kfbxgloballightsettings.h.

---

Member Function Documentation

void SetAmbientColor

(

KFbxColor

pAmbientColor

)

Sets the ambient color.

Parameters:

pAmbientColor

The ambient color to set.

Remarks:

The ambient color only use RGB channels.

KFbxColor GetAmbientColor

(

)

const

Returns the ambient color.

Returns:

The ambient color.

void SetFogEnable

(

bool

pEnable

)

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

Returns the fog option's current state.

Returns:

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

void SetFogColor

(

KFbxColor

pColor

)

Sets the fog color.

Parameters:

pColor

The fog color to be set.

Remarks:

The fog color only uses RGB channels.

KFbxColor GetFogColor

(

)

const

Returns the fog color.

Returns:

The fog color.

Remarks:

The fog color only uses RGB channels.

void SetFogMode

(

EFogMode

pMode

)

Sets the fog mode.

Parameters:

pMode

The fog type to be set.

EFogMode GetFogMode

(

)

const

Returns the fog mode.

Returns:

The currently set fog mode.

void SetFogDensity

(

double

pDensity

)

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.

Remarks:

This function is only used when the fog mode is set to exponential or square root exponential.

double GetFogDensity

(

)

const

Returns the fog density.

Returns:

The currently set fog density.

Remarks:

This function is only used when the fog mode is set to exponential or square root exponential.

void SetFogStart

(

double

pStart

)

Sets the distance from the view where the fog begins.

Parameters:

pStart

Distance where the fog begins.

Remarks:

This function is only used when the fog mode is set to linear. The new value is clamped to fit inside the interval [0, FogEnd()].

double GetFogStart

(

)

const

Returns the distance from the view where the fog begins.

Returns:

The distance from the view where the fog begins.

Remarks:

This function is only used when the fog mode is set to linear.

void SetFogEnd

(

double

pEnd

)

Sets the distance from the view where the fog ends.

Parameters:

pEnd

Distance where the fog ends.

Remarks:

This function is only used when the fog mode is set to linear. The new value is adjusted to fit within the interval [FogStart(), inf).

double GetFogEnd

(

)

const

Returns the distance from the view where the fog ends.

Returns:

The distance from the view where the fog ends.

Remarks:

This function is only used when the fog mode is set to linear.

void SetShadowEnable

(

bool

pShadowEnable

)

Activates or disables the display of shadow planes.

Parameters:

pShadowEnable

Set to true to display shadow planes in the scene.

bool GetShadowEnable

(

)

const

Returns the current state of the shadow enable flag.

Returns:

True if shadow planes are set to be displayed in the scene.

void SetShadowIntensity

(

double

pShadowIntensity

)

Sets the shadow intensity that is applied to all shadow planes.

Parameters:

pShadowIntensity

Intensity applied to all the shadow planes.

Remarks:

Ranges from 0 to 300.

double GetShadowIntensity

(

)

const

Returns the shadow intensity applied to all shadow planes.

Returns:

The intensity applied to all shadow planes in the scene.

Remarks:

Ranges from 0 to 300.

int GetShadowPlaneCount

(

)

const

Returns the number of shadow planes.

Returns:

Number of shadow planes.

KFbxShadowPlane* GetShadowPlane

(

int

pIndex

)

Returns a shadow plane at the specified index.

Parameters:

pIndex

Shadow plane index.

Returns:

Pointer the shadow plane, or NULL if the index is out of range.

Remarks:

To identify the error, use KFbxGlobalLightSettings::GetLastErrorID() which returns eINDEX_OUT_OF_RANGE.

void AddShadowPlane

(

KFbxShadowPlane

pShadowPlane

)

Adds a shadow plane.

Parameters:

pShadowPlane

The shadow plane to be added.

void RemoveAllShadowPlanes

(

)

Removes all shadow planes.

KError& GetError

(

)

Retrieves the error object.

Returns:

Reference to the error object.

EError GetLastErrorID

(

)

const

Returns the last error code.

Returns:

The last error code.

const char* GetLastErrorString

(

)

const

Returns the last error string.

Returns:

Text description of the last error.

void RestoreDefaultSettings

(

)

Restores default settings.

const KFbxGlobalLightSettings& operator=

(

const KFbxGlobalLightSettings &

pGlobalLightSettings

)

Assignment operator.

Parameters:

pGlobalLightSettings

KFbxGlobalLightSettings object assigned to this one.