com.sun.scenario.effect.light

Class Light

java.lang.Object

com.sun.scenario.effect.light.Light

Direct Known Subclasses:

DistantLight, PointLight

public abstract class Light
extends java.lang.Object

The abstract base class for all light implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Light.Type The light type.

Field Summary

Fields

Modifier and Type	Field and Description
private Color4f	color
private Light.Type	type

Constructor Summary

Constructors

Constructor and Description
Light(Light.Type type) Package-private constructor.
Light(Light.Type type, Color4f color) Package-private constructor.

Method Summary

Modifier and Type	Method and Description
Color4f	getColor() Returns the light color.
abstract float[]	getNormalizedLightPosition() Returns a float array containing the normalized (x,y,z) position of this light source.
Light.Type	getType() Returns the light Type, either DISTANT, POINT, or SPOT.
void	setColor(Color4f color) Sets the light color.

Methods inherited from class java.lang.Object

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

Field Detail

type

private final Light.Type type

color

private Color4f color

Constructor Detail

Light

Light(Light.Type type)

Package-private constructor.

Parameters:

type - the type of the light

Throws:

java.lang.IllegalArgumentException - if color is null

Light

Light(Light.Type type,
      Color4f color)

Package-private constructor.

Parameters:

type - the type of the light

color - the color of the light

Throws:

java.lang.IllegalArgumentException - if color is null

Method Detail

getType

public Light.Type getType()

Returns the light Type, either DISTANT, POINT, or SPOT.

Returns:

the light type

getColor

public Color4f getColor()

Returns the light color.

Returns:

the light color

setColor

public void setColor(Color4f color)

Sets the light color.

       Min: n/a
       Max: n/a
   Default: Color4f.WHITE
  Identity: n/a
 

Parameters:

color - the light color

Throws:

java.lang.IllegalArgumentException - if color is null

getNormalizedLightPosition

public abstract float[] getNormalizedLightPosition()

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

Returns:

the normalized position of this light source