Modifier and Type	Class and Description
public static class	Light.Distant Represents a distant light source.
public static class	Light.Point Represents a light source at a given position in 3D space.
public static class	Light.Spot Represents a spot light source at a given position in 3D space, with configurable direction and focus.

Modifier and Type	Field and Description
private ObjectProperty<Color>	color The color of the light source.
private BooleanProperty	effectDirty
private Light	peer

Access	Constructor and Description
protected	Light() Creates a new Light.

Modifier and Type	Method and Description
pack-priv final void	clearDirty()
public final ObjectProperty<Color>	colorProperty()
pack-priv abstract Light	createPeer()
pack-priv final BooleanProperty	effectDirtyProperty()
public final Color	getColor()
private Color	getColorInternal()
pack-priv Light	getPeer()
pack-priv boolean	isEffectDirty()
pack-priv final void	markDirty()
public final void	setColor(Color value)
private void	setEffectDirty(boolean value)
pack-priv void	sync()
pack-priv void	update()

color	back to summary
private ObjectProperty<Color> color The color of the light source. Min: n/a Max: n/a Default: Color.WHITE Identity: n/a Default Value WHITE

effectDirty	back to summary
private BooleanProperty effectDirty

peer	back to summary
private Light peer

Light	back to summary
protected Light() Creates a new Light.

clearDirty	back to summary
pack-priv final void clearDirty()

colorProperty	back to summary
public final ObjectProperty<Color> colorProperty()

createPeer	back to summary
pack-priv abstract Light createPeer()

effectDirtyProperty	back to summary
pack-priv final BooleanProperty effectDirtyProperty()

getColor	back to summary
public final Color getColor()

getColorInternal	back to summary
private Color getColorInternal()

getPeer	back to summary
pack-priv Light getPeer()

isEffectDirty	back to summary
pack-priv boolean isEffectDirty()

markDirty	back to summary
pack-priv final void markDirty()

setColor	back to summary
public final void setColor(Color value)

setEffectDirty	back to summary
private void setEffectDirty(boolean value)

sync	back to summary
pack-priv void sync()

update	back to summary
pack-priv void update()

public Class Light.Distant

Class Inheritance

extends Light

java.lang.Object
javafx.scene.effect.Light
javafx.scene.effect.Light.Distant

Represents a distant light source.

Example:

Light.Distant light = new Light.Distant();
light.setAzimuth(45.0);
light.setElevation(30.0);

Lighting lighting = new Lighting();
lighting.setLight(light);
lighting.setSurfaceScale(5.0);

Text text = new Text();
text.setText("Distant");
text.setFill(Color.STEELBLUE);
text.setFont(Font.font("null", FontWeight.BOLD, 80));
text.setX(10.0f);
text.setY(10.0f);
text.setTextOrigin(VPos.TOP);
text.setEffect(lighting);

Rectangle rect = new Rectangle(300,150);
rect.setFill(Color.ALICEBLUE);
rect.setEffect(lighting);

The code above produces the following:

The visual effect of distant
Light on text

Since: JavaFX 2.0

Field Summary

Modifier and Type	Field and Description
private DoubleProperty	azimuth The azimuth of the light.
private DoubleProperty	elevation The elevation of the light.

Constructor Summary

Access	Constructor and Description
public	Distant() Creates a new instance of Distant light with default parameters.
public	Distant(double the azimuth of the light azimuth, double the elevation of the light elevation, Color the color of the light color) Creates a new instance of Distant light with the specified azimuth, elevation, and color.

Method Summary

Modifier and Type	Method and Description
public final DoubleProperty	azimuthProperty()
pack-priv DistantLight	createPeer() Implements abstract javafx.scene.effect.Light.createPeer.
public final DoubleProperty	elevationProperty()
public final double	getAzimuth()
public final double	getElevation()
public final void	setAzimuth(double value)
public final void	setElevation(double value)
pack-priv void	update() Overrides javafx.scene.effect.Light.update.

Inherited from javafx.scene.effect.Light:: clearDirty colorProperty effectDirtyProperty getColor getPeer isEffectDirty markDirty setColor sync

Field Detail

azimuth	back to summary
private DoubleProperty azimuth 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: 45.0 Identity: n/a Default Value 45.0

azimuth

back to summary

private DoubleProperty azimuth

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: 45.0
 Identity:  n/a

Default Value: 45.0

elevation	back to summary
private DoubleProperty elevation 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: 45.0 Identity: n/a Default Value 45.0

elevation

back to summary

private DoubleProperty elevation

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: 45.0
 Identity:  n/a

Default Value: 45.0

Constructor Detail

Distant	back to summary
public Distant() Creates a new instance of Distant light with default parameters.

Distant	back to summary
public Distant(double azimuth, double elevation, Color color) Creates a new instance of Distant light with the specified azimuth, elevation, and color. Parameters azimuth:double the azimuth of the light elevation:double the elevation of the light color:Color the color of the light Since JavaFX 2.1

Distant

back to summary

public Distant(double azimuth, double elevation, Color color)

Creates a new instance of Distant light with the specified azimuth, elevation, and color.

Parameters

azimuth:double: the azimuth of the light
elevation:double: the elevation of the light
color:Color: the color of the light

Since

JavaFX 2.1

Method Detail

azimuthProperty	back to summary
public final DoubleProperty azimuthProperty()

createPeer	back to summary
pack-priv DistantLight createPeer() Implements abstract javafx.scene.effect.Light.createPeer. Annotations @Override

createPeer

back to summary

pack-priv DistantLight createPeer()

Implements abstract javafx.scene.effect.Light.createPeer.

Annotations

@Override

elevationProperty	back to summary
public final DoubleProperty elevationProperty()

getAzimuth	back to summary
public final double getAzimuth()

getElevation	back to summary
public final double getElevation()

setAzimuth	back to summary
public final void setAzimuth(double value)

setElevation	back to summary
public final void setElevation(double value)

update	back to summary
pack-priv void update() Overrides javafx.scene.effect.Light.update. Annotations @Override

update

back to summary

pack-priv void update()

Overrides javafx.scene.effect.Light.update.

Annotations

@Override

javafx.scene.effect back to summary

public Class Light.Point

Class Inheritance

extends Light

java.lang.Object
javafx.scene.effect.Light
javafx.scene.effect.Light.Point

Known Direct Subclasses

javafx.scene.effect.Light.Spot

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

Example:

Light.Point light = new Light.Point();
light.setX(100);
light.setY(100);
light.setZ(50);

Lighting lighting = new Lighting();
lighting.setLight(light);
lighting.setSurfaceScale(5.0);

Text text = new Text();
text.setText("Point");
text.setFill(Color.STEELBLUE);
text.setFont(Font.font(null, FontWeight.BOLD, 80));
text.setX(10.0);
text.setY(10.0);
text.setTextOrigin(VPos.TOP);

Rectangle rect = new Rectangle(250, 150);
rect.setFill(Color.ALICEBLUE);
rect.setEffect(lighting);
text.setEffect(lighting);

The code above produces the following:

The visual effect of point
Light on text

Since: JavaFX 2.0

Field Summary

Modifier and Type	Field and Description
private DoubleProperty	x The x coordinate of the light position.
private DoubleProperty	y The y coordinate of the light position.
private DoubleProperty	z The z coordinate of the light position.

Constructor Summary

Access	Constructor and Description
public	Point() Creates a new instance of Point light with default parameters.
public	Point(double the x coordinate of the light position x, double the y coordinate of the light position y, double the z coordinate of the light position z, Color the color of the light color) Creates a new instance of Point light with the specified x, y, x, and color.

Method Summary

Modifier and Type	Method and Description
pack-priv PointLight	createPeer() Implements abstract javafx.scene.effect.Light.createPeer.
public final double	getX()
public final double	getY()
public final double	getZ()
public final void	setX(double value)
public final void	setY(double value)
public final void	setZ(double value)
pack-priv void	update() Overrides javafx.scene.effect.Light.update.
public final DoubleProperty	xProperty()
public final DoubleProperty	yProperty()
public final DoubleProperty	zProperty()

Inherited from javafx.scene.effect.Light:: clearDirty colorProperty effectDirtyProperty getColor getPeer isEffectDirty markDirty setColor sync

Field Detail

x	back to summary
private DoubleProperty x The x coordinate of the light position. Min: n/a Max: n/a Default: 0.0 Identity: n/a Default Value 0.0

back to summary

private DoubleProperty x

The x coordinate of the light position.

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

Default Value: 0.0

y	back to summary
private DoubleProperty y The y coordinate of the light position. Min: n/a Max: n/a Default: 0.0 Identity: n/a Default Value 0.0

back to summary

private DoubleProperty y

The y coordinate of the light position.

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

Default Value: 0.0

z	back to summary
private DoubleProperty z The z coordinate of the light position. Min: n/a Max: n/a Default: 0.0 Identity: n/a Default Value 0.0

back to summary

private DoubleProperty z

The z coordinate of the light position.

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

Default Value: 0.0

Constructor Detail

Point	back to summary
public Point() Creates a new instance of Point light with default parameters.

Point	back to summary
public Point(double x, double y, double z, Color color) Creates a new instance of Point light with the specified x, y, x, and color. Parameters x:double the x coordinate of the light position y:double the y coordinate of the light position z:double the z coordinate of the light position color:Color the color of the light Since JavaFX 2.1

Point

back to summary

public Point(double x, double y, double z, Color color)

Creates a new instance of Point light with the specified x, y, x, and color.

Parameters

x:double: the x coordinate of the light position
y:double: the y coordinate of the light position
z:double: the z coordinate of the light position
color:Color: the color of the light

Since

JavaFX 2.1

Method Detail

createPeer	back to summary
pack-priv PointLight createPeer() Implements abstract javafx.scene.effect.Light.createPeer. Annotations @Override

createPeer

back to summary

pack-priv PointLight createPeer()

Implements abstract javafx.scene.effect.Light.createPeer.

Annotations

@Override

getX	back to summary
public final double getX()

getY	back to summary
public final double getY()

getZ	back to summary
public final double getZ()

setX	back to summary
public final void setX(double value)

setY	back to summary
public final void setY(double value)

setZ	back to summary
public final void setZ(double value)

update

back to summary

pack-priv void update()

Overrides javafx.scene.effect.Light.update.

Annotations

@Override

xProperty	back to summary
public final DoubleProperty xProperty()

yProperty	back to summary
public final DoubleProperty yProperty()

zProperty	back to summary
public final DoubleProperty zProperty()

javafx.scene.effect back to summary

public Class Light.Spot

Class Inheritance

extends Point

Represents a spot light source at a given position in 3D space, with configurable direction and focus.

Example:

Light.Spot light = new Light.Spot();
light.setX(150);
light.setY(100);
light.setZ(80);
light.setPointsAtX(0);
light.setPointsAtY(0);
light.setPointsAtZ(-50);
light.setSpecularExponent(2);

Lighting lighting = new Lighting();
lighting.setLight(light);
lighting.setSurfaceScale(5.0);

Text text = new Text();
text.setText("Spot");
text.setFill(Color.STEELBLUE);
text.setFont(Font.font(null, FontWeight.BOLD, 80));
text.setX(10.0);
text.setY(10.0);
text.setTextOrigin(VPos.TOP);
text.setEffect(lighting);

Rectangle rect = new Rectangle(200, 150);
rect.setFill(Color.ALICEBLUE);
rect.setEffect(lighting);

The code above produces the following:

The visual effect of spot Light
on text

Since: JavaFX 2.0

Field Summary

Modifier and Type	Field and Description
private DoubleProperty	pointsAtX The x coordinate of the direction vector for this light.
private DoubleProperty	pointsAtY The y coordinate of the direction vector for this light.
private DoubleProperty	pointsAtZ The z coordinate of the direction vector for this light.
private DoubleProperty	specularExponent The specular exponent, which controls the focus of this light source.

Constructor Summary

Access	Constructor and Description
public	Spot() Creates a new instance of Spot light with default parameters.
public	Spot(double the x coordinate of the light position x, double the y coordinate of the light position y, double the z coordinate of the light position z, double the specular exponent, which controls the focus of the light source specularExponent, Color the color of the light color) Creates a new instance of Spot light with the specified x, y, z, specularExponent, and color.

Method Summary

Modifier and Type	Method and Description
pack-priv SpotLight	createPeer() Overrides javafx.scene.effect.Light.Point.createPeer.
public final double	getPointsAtX()
public final double	getPointsAtY()
public final double	getPointsAtZ()
public final double	getSpecularExponent()
public final DoubleProperty	pointsAtXProperty()
public final DoubleProperty	pointsAtYProperty()
public final DoubleProperty	pointsAtZProperty()
public final void	setPointsAtX(double value)
public final void	setPointsAtY(double value)
public final void	setPointsAtZ(double value)
public final void	setSpecularExponent(double value)
public final DoubleProperty	specularExponentProperty()
pack-priv void	update() Overrides javafx.scene.effect.Light.Point.update.

Inherited from javafx.scene.effect.Light.Point:: getX getY getZ setX setY setZ xProperty yProperty zProperty

Field Detail

pointsAtX

back to summary

private DoubleProperty pointsAtX

The x coordinate of the direction vector for this light.

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

Default Value: 0.0

pointsAtY

back to summary

private DoubleProperty pointsAtY

The y coordinate of the direction vector for this light.

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

Default Value: 0.0

pointsAtZ

back to summary

private DoubleProperty pointsAtZ

The z coordinate of the direction vector for this light.

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

Default Value: 0.0

specularExponent

back to summary

private DoubleProperty specularExponent

The specular exponent, which controls the focus of this light source.

      Min: 0.0
      Max: 4.0
  Default: 1.0
 Identity: 1.0

Default Value: 1.0

Constructor Detail

Spot	back to summary
public Spot() Creates a new instance of Spot light with default parameters.

Spot

back to summary

public Spot(double x, double y, double z, double specularExponent, Color color)

Creates a new instance of Spot light with the specified x, y, z, specularExponent, and color.

Parameters

x:double: the x coordinate of the light position
y:double: the y coordinate of the light position
z:double: the z coordinate of the light position
specularExponent:double: the specular exponent, which controls the focus of the light source
color:Color: the color of the light

Since

JavaFX 2.1

Method Detail

createPeer

back to summary

pack-priv SpotLight createPeer()

Overrides javafx.scene.effect.Light.Point.createPeer.

Annotations

@Override

getPointsAtX	back to summary
public final double getPointsAtX()

getPointsAtY	back to summary
public final double getPointsAtY()

getPointsAtZ	back to summary
public final double getPointsAtZ()

getSpecularExponent	back to summary
public final double getSpecularExponent()

pointsAtXProperty	back to summary
public final DoubleProperty pointsAtXProperty()

pointsAtYProperty	back to summary
public final DoubleProperty pointsAtYProperty()

pointsAtZProperty	back to summary
public final DoubleProperty pointsAtZProperty()

setPointsAtX	back to summary
public final void setPointsAtX(double value)

setPointsAtY	back to summary
public final void setPointsAtY(double value)

setPointsAtZ	back to summary
public final void setPointsAtZ(double value)

setSpecularExponent	back to summary
public final void setSpecularExponent(double value)

specularExponentProperty	back to summary
public final DoubleProperty specularExponentProperty()

update

back to summary

pack-priv void update()

Overrides javafx.scene.effect.Light.Point.update.

Annotations

@Override

public abstract Class Light

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Light.Distant

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Light.Point

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Light.Spot

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail