JavaFX 25 · javafx.scene.SpotLight · APIdia, the JavaDoc alternative

A light source that radiates light in a cone in a specific direction away from itself. The direction is defined by the direction vector property.

In addition to the attenuation factors that control the light intensity over distance, a SpotLight has a light-cone attenuation factor, spot, that is determined by 3 properties:

innerAngle: the angle of the inner cone (see image below)
outerAngle: the angle of the outer cone (see image below)
falloff: the factor that controls the light's intensity drop inside the outer cone

The valid ranges for these properties are 0 <= innerAngle <= outerAngle <= 180 and falloff >= 0; values outside either of these ranges can produce unexpected results.

The angle of a point to the light is defined as the angle between its vector to the light's position and the direction of the light. For such an angle theta, if

theta < innerAngle then spot = 1
theta > outerAngle then spot = 0
innerAngle <= theta <= outerAngle then
```
spot = pow((cos(theta) - cos(outer)) / (cos(inner) - cos(outer)), falloff)
```
which represents a drop in intensity from the inner angle to the outer angle.

As a result, 0 <= spot <= 1. The overall intensity of the light is I = lambert * atten * spot.

SpotLights can represent point-like light sources with directionality. Flashlights and floodlights are common light sources that can be simulated with this light type.

Image of the Spotlight

Field Summary

Modifier and Type	Field and Description
private static final Point3D	DEFAULT_DIRECTION
private static final double	DEFAULT_FALLOFF
private static final double	DEFAULT_INNER_ANGLE
private static final double	DEFAULT_OUTER_ANGLE
private ObjectProperty<Point3D>	direction The direction vector of the spotlight.
private DoubleProperty	falloff The intensity falloff factor of the spotlight's outer cone.
private DoubleProperty	innerAngle The angle of the spotlight's inner cone, in degrees.
private DoubleProperty	outerAngle The angle of the spotlight's outer cone, in degrees (as shown in the class doc image).

Constructor Summary

Access	Constructor and Description
public	SpotLight() Creates a new instance of `SpotLight` class with a default `Color.WHITE` light source.
public	SpotLight(Color the color of the light source color) Creates a new instance of `SpotLight` class using the specified color.

Modifier and Type	Method and Description
public final ObjectProperty<Point3D>	directionProperty()
private NGNode	doCreatePeer() Hides javafx.scene.PointLight.doCreatePeer.
private void	doUpdatePeer() Hides javafx.scene.PointLight.doUpdatePeer.
public final DoubleProperty	falloffProperty()
public final Point3D	getDirection()
public final double	getFalloff()
public final double	getInnerAngle()
public final double	getOuterAngle()
public final DoubleProperty	innerAngleProperty()
public final DoubleProperty	outerAngleProperty()
public final void	setDirection(Point3D value)
public final void	setFalloff(double value)
public final void	setInnerAngle(double value)
public final void	setOuterAngle(double value)

Field Detail

DEFAULT_DIRECTION	back to summary
private static final Point3D DEFAULT_DIRECTION

DEFAULT_FALLOFF	back to summary
private static final double DEFAULT_FALLOFF

DEFAULT_INNER_ANGLE	back to summary
private static final double DEFAULT_INNER_ANGLE

DEFAULT_OUTER_ANGLE	back to summary
private static final double DEFAULT_OUTER_ANGLE

direction back to summary

direction	back to summary
private ObjectProperty<Point3D> direction The direction vector of the spotlight. It can be rotated by setting a rotation transform on the `SpotLight`. The vector need not be normalized. Default Value `Point3D(0, 0, 1)`

private ObjectProperty<Point3D> direction

The direction vector of the spotlight. It can be rotated by setting a rotation transform on the SpotLight. The vector need not be normalized.

Default Value: Point3D(0, 0, 1)

falloff back to summary

falloff	back to summary
private DoubleProperty falloff The intensity falloff factor of the spotlight's outer cone. A point whose angle to the light is greater than the inner angle but less than the outer angle receives partial intensity governed by this factor. The larger the falloff, the sharper the drop in intensity from the inner cone. A falloff factor of 1 gives a linear drop in intensity, values greater than 1 give a convex drop, and values smaller than 1 give a concave drop. See the class doc for more information. The valid range is `0 <= falloff`; values outside of this range can produce unexpected results. Default Value 1

private DoubleProperty falloff

The intensity falloff factor of the spotlight's outer cone. A point whose angle to the light is greater than the inner angle but less than the outer angle receives partial intensity governed by this factor. The larger the falloff, the sharper the drop in intensity from the inner cone. A falloff factor of 1 gives a linear drop in intensity, values greater than 1 give a convex drop, and values smaller than 1 give a concave drop. See the class doc for more information.

The valid range is 0 <= falloff; values outside of this range can produce unexpected results.

Default Value: 1

innerAngle back to summary

innerAngle	back to summary
private DoubleProperty innerAngle The angle of the spotlight's inner cone, in degrees. A point whose angle to the light is less than this angle is not attenuated by the spotlight factor (`spot = 1`). At larger angles, the light intensity starts to drop. See the class doc for more information. The valid range is `0 <= innerAngle <= outerAngle`; values outside of this range can produce unexpected results. Default Value 0

private DoubleProperty innerAngle

The angle of the spotlight's inner cone, in degrees. A point whose angle to the light is less than this angle is not attenuated by the spotlight factor (spot = 1). At larger angles, the light intensity starts to drop. See the class doc for more information.

The valid range is 0 <= innerAngle <= outerAngle; values outside of this range can produce unexpected results.

Default Value: 0

outerAngle back to summary

outerAngle	back to summary
private DoubleProperty outerAngle The angle of the spotlight's outer cone, in degrees (as shown in the class doc image). A point whose angle to the light is greater than this angle receives no light (`spot = 0`). A point whose angle to the light is less than the outer angle but greater than the inner angle receives partial intensity governed by the falloff factor. See the class doc for more information. The valid range is `innerAngle <= outerAngle <= 180`; values outside of this range can produce unexpected results. Default Value 30

private DoubleProperty outerAngle

The angle of the spotlight's outer cone, in degrees (as shown in the class doc image). A point whose angle to the light is greater than this angle receives no light (spot = 0). A point whose angle to the light is less than the outer angle but greater than the inner angle receives partial intensity governed by the falloff factor. See the class doc for more information.

The valid range is innerAngle <= outerAngle <= 180; values outside of this range can produce unexpected results.

Default Value: 30

Constructor Detail

SpotLight	back to summary
public SpotLight() Creates a new instance of `SpotLight` class with a default `Color.WHITE` light source.

SpotLight back to summary

SpotLight	back to summary
public SpotLight(Color color) Creates a new instance of `SpotLight` class using the specified color. Parameters color:Color the color of the light source

public SpotLight(Color color)

Creates a new instance of SpotLight class using the specified color.

Parameters

color:Color: the color of the light source

Method Detail

directionProperty	back to summary
public final ObjectProperty<Point3D> directionProperty()

doCreatePeer	back to summary
private NGNode doCreatePeer() Hides javafx.scene.PointLight.doCreatePeer.

doUpdatePeer	back to summary
private void doUpdatePeer() Hides javafx.scene.PointLight.doUpdatePeer.

falloffProperty	back to summary
public final DoubleProperty falloffProperty()

getDirection	back to summary
public final Point3D getDirection()

getFalloff	back to summary
public final double getFalloff()

getInnerAngle	back to summary
public final double getInnerAngle()

getOuterAngle	back to summary
public final double getOuterAngle()

innerAngleProperty	back to summary
public final DoubleProperty innerAngleProperty()

outerAngleProperty	back to summary
public final DoubleProperty outerAngleProperty()

setDirection	back to summary
public final void setDirection(Point3D value)

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

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

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

public Class SpotLight

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail