VgLight Class Reference

Inheritance diagram for VgLight:

Public Member Functions
void	setAnimation (String pAnimationName, VgAnimationRefPtr pAnimation)
VgAnimationConstRefPtr	getAnimation (String pName)
VgAnimationRefPtr	editAnimation (String pName)
void	getAnimationNames (VgStringList pNameList)
VgPosition	getPosition ()
void	setPosition (VgPosition pPosition)
VgOrientation	getOrientation ()
void	setOrientation (VgOrientation pOrientation)
VgColor	getAmbient ()
void	setAmbient (VgColor pColor)
VgColor	getDiffuse ()
void	setDiffuse (VgColor pColor)
VgColor	getSpecular ()
void	setSpecular (VgColor pColor)
VgColor	getEmission ()
void	setEmission (VgColor pColor)
double	getSpotCutoff ()
void	setSpotCutoff (double pCutoff)
double	getSpotExponent ()
void	setSpotExponent (double pExponent)
boolean	isDirectional ()
void	setDirectional (boolean pDirectional)
Public Member Functions inherited from VgReferenced
synchronized void	release ()
	VgReferenced ()
	VgReferenced (VgReferenced pThis)
void	ref ()
int	unref ()
int	getNbReferences ()

Detailed Description

This interface handles light management.

Note

Currently only supported on OpenGL ES2.

Version

2.0.8744

Member Function Documentation

VgAnimationRefPtr VgLight.editAnimation

(

String

pName

)

Gets an animation from the light's animation map for editing.

Parameters

pName

The name of the animation to fetch.

Returns

A reference pointer that is valid if an animation exists by that name in this light.

VgColor VgLight.getAmbient

(

)

VgAnimationConstRefPtr VgLight.getAnimation

(

String

pName

)

Gets an animation from the light's animation map.

Parameters

pName

The name of the animation to fetch.

Returns

A const reference pointer that is valid if an animation exists by that name in this light.

void VgLight.getAnimationNames

(

VgStringList

pNameList

)

Gets the list of the stored animation names.

Parameters

pNameList

The list of strings to feed with the names.

VgColor VgLight.getDiffuse

(

)

VgColor VgLight.getEmission

(

)

VgOrientation VgLight.getOrientation

(

)

Gets lights's orientation.

Returns

The light's orientation. This value is only valid if the spot cut-off is different than -1.0.

VgPosition VgLight.getPosition

(

)

Gets light's position.

Returns

The light's position. This value is ignored if the light is set to be directional.

VgColor VgLight.getSpecular

(

)

double VgLight.getSpotCutoff

(

)

double VgLight.getSpotExponent

(

)

boolean VgLight.isDirectional

(

)

Tell if the light is directional. When a light is directional, every point in the scene is lit along the same direction. The same principle as the light coming from the sun, where all rays are parallel.

Returns

true If the light is directional.

void VgLight.setAmbient

(

VgColor

pColor

)

Sets the ambient light color for the light.

Parameters

pColor

Ambient light color to set

void VgLight.setAnimation	(	String	pAnimationName,
		VgAnimationRefPtr	pAnimation
	)

Sets an animation on this light. As of version 2.0.8744, multiple animations can be set (and played) on a light at the same time. This is the reason why a name has to be provided along with the animation. If an animation already exists in the light with that name, the new one will replace the old one (and the previous one will one less reference to it).

Parameters

pAnimationName	The name to associate the animation with in this spatial
pAnimation	An animation to animate the spatial with.

void VgLight.setDiffuse

(

VgColor

pColor

)

Sets the diffuse light color for the light.

Parameters

pColor

Diffuse light color to set

void VgLight.setDirectional

(

boolean

pDirectional

)

Sets the light to be directional.

Parameters

pDirectional

True to set the light to be directional

void VgLight.setEmission

(

VgColor

pColor

)

Sets the emission light color for the light.

Parameters

pColor

Emission light color to set

void VgLight.setOrientation

(

VgOrientation

pOrientation

)

Sets the light's orientation.

Parameters

pOrientation

The orientation to set on the light. This value is only valid if the spot cut-off is different than -1.0.

void VgLight.setPosition

(

VgPosition

pPosition

)

Sets the light's position.

Parameters

pPosition

The position to put the light at. This value is ignored if the light is set to be directional

void VgLight.setSpecular

(

VgColor

pColor

)

Sets the specular light color for the light.

Parameters

pColor

Specular light color to set

void VgLight.setSpotCutoff

(

double

pCutoff

)

Sets the current spot cutoff value. Valid values are between -1.0 and 1.0 inclusive. Higher values means smaller spot angle.

Parameters

pCutoff

Diffuse light color to set

void VgLight.setSpotExponent

(

double

pExponent

)

Sets the spot exponent. Valid values are greater than 0.0, where higher values give a more concentrated light beam along the spot direction.

Parameters

pExponent

---

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

• VgLight.java