javafx.scene.effect

Class Light.Spot

java.lang.Object

javafx.scene.effect.Light

javafx.scene.effect.Light.Point

javafx.scene.effect.Light.Spot

Enclosing class:

Light

public static class Light.Spot
extends Light.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:

Since:

JavaFX 2.0

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Light

Light.Distant, Light.Point, Light.Spot

Constructor Summary

Constructors

Constructor and Description
Spot() Creates a new instance of Spot light with default parameters.
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.

Method Summary

Modifier and Type	Method and Description
double	getPointsAtX()
double	getPointsAtY()
double	getPointsAtZ()
double	getSpecularExponent()
DoubleProperty	pointsAtXProperty()
DoubleProperty	pointsAtYProperty()
DoubleProperty	pointsAtZProperty()
void	setPointsAtX(double value)
void	setPointsAtY(double value)
void	setPointsAtZ(double value)
void	setSpecularExponent(double value)
DoubleProperty	specularExponentProperty()

Methods inherited from class javafx.scene.effect.Light.Point

getX, getY, getZ, setX, setY, setZ, xProperty, yProperty, zProperty

Methods inherited from class javafx.scene.effect.Light

colorProperty, getColor, setColor

Methods inherited from class java.lang.Object

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

Constructor Detail

Spot

public Spot()

Creates a new instance of Spot light with default parameters.

Spot

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 - the x coordinate of the light position

y - the y coordinate of the light position

z - the z coordinate of the light position

specularExponent - the specular exponent, which controls the focus of the light source

color - the color of the light

Since:

JavaFX 2.1

Method Detail

setPointsAtX

public final void setPointsAtX(double value)

getPointsAtX

public final double getPointsAtX()

pointsAtXProperty

public final DoubleProperty pointsAtXProperty()

setPointsAtY

public final void setPointsAtY(double value)

getPointsAtY

public final double getPointsAtY()

pointsAtYProperty

public final DoubleProperty pointsAtYProperty()

setPointsAtZ

public final void setPointsAtZ(double value)

getPointsAtZ

public final double getPointsAtZ()

pointsAtZProperty

public final DoubleProperty pointsAtZProperty()

setSpecularExponent

public final void setSpecularExponent(double value)

getSpecularExponent

public final double getSpecularExponent()

specularExponentProperty

public final DoubleProperty specularExponentProperty()