diguyViewFogSettings Class Reference

The diguyViewFogSettings class holds camera settings data that can be loaded into a diguyViewFog using the diguyViewFog::load_settings() call. More...

#include <diguyViewFogSettings.h>

Public Member Functions
const char *	get_name ()
	The diguyViewLightSettings equivalent of diguyViewLight::get_name(). More...
const char *	get_type_name ()
	The diguyViewLightSettings equivalent of diguyViewLight::get_type_name(). More...
void	set_density (float density)
	The diguyViewLightSettings equivalent of diguyViewLight::set_density(). More...
float	get_density ()
	The diguyViewLightSettings equivalent of diguyViewLight::get_density(). More...
void	set_start (float start)
	The diguyViewLightSettings equivalent of diguyViewLight::set_start(). More...
float	get_start ()
	The diguyViewLightSettings equivalent of diguyViewLight::get_start(). More...
void	set_end (float end)
	The diguyViewLightSettings equivalent of diguyViewLight::set_end(). More...
float	get_end ()
	The diguyViewLightSettings equivalent of diguyViewLight::get_end(). More...
void	set_color (float r, float g, float b, float a)
	The diguyViewLightSettings equivalent of diguyViewLight::set_color(). More...
void	get_color (float *r, float *g, float *b, float *a)
	The diguyViewLightSettings equivalent of diguyViewLight::get_color(). More...
void	set_fog_mode (int mode)
	The diguyViewLightSettings equivalent of diguyViewLight::set_fog_mode(). More...
int	get_fog_mode ()
	The diguyViewLightSettings equivalent of diguyViewLight::get_fog_mode(). More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
bdiFog *	m_fog
	A pointer to internal data. More...
class	bdiFog
bdiFog *	get_scripted_object ()
	diguyViewFogSettings (bdiFog *fog)
	A private constructor. More...

Detailed Description

The diguyViewFogSettings class holds camera settings data that can be loaded into a diguyViewFog using the diguyViewFog::load_settings() call.

The settings of a diguyViewFogSettings object cannot be directly applied to a graphics environment; the settings must be loaded into a diguyViewFog to be applied.

The diguyViewFogSettings API closely mirrors the diguyViewFog API, with the exception of load and callback functions.

Constructor & Destructor Documentation

diguyViewFogSettings::diguyViewFogSettings ( bdiFog *  fog )

private

A private constructor.

Member Function Documentation

const char* diguyViewFogSettings::get_name

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_name().

const char* diguyViewFogSettings::get_type_name

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_type_name().

void diguyViewFogSettings::set_density

(

float

density

)

The diguyViewLightSettings equivalent of diguyViewLight::set_density().

float diguyViewFogSettings::get_density

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_density().

void diguyViewFogSettings::set_start

(

float

start

)

The diguyViewLightSettings equivalent of diguyViewLight::set_start().

float diguyViewFogSettings::get_start

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_start().

void diguyViewFogSettings::set_end

(

float

end

)

The diguyViewLightSettings equivalent of diguyViewLight::set_end().

float diguyViewFogSettings::get_end

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_end().

void diguyViewFogSettings::set_color	(	float	r,
		float	g,
		float	b,
		float	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::set_color().

void diguyViewFogSettings::get_color	(	float *	r,
		float *	g,
		float *	b,
		float *	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::get_color().

void diguyViewFogSettings::set_fog_mode

(

int

mode

)

The diguyViewLightSettings equivalent of diguyViewLight::set_fog_mode().

int diguyViewFogSettings::get_fog_mode

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_fog_mode().

bdiFog* diguyViewFogSettings::get_scripted_object ( )

inline

Friends And Related Function Documentation

friend class bdiFog

friend

Member Data Documentation

bdiFog* diguyViewFogSettings::m_fog

private

A pointer to internal data.

---

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

• C:/Jenkins/jobs/diguy_apps_13.1_vc10_x64/workspace/include/diguyViewFogSettings.h