CSLFog Class Reference

Describes the fog (depth fading) in a scene. More...

#include <Fog.h>

Inheritance diagram for CSLFog:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EFogType {
  SI_VERTEX,
  SI_PIXEL
}
enum   EFogInterpolationType {
  SI_LINEAR,
  SI_EXPONENTIAL
}

Public Member Functions
  CSLFog (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLFog ()
EFogType  GetFogType ()
SI_Void  SetFogType (EFogType in_Type)
EFogInterpolationType  GetFogInterpolationType ()
SI_Void  SetFogInterpolationType (EFogInterpolationType in_Type)
CSIBCColorf  GetColor ()
SI_Void  SetColor (CSIBCColorf &in_rColor)
SI_Float  GetNear ()
SI_Void  SetNear (SI_Float in_fValue)
SI_Float  GetFar ()
SI_Void  SetFar (SI_Float in_fValue)
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
virtual ETemplateType  Type ()

Detailed Description

Describes the fog (depth fading) in a scene.

Member Enumeration Documentation

enum EFogType

This enum list the possible type for the fog.

Enumerator:
SI_VERTEX  per vertex fog
SI_PIXEL  per pixel fog

enum EFogInterpolationType

This enum list the possible interpolation type for the fog.

Enumerator:
SI_LINEAR  Fog linear interpolation.
SI_EXPONENTIAL  Fog Exponential interpolation.

Constructor & Destructor Documentation

CSLFog ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Parent Template
Returns:
an instance of CSLFog

virtual ~CSLFog (  )  [virtual]

Destructor

Member Function Documentation

EFogType GetFogType (  )  [inline]

Return the type of the fog.

Returns:
EFogType Type of fog.

SI_Void SetFogType ( EFogType  in_Type  )  [inline]

Change the type of the fog.

Parameters:
in_Type  New fog type.
Returns:
SI_Void.

EFogInterpolationType GetFogInterpolationType (  )  [inline]

Return the type of interpolation of the fog.

Returns:
EFogInterpolationType Type of fog interpolation.

SI_Void SetFogInterpolationType ( EFogInterpolationType  in_Type  )  [inline]

Change the type of interpolation of the fog.

Parameters:
in_Type  New fog interpolation type.
Returns:
SI_Void.

CSIBCColorf GetColor (  )  [inline]

Returns the color of the fog.

Returns:
CSIBCColorf Fog color.

SI_Void SetColor ( CSIBCColorf &  in_rColor  )  [inline]

Changes the color of the fog.

Parameters:
in_rColor  New fog color.
Returns:
SI_Void.

SI_Float GetNear (  )  [inline]

Returns the distance at which fog starts.

Returns:
SI_Float Start distance.

SI_Void SetNear ( SI_Float  in_fValue  )  [inline]

Changes the distance at which fog starts.

Parameters:
in_fValue  New start distance.
Returns:
SI_Void.

SI_Float GetFar (  )  [inline]

Returns the distance at which fog stops.

Returns:
SI_Float Stop distance.

SI_Void SetFar ( SI_Float  in_fValue  )  [inline]

Changes the distance at which fog stops.

Parameters:
in_fValue  New stop distance.
Returns:
SI_Void.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Gets a handle on one of this fog's parameters by using its name

Parameters:
in_szName  the name of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szParameterName  
) [virtual]

Gets a handle on one of this fog's parameters by using its name and type

Parameters:
in_szParameterName  the name of the parameter to get the handle from
in_Type  the type of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Returns:
ETemplateType The type of this template

Implements CSLTemplate.

The documentation for this class was generated from the following file: