com.sun.scenario.effect.light

Class DistantLight

java.lang.Object

com.sun.scenario.effect.light.Light

com.sun.scenario.effect.light.DistantLight

public class DistantLight
extends Light

Represents a distant light source.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.scenario.effect.light.Light

Light.Type

Field Summary

Fields

Modifier and Type	Field and Description
private float	azimuth
private float	elevation

Constructor Summary

Constructors

Constructor and Description
DistantLight() Constructs a new DistantLight with default azimuth (0.0), elevation (0.0), and color (Color4f.WHITE).
DistantLight(float azimuth, float elevation, Color4f color) Constructs a new DistantLight with the given azimuth, elevation, and color.

Method Summary

Modifier and Type	Method and Description
float	getAzimuth() Returns the azimuth of the light.
float	getElevation() Returns the elevation of the light.
float[]	getNormalizedLightPosition() Returns a float array containing the normalized (x,y,z) position of this light source.
void	setAzimuth(float azimuth) Sets the azimuth of the light.
void	setElevation(float elevation) Sets the elevation of the light.

Methods inherited from class com.sun.scenario.effect.light.Light

getColor, getType, setColor

Methods inherited from class java.lang.Object

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

Field Detail

azimuth

private float azimuth

elevation

private float elevation

Constructor Detail

DistantLight

public DistantLight()

Constructs a new DistantLight with default azimuth (0.0), elevation (0.0), and color (Color4f.WHITE).

DistantLight

public DistantLight(float azimuth,
                    float elevation,
                    Color4f color)

Constructs a new DistantLight with the given azimuth, elevation, and color.

Parameters:

azimuth - the azimuth of the light, in degrees

elevation - the elevation of the light, in degrees

color - the color of the light

Throws:

java.lang.IllegalArgumentException - if color is null

Method Detail

getAzimuth

public float getAzimuth()

Returns the azimuth of the light. The azimuth is the direction angle for the light source on the XY plane, in degrees.

Returns:

the azimuth of the light, in degrees

setAzimuth

public void setAzimuth(float azimuth)

Sets the azimuth of the light. The azimuth is the direction angle for the light source on the XY plane, in degrees.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
 

Parameters:

azimuth - the azimuth of the light, in degrees

getElevation

public float getElevation()

Returns the elevation of the light. The elevation is the direction angle for the light source on the YZ plane, in degrees.

Returns:

the elevation of the light, in degrees

setElevation

public void setElevation(float elevation)

Sets the elevation of the light. The elevation is the direction angle for the light source on the YZ plane, in degrees.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
 

Parameters:

elevation - the elevation of the light, in degrees

getNormalizedLightPosition

public float[] getNormalizedLightPosition()

Description copied from class: Light

Returns a float array containing the normalized (x,y,z) position of this light source.

Specified by:

getNormalizedLightPosition in class Light

Returns:

the normalized position of this light source