Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

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

Public Methods


Detailed Description

Describes the fog (depth fading) in a scene.


Member Enumeration Documentation

enum CSLFog::EFogInterpolationType
 

This enum list the possible interpolation type for the fog.

Enumeration values:
SI_LINEAR  Fog linear interpolation.
SI_EXPONENTIAL  Fog Exponential interpolation.

enum CSLFog::EFogType
 

This enum list the possible type for the fog.

Enumeration values:
SI_VERTEX  per vertex fog.
SI_PIXEL  per pixel fog.


Constructor & Destructor Documentation

CSLFog::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

CSLFog::~CSLFog   [virtual]
 

Destructor


Member Function Documentation

CSIBCColorf CSLFog::GetColor   [inline]
 

Returns the color of the fog.

Returns:
CSIBCColorf Fog color.

SI_Float CSLFog::GetFar   [inline]
 

Returns the distance at which fog stops.

Returns:
SI_Float Stop distance.

EFogInterpolationType CSLFog::GetFogInterpolationType   [inline]
 

Return the type of interpolation of the fog.

Returns:
EFogInterpolationType Type of fog interpolation.

EFogType CSLFog::GetFogType   [inline]
 

Return the type of the fog.

Returns:
EFogType Type of fog.

SI_Float CSLFog::GetNear   [inline]
 

Returns the distance at which fog starts.

Returns:
SI_Float Start distance.

CSLAnimatableType * CSLFog::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.

CSLAnimatableType * CSLFog::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.

SI_Void CSLFog::SetColor CSIBCColorf   in_rColor [inline]
 

Changes the color of the fog.

Parameters:
in_rColor  New fog color.
Returns:
SI_Void.

SI_Void CSLFog::SetFar SI_Float    in_fValue [inline]
 

Changes the distance at which fog stops.

Parameters:
in_fValue  New stop distance.
Returns:
SI_Void.

SI_Void CSLFog::SetFogInterpolationType EFogInterpolationType    in_Type [inline]
 

Change the type of interpolation of the fog.

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

SI_Void CSLFog::SetFogType EFogType    in_Type [inline]
 

Change the type of the fog.

Parameters:
in_Type  New fog type.
Returns:
SI_Void.

SI_Void CSLFog::SetNear SI_Float    in_fValue [inline]
 

Changes the distance at which fog starts.

Parameters:
in_fValue  New start distance.
Returns:
SI_Void.

virtual ETemplateType CSLFog::Type   [inline, virtual]
 

Returns the type of this template

Returns:
ETemplateType The type of this template

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.