com.sun.scenario.effect.light

Class PointLight

java.lang.Object

com.sun.scenario.effect.light.Light

com.sun.scenario.effect.light.PointLight

Direct Known Subclasses:

SpotLight

public class PointLight
extends Light

Represents a light source at a given position in 3D space.

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	x
private float	y
private float	z

Constructor Summary

Constructors

Constructor and Description
PointLight() Constructs a new PointLight with default position (0,0,0) and color (Color4f.WHITE).
PointLight(float x, float y, float z, Color4f color) Constructs a new PointLight with the given position and color.
PointLight(Light.Type type, float x, float y, float z, Color4f color) Package-private constructor.

Method Summary

Modifier and Type	Method and Description
float[]	getNormalizedLightPosition() Returns a float array containing the normalized (x,y,z) position of this light source.
float	getX() Returns the x coordinate of the light position.
float	getY() Returns the y coordinate of the light position.
float	getZ() Returns the z coordinate of the light position.
void	setX(float x) Sets the x coordinate of the light position.
void	setY(float y) Sets the y coordinate of the light position.
void	setZ(float z) Sets the z coordinate of the light position.

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

x

private float x

y

private float y

z

private float z

Constructor Detail

PointLight

public PointLight()

Constructs a new PointLight with default position (0,0,0) and color (Color4f.WHITE).

PointLight

public PointLight(float x,
                  float y,
                  float z,
                  Color4f color)

Constructs a new PointLight with the given position and color.

Parameters:

x - the x coordinate of the light position

y - the y coordinate of the light position

z - the z coordinate of the light position

color - the color of the light

Throws:

java.lang.IllegalArgumentException - if color is null

PointLight

PointLight(Light.Type type,
           float x,
           float y,
           float z,
           Color4f color)

Package-private constructor.

Parameters:

type - the type of the light (either POINT or SPOT)

x - the x coordinate of the light position

y - the y coordinate of the light position

z - the z coordinate of the light position

color - the color of the light

Throws:

java.lang.IllegalArgumentException - if color is null

Method Detail

getX

public float getX()

Returns the x coordinate of the light position.

Returns:

the x coordinate of the light position

setX

public void setX(float x)

Sets the x coordinate of the light position.

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

Parameters:

x - the x coordinate of the light position

getY

public float getY()

Returns the y coordinate of the light position.

Returns:

the y coordinate of the light position

setY

public void setY(float y)

Sets the y coordinate of the light position.

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

Parameters:

y - the y coordinate of the light position

getZ

public float getZ()

Returns the z coordinate of the light position.

Returns:

the z coordinate of the light position

setZ

public void setZ(float z)

Sets the z coordinate of the light position.

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

Parameters:

z - the z coordinate of the light position

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