#include <stdmat.h>
Class Description
- See also:
- Class Atmospheric, Class Texmap.
- Description:
- This class provides access to the settings of the Standard Fog
Atmospheric plug-in
of 3ds Max. All methods of this class are implemented by the
system.
Member Function Documentation
- Parameters:
- Color c
The color to set.
TimeValue t
The time to set the color.
virtual void SetUseMap |
( |
BOOL |
onoff |
) |
[pure virtual] |
- Parameters:
- BOOL onoff
TRUE for on; FALSE for off.
virtual void SetUseOpac |
( |
BOOL |
onoff |
) |
[pure virtual] |
- Parameters:
- BOOL onoff
TRUE for on; FALSE for off.
virtual void SetColorMap |
( |
Texmap * |
tex |
) |
[pure virtual] |
- Parameters:
- Texmap
*tex
The map to set.
virtual void SetOpacMap |
( |
Texmap * |
tex |
) |
[pure virtual] |
- Parameters:
- Texmap
*tex
The map to set.
virtual void SetFogBackground |
( |
BOOL |
onoff |
) |
[pure virtual] |
- Parameters:
- BOOL onoff
TRUE for on; FALSE for off.
virtual void SetType |
( |
int |
type |
) |
[pure virtual] |
- Parameters:
- int type
The type of fog: 0 = Standard; 1 = Layered.
virtual void SetNear |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set in the range 0 to 1.
TimeValue t
The time to set the value.
virtual void SetFar |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set in the range 0 to 1.
TimeValue t
The time to set the value.
virtual void SetTop |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set.
TimeValue t
The time to set the value.
virtual void SetBottom |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set.
TimeValue t
The time to set the value.
virtual void SetDensity |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set (> 0).
TimeValue t
The time to set the value.
virtual void SetFalloffType |
( |
int |
tv |
) |
[pure virtual] |
- Parameters:
- int tv
One of the following values:
FALLOFF_TOP
FALLOFF_BOTTOM
FALLOFF_NONE
virtual void SetUseNoise |
( |
BOOL |
onoff |
) |
[pure virtual] |
- Parameters:
- BOOL onoff
TRUE for on; FALSE for off.
virtual void SetNoiseScale |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set.
TimeValue t
The time to set the value.
virtual void SetNoiseAngle |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set in radians.
TimeValue t
The time to set the value.
virtual void SetNoisePhase |
( |
float |
v, |
|
|
TimeValue |
t |
|
) |
|
[pure virtual] |
- Parameters:
- float v
The value to set.
TimeValue t
The time to set the value.
- Parameters:
- TimeValue t
The time to get the color.
virtual BOOL GetUseMap |
( |
|
) |
[pure virtual] |
- Returns:
- TRUE is on; FALSE is off.
virtual BOOL GetUseOpac |
( |
|
) |
[pure virtual] |
- Returns:
- TRUE is on; FALSE is off.
virtual Texmap* GetColorMap |
( |
|
) |
[pure virtual] |
virtual Texmap* GetOpacMap |
( |
|
) |
[pure virtual] |
virtual BOOL GetFogBackground |
( |
|
) |
[pure virtual] |
- Returns:
- TRUE is on; FALSE is off.
virtual int GetType |
( |
|
) |
[pure virtual] |
- Returns:
- The type of fog: 0 = Standard; 1 = Layered.
virtual float GetNear |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual float GetFar |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual float GetTop |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual float GetBottom |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual float GetDensity |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual int GetFalloffType |
( |
|
) |
[pure virtual] |
- Returns:
- One of the following values:
FALLOFF_TOP
FALLOFF_BOTTOM
FALLOFF_NONE
virtual BOOL GetUseNoise |
( |
|
) |
[pure virtual] |
- Returns:
- TRUE is on; FALSE is off.
virtual float GetNoiseScale |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual float GetNoiseAngle |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.
virtual float GetNoisePhase |
( |
TimeValue |
t |
) |
[pure virtual] |
- Parameters:
- TimeValue t
The time to get the value.