AgateLib.DisplayLib.LightManager Class Reference

The LightManager class keeps a list of Light objects which can be used to setup the lighting in the rendering API. More...

List of all members.

Public Member Functions
int	AddPointLight (Vector3 position, Color diffuse)
	Adds a point light to the specified position with the given diffuse color.
int	AddPointLight (Vector3 position, Color diffuse, Color ambient)
	Adds a point light to the specified position with the given diffuse and ambient colors.
void	DoLighting ()
	This tells the Display to start use the Lights in this LightManager structure for lighting.
void	RemoveAt (int index)
	Removes a particular light.
void	Add (Light item)
	Adds a Light to the list. If there are more lights than possible, an exception is thrown.
void	Clear ()
	Removes all Lights from the list.
IEnumerator< Light >	GetEnumerator ()
	Enumerates the Lights in the list.
Properties
bool	Enabled [get, set]
	Gets or sets a flag indicating whether or not lighting calculations should be performed.
Color	Ambient [get, set]
	Gets or sets the global ambient light color. This light color is applied to all objects rendered, regardless of their position.
Light	this [int index] [get, set]
	Gets or sets a Light in the list.
int	Count [get]
	Gets the number of Lights in the list.

---

Detailed Description

The LightManager class keeps a list of Light objects which can be used to setup the lighting in the rendering API.

---

Member Function Documentation

void AgateLib.DisplayLib.LightManager.Add

(

Light

item

)

Adds a Light to the list. If there are more lights than possible, an exception is thrown.

Parameters:

item

int AgateLib.DisplayLib.LightManager.AddPointLight	(	Vector3	position,
		Color	diffuse,
		Color	ambient
	)

Adds a point light to the specified position with the given diffuse and ambient colors.

Parameters:

	position
	diffuse
	ambient

Returns:

int AgateLib.DisplayLib.LightManager.AddPointLight	(	Vector3	position,
		Color	diffuse
	)

Adds a point light to the specified position with the given diffuse color.

Parameters:

	position
	diffuse

Returns:

void AgateLib.DisplayLib.LightManager.Clear

(

)

Removes all Lights from the list.

void AgateLib.DisplayLib.LightManager.DoLighting

(

)

This tells the Display to start use the Lights in this LightManager structure for lighting.

IEnumerator<Light> AgateLib.DisplayLib.LightManager.GetEnumerator

(

)

Enumerates the Lights in the list.

Returns:

void AgateLib.DisplayLib.LightManager.RemoveAt

(

int

index

)

Removes a particular light.

Parameters:

index

---

Property Documentation

Color AgateLib.DisplayLib.LightManager.Ambient [get, set]

Gets or sets the global ambient light color. This light color is applied to all objects rendered, regardless of their position.

int AgateLib.DisplayLib.LightManager.Count [get]

Gets the number of Lights in the list.

bool AgateLib.DisplayLib.LightManager.Enabled [get, set]

Gets or sets a flag indicating whether or not lighting calculations should be performed.

Light AgateLib.DisplayLib.LightManager.this[int index] [get, set]

Gets or sets a Light in the list.

Parameters:

index

Returns:

---

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

• DisplayLib/LightManager.cs