StdFog Class Reference

This reference page is linked to from the following overview topics: Particle System Plug-ins, Thread Safety, Standard Materials and Textures.

---

Search for all occurrences

#include <stdmat.h>

Inheritance diagram for StdFog:

---

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.

Public Member Functions
virtual void	SetColor (Color c, TimeValue t)=0
virtual void	SetUseMap (BOOL onoff)=0
virtual void	SetUseOpac (BOOL onoff)=0
virtual void	SetColorMap (Texmap *tex)=0
virtual void	SetOpacMap (Texmap *tex)=0
virtual void	SetFogBackground (BOOL onoff)=0
virtual void	SetType (int type)=0
virtual void	SetNear (float v, TimeValue t)=0
virtual void	SetFar (float v, TimeValue t)=0
virtual void	SetTop (float v, TimeValue t)=0
virtual void	SetBottom (float v, TimeValue t)=0
virtual void	SetDensity (float v, TimeValue t)=0
virtual void	SetFalloffType (int tv)=0
virtual void	SetUseNoise (BOOL onoff)=0
virtual void	SetNoiseScale (float v, TimeValue t)=0
virtual void	SetNoiseAngle (float v, TimeValue t)=0
virtual void	SetNoisePhase (float v, TimeValue t)=0
virtual Color	GetColor (TimeValue t)=0
virtual BOOL	GetUseMap ()=0
virtual BOOL	GetUseOpac ()=0
virtual Texmap *	GetColorMap ()=0
virtual Texmap *	GetOpacMap ()=0
virtual BOOL	GetFogBackground ()=0
virtual int	GetType ()=0
virtual float	GetNear (TimeValue t)=0
virtual float	GetFar (TimeValue t)=0
virtual float	GetTop (TimeValue t)=0
virtual float	GetBottom (TimeValue t)=0
virtual float	GetDensity (TimeValue t)=0
virtual int	GetFalloffType ()=0
virtual BOOL	GetUseNoise ()=0
virtual float	GetNoiseScale (TimeValue t)=0
virtual float	GetNoiseAngle (TimeValue t)=0
virtual float	GetNoisePhase (TimeValue t)=0

---

Member Function Documentation

virtual void SetColor	(	Color	c,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the fog color.

Parameters:

Color c

The color to set.

TimeValue t

The time to set the color.

virtual void SetUseMap

(

BOOL

onoff

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the state of the 'Use Map' toggle.

Parameters:

BOOL onoff

TRUE for on; FALSE for off.

virtual void SetUseOpac

(

BOOL

onoff

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the state of the use opacity map toggle.

Parameters:

BOOL onoff

TRUE for on; FALSE for off.

virtual void SetColorMap

(

Texmap *

tex

)

[pure virtual]

Search for all occurrences

Remarks:

Set the color map used.

Parameters:

Texmap *tex

The map to set.

virtual void SetOpacMap

(

Texmap *

tex

)

[pure virtual]

Search for all occurrences

Remarks:

Set the opacity map used.

Parameters:

Texmap *tex

The map to set.

virtual void SetFogBackground

(

BOOL

onoff

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the state of the fog background toggle.

Parameters:

BOOL onoff

TRUE for on; FALSE for off.

virtual void SetType

(

int

type

)

[pure virtual]

Search for all occurrences

Remarks:

Set the type of fog, layered or standard.

Parameters:

int type

The type of fog: 0 = Standard; 1 = Layered.

virtual void SetNear	(	float	v,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the standard fog near percentage.

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]

Search for all occurrences

Remarks:

Sets the standard fog far percentage.

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]

Search for all occurrences

Remarks:

Sets the layered fog top value.

Parameters:

float v

The value to set.

TimeValue t

The time to set the value.

virtual void SetBottom	(	float	v,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the layered fog bottom value.

Parameters:

float v

The value to set.

TimeValue t

The time to set the value.

virtual void SetDensity	(	float	v,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the layered fog density setting.

Parameters:

float v

The value to set (> 0).

TimeValue t

The time to set the value.

virtual void SetFalloffType

(

int

tv

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the falloff type to top, bottom or none.

Parameters:

int tv

One of the following values:

FALLOFF_TOP

FALLOFF_BOTTOM

FALLOFF_NONE

virtual void SetUseNoise

(

BOOL

onoff

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the state of the 'Horizon Noise' toggle.

Parameters:

BOOL onoff

TRUE for on; FALSE for off.

virtual void SetNoiseScale	(	float	v,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

Remarks:

Set the 'Horizon Noise Size' setting.

Parameters:

float v

The value to set.

TimeValue t

The time to set the value.

virtual void SetNoiseAngle	(	float	v,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

Remarks:

Set the 'Horizon Noise Angle' setting.

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]

Search for all occurrences

Remarks:

Set the 'Horizon Noise Phase' setting.

Parameters:

float v

The value to set.

TimeValue t

The time to set the value.

virtual Color GetColor

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the fog color at the time passed.

Parameters:

TimeValue t

The time to get the color.

virtual BOOL GetUseMap

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the state of the 'Use Map' toggle.

Returns:

TRUE is on; FALSE is off.

virtual BOOL GetUseOpac

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the state of the use opacity map toggle.

Returns:

TRUE is on; FALSE is off.

virtual Texmap* GetColorMap

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the color map used.

virtual Texmap* GetOpacMap

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the opacity map used.

virtual BOOL GetFogBackground

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the state of the fog background toggle.

Returns:

TRUE is on; FALSE is off.

virtual int GetType

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the type of fog, layered or standard.

Returns:

The type of fog: 0 = Standard; 1 = Layered.

virtual float GetNear

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the standard fog near percentage.

Parameters:

TimeValue t

The time to get the value.

virtual float GetFar

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the standard fog far percentage.

Parameters:

TimeValue t

The time to get the value.

virtual float GetTop

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the layered fog top value.

Parameters:

TimeValue t

The time to get the value.

virtual float GetBottom

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the layered fog bottom value.

Parameters:

TimeValue t

The time to get the value.

virtual float GetDensity

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the layered fog density setting.

Parameters:

TimeValue t

The time to get the value.

virtual int GetFalloffType

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the falloff type to top, bottom or none.

Returns:

One of the following values:

FALLOFF_TOP

FALLOFF_BOTTOM

FALLOFF_NONE

virtual BOOL GetUseNoise

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the state of the 'Horizon Noise' toggle.

Returns:

TRUE is on; FALSE is off.

virtual float GetNoiseScale

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the 'Horizon Noise Size' setting.

Parameters:

TimeValue t

The time to get the value.

virtual float GetNoiseAngle

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the 'Horizon Noise Angle' setting.

Parameters:

TimeValue t

The time to get the value.

virtual float GetNoisePhase

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the 'Horizon Noise Phase' setting.

Parameters:

TimeValue t

The time to get the value.