VgLightRefPtr Class Reference

Public Member Functions
	VgLightRefPtr ()
	VgLightRefPtr (VgLight pPointer)
	VgLightRefPtr (VgLightRefPtr pRefPtr)
VgLightRefPtr	set (VgLight pPointer)
VgLight	__ref__ ()
VgLight	__deref__ ()
VgLight	get ()
boolean	isValid ()
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)
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgLightRefPtr	getNull ()

Detailed Description

This interface handles light management.

Note

Currently only supported on OpenGL ES2.

Version

2.0.8744

Constructor & Destructor Documentation

VgLightRefPtr.VgLightRefPtr

(

)

VgLightRefPtr.VgLightRefPtr

(

VgLight

pPointer

)

VgLightRefPtr.VgLightRefPtr

(

VgLightRefPtr

pRefPtr

)

Member Function Documentation

VgLight VgLightRefPtr.__deref__

(

)

VgLight VgLightRefPtr.__ref__

(

)

VgAnimationRefPtr VgLightRefPtr.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.

VgLight VgLightRefPtr.get

(

)

VgColor VgLightRefPtr.getAmbient

(

)

VgAnimationConstRefPtr VgLightRefPtr.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 VgLightRefPtr.getAnimationNames

(

VgStringList

pNameList

)

Gets the list of the stored animation names.

Parameters

pNameList

The list of strings to feed with the names.

VgColor VgLightRefPtr.getDiffuse

(

)

VgColor VgLightRefPtr.getEmission

(

)

int VgLightRefPtr.getNbReferences

(

)

static VgLightRefPtr VgLightRefPtr.getNull ( )

static

VgOrientation VgLightRefPtr.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 VgLightRefPtr.getPosition

(

)

Gets light's position.

Returns

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

VgColor VgLightRefPtr.getSpecular

(

)

double VgLightRefPtr.getSpotCutoff

(

)

double VgLightRefPtr.getSpotExponent

(

)

boolean VgLightRefPtr.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.

boolean VgLightRefPtr.isValid

(

)

void VgLightRefPtr.ref

(

)

VgLightRefPtr VgLightRefPtr.set

(

VgLight

pPointer

)

void VgLightRefPtr.setAmbient

(

VgColor

pColor

)

Sets the ambient light color for the light.

Parameters

pColor

Ambient light color to set

void VgLightRefPtr.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 VgLightRefPtr.setDiffuse

(

VgColor

pColor

)

Sets the diffuse light color for the light.

Parameters

pColor

Diffuse light color to set

void VgLightRefPtr.setDirectional

(

boolean

pDirectional

)

Sets the light to be directional.

Parameters

pDirectional

True to set the light to be directional

void VgLightRefPtr.setEmission

(

VgColor

pColor

)

Sets the emission light color for the light.

Parameters

pColor

Emission light color to set

void VgLightRefPtr.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 VgLightRefPtr.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 VgLightRefPtr.setSpecular

(

VgColor

pColor

)

Sets the specular light color for the light.

Parameters

pColor

Specular light color to set

void VgLightRefPtr.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 VgLightRefPtr.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

int VgLightRefPtr.unref

(

)

---

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

• VgLightRefPtr.java