Microsoft.Xna.Framework.Graphics

Class DirectionalLight

java.lang.Object

Microsoft.Xna.Framework.Graphics.DirectionalLight

public final class DirectionalLight
extends java.lang.Object

Represents a DirectionalLight object.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
boolean	Enabled Gets or sets light enable flag.

Constructor Summary

Constructors

Constructor and Description
DirectionalLight(EffectParameter directionParameter, EffectParameter diffuseColorParameter, EffectParameter specularColorParameter, DirectionalLight cloneSource) Creates a new DirectionalLight instance, with or without a copy of a DirectionalLight instance.

Method Summary

Methods

Modifier and Type	Method and Description
Vector3	getDiffuseColor() Gets or sets the diffuse color of the light.
Vector3	getDirection() Gets the light direction.
Vector3	getSpecularColor() Gets the specular color of the light.
void	setDiffuseColor(Vector3 value) Sets the diffuse color of the light.
void	setDirection(Vector3 value) Sets the light direction.
void	setSpecularColor(Vector3 value) Sets the specular color of the light.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Enabled

public boolean Enabled

Gets or sets light enable flag.

Constructor Detail

DirectionalLight

public DirectionalLight(EffectParameter directionParameter,
                EffectParameter diffuseColorParameter,
                EffectParameter specularColorParameter,
                DirectionalLight cloneSource)

Creates a new DirectionalLight instance, with or without a copy of a DirectionalLight instance.

Parameters:

directionParameter - The light direction.

diffuseColorParameter - The diffuse color.

specularColorParameter - The specular color.

cloneSource - The cloned instance to copy from.

Method Detail

getDiffuseColor

public Vector3 getDiffuseColor()

Gets or sets the diffuse color of the light.

Returns:

The diffuse color of the light.

setDiffuseColor

public void setDiffuseColor(Vector3 value)

Sets the diffuse color of the light.

Parameters:

value - The new diffuse color of the light.

getDirection

public Vector3 getDirection()

Gets the light direction.

Returns:

The light direction.

setDirection

public void setDirection(Vector3 value)

Sets the light direction. This value must be a unit vector.

Parameters:

value - The new direction of the light.

getSpecularColor

public Vector3 getSpecularColor()

Gets the specular color of the light.

Returns:

The specular color of the light.

setSpecularColor

public void setSpecularColor(Vector3 value)

Sets the specular color of the light.

Parameters:

value - The new specular color of the light.