diguyViewLightSettings Class Reference

Summary: More...

#include <diguyViewLightSettings.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_direction (float x, float y, float z)
	The diguyViewLightSettings equivalent of diguyViewLight::set_direction(). More...
void	get_direction (float *x, float *y, float *z)
	The diguyViewLightSettings equivalent of diguyViewLight::get_direction(). More...
void	set_ambient_color (float r, float g, float b, float a)
	The diguyViewLightSettings equivalent of diguyViewLight::set_ambient_color(). More...
void	get_ambient_color (float *r, float *g, float *b, float *a)
	The diguyViewLightSettings equivalent of diguyViewLight::get_ambient_color(). More...
void	set_diffuse_color (float r, float g, float b, float a)
	The diguyViewLightSettings equivalent of diguyViewLight::set_diffuse_color(). More...
void	get_diffuse_color (float *r, float *g, float *b, float *a)
	The diguyViewLightSettings equivalent of diguyViewLight::get_diffuse_color(). More...
void	set_specular_color (float r, float g, float b, float a)
	The diguyViewLightSettings equivalent of diguyViewLight::set_specular_color(). More...
void	get_specular_color (float *r, float *g, float *b, float *a)
	The diguyViewLightSettings equivalent of diguyViewLight::get_specular_color(). More...

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

Detailed Description

Summary:

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

The settings of a diguyViewLightSettings object cannot be directly applied to a graphics environment viewpoint; the settings must be loaded into a diguyViewLight to be applied.

The diguyViewLightSettings API closely mirrors the diguyViewLight API, with the exception of load and callback functions.

Constructor & Destructor Documentation

diguyViewLightSettings::diguyViewLightSettings ( bdiLight *  light )

private

A private constructor.

Member Function Documentation

const char* diguyViewLightSettings::get_name

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_name().

const char* diguyViewLightSettings::get_type_name

(

)

The diguyViewLightSettings equivalent of diguyViewLight::get_type_name().

void diguyViewLightSettings::set_direction	(	float	x,
		float	y,
		float	z
	)

The diguyViewLightSettings equivalent of diguyViewLight::set_direction().

void diguyViewLightSettings::get_direction	(	float *	x,
		float *	y,
		float *	z
	)

The diguyViewLightSettings equivalent of diguyViewLight::get_direction().

void diguyViewLightSettings::set_ambient_color	(	float	r,
		float	g,
		float	b,
		float	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::set_ambient_color().

void diguyViewLightSettings::get_ambient_color	(	float *	r,
		float *	g,
		float *	b,
		float *	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::get_ambient_color().

void diguyViewLightSettings::set_diffuse_color	(	float	r,
		float	g,
		float	b,
		float	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::set_diffuse_color().

void diguyViewLightSettings::get_diffuse_color	(	float *	r,
		float *	g,
		float *	b,
		float *	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::get_diffuse_color().

void diguyViewLightSettings::set_specular_color	(	float	r,
		float	g,
		float	b,
		float	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::set_specular_color().

void diguyViewLightSettings::get_specular_color	(	float *	r,
		float *	g,
		float *	b,
		float *	a
	)

The diguyViewLightSettings equivalent of diguyViewLight::get_specular_color().

bdiLight* diguyViewLightSettings::get_scripted_object ( )

inline

Friends And Related Function Documentation

friend class bdiLight

friend

Member Data Documentation

bdiLight* diguyViewLightSettings::m_light

private

A pointer to internal data.

---

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

• c:/bdi/include/diguyViewLightSettings.h