javafx.scene.effect

Class Light.Distant

java.lang.Object

javafx.scene.effect.Light

javafx.scene.effect.Light.Distant

Enclosing class:

Light

public static class Light.Distant
extends Light

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:

Since:

JavaFX 2.0

Nested Class Summary

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

Light.Distant, Light.Point, Light.Spot

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DoubleProperty	azimuthProperty()
DoubleProperty	elevationProperty()
double	getAzimuth()
double	getElevation()
(package private) DistantLight	impl_createImpl()
(package private) void	impl_update()
void	setAzimuth(double value)
void	setElevation(double value)

Methods inherited from class javafx.scene.effect.Light

colorProperty, effectDirtyProperty, getColor, impl_clearDirty, impl_getImpl, impl_isEffectDirty, impl_markDirty, impl_sync, setColor

Methods inherited from class java.lang.Object

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

Field Detail

azimuth

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
 

elevation

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
 

Constructor Detail

Distant

public Distant()

Creates a new instance of Distant light with default parameters.

Distant

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

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

Parameters:

azimuth - the azimuth of the light

elevation - the elevation of the light

color - the color of the light

Since:

JavaFX 2.1

Method Detail

impl_createImpl

DistantLight impl_createImpl()

Specified by:

impl_createImpl in class Light

setAzimuth

public final void setAzimuth(double value)

getAzimuth

public final double getAzimuth()

azimuthProperty

public final DoubleProperty azimuthProperty()

setElevation

public final void setElevation(double value)

getElevation

public final double getElevation()

elevationProperty

public final DoubleProperty elevationProperty()

impl_update

void impl_update()

Overrides:

impl_update in class Light