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

A light source that radiates light equally in all directions away from itself. The location of the light source is a single point in space. It is attenuated with the constantAttenuation, linearAttenuation, quadraticAttenuation, and maxRange properties.

PointLights can represent point-like light sources with little to no directionality. Light bulbs and candles are common light sources that can be simulated with this light type.

Field Summary

Modifier and Type	Field and Description
private DoubleProperty	constantAttenuation The constant attenuation coefficient.
private static final double	DEFAULT_CONSTANT_ATTENUATION
private static final double	DEFAULT_LINEAR_ATTENUATION
private static final double	DEFAULT_MAX_RANGE
private static final double	DEFAULT_QUADRATIC_ATTENUATION
private DoubleProperty	linearAttenuation The linear attenuation coefficient.
private DoubleProperty	maxRange The maximum range of this `PointLight`.
private DoubleProperty	quadraticAttenuation The quadratic attenuation coefficient.

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

Method Summary

Modifier and Type	Method and Description
public final DoubleProperty	constantAttenuationProperty()
private NGNode	doCreatePeer()
private void	doUpdatePeer() Hides javafx.scene.LightBase.doUpdatePeer.
public final double	getConstantAttenuation()
public final double	getLinearAttenuation()
public final double	getMaxRange()
public final double	getQuadraticAttenuation()
public final DoubleProperty	linearAttenuationProperty()
public final DoubleProperty	maxRangeProperty()
public final DoubleProperty	quadraticAttenuationProperty()
public final void	setConstantAttenuation(double value)
public final void	setLinearAttenuation(double value)
public final void	setMaxRange(double value)
public final void	setQuadraticAttenuation(double value)

Inherited from javafx.scene.LightBase:: colorProperty getColor getExclusionScope getLightDoubleProperty getScope isLightOn lightOnProperty scenesChanged setColor setLightOn

Field Detail

constantAttenuation back to summary

constantAttenuation	back to summary
private DoubleProperty constantAttenuation The constant attenuation coefficient. This is the term `ca` in the attenuation formula: `attn = 1 / (ca + la * dist + qa * dist^2)` where `dist` is the distance between the light source and the pixel. Default Value 1 Since 16

private DoubleProperty constantAttenuation

The constant attenuation coefficient. This is the term ca in the attenuation formula:

attn = 1 / (ca + la * dist + qa * dist^2)

where dist is the distance between the light source and the pixel.

Default Value: 1
Since: 16

DEFAULT_CONSTANT_ATTENUATION	back to summary
private static final double DEFAULT_CONSTANT_ATTENUATION

DEFAULT_LINEAR_ATTENUATION	back to summary
private static final double DEFAULT_LINEAR_ATTENUATION

DEFAULT_MAX_RANGE	back to summary
private static final double DEFAULT_MAX_RANGE

DEFAULT_QUADRATIC_ATTENUATION	back to summary
private static final double DEFAULT_QUADRATIC_ATTENUATION

linearAttenuation back to summary

linearAttenuation	back to summary
private DoubleProperty linearAttenuation The linear attenuation coefficient. This is the term `la` in the attenuation formula: `attn = 1 / (ca + la * dist + qa * dist^2)` where `dist` is the distance between the light source and the pixel. Default Value 0 Since 16

private DoubleProperty linearAttenuation

The linear attenuation coefficient. This is the term la in the attenuation formula:

attn = 1 / (ca + la * dist + qa * dist^2)

where dist is the distance between the light source and the pixel.

Default Value: 0
Since: 16

maxRange back to summary

maxRange	back to summary
private DoubleProperty maxRange The maximum range of this `PointLight`. For a pixel to be affected by this light, its distance to the light source must be less than or equal to the light's maximum range. Any negative value will be treated as 0. Lower `maxRange` values can give better performance as pixels outside the range of the light will not require complex calculation. The attenuation formula can be used to calculate a realistic `maxRange` value by finding the distance where the attenuation is close enough to 0. Nodes that are inside the light's range can still be excluded from the light's effect by removing them from its `scope` (or including them in its `exclusion scope`). If a node is known to always be outside of the light's range, it is more performant to exclude it from its scope. Default Value `Double.POSITIVE_INFINITY` Since 16

private DoubleProperty maxRange

The maximum range of this PointLight. For a pixel to be affected by this light, its distance to the light source must be less than or equal to the light's maximum range. Any negative value will be treated as 0.

Lower maxRange values can give better performance as pixels outside the range of the light will not require complex calculation. The attenuation formula can be used to calculate a realistic maxRange value by finding the distance where the attenuation is close enough to 0.

Nodes that are inside the light's range can still be excluded from the light's effect by removing them from its scope (or including them in its exclusion scope). If a node is known to always be outside of the light's range, it is more performant to exclude it from its scope.

Default Value: Double.POSITIVE_INFINITY
Since: 16

quadraticAttenuation back to summary

quadraticAttenuation	back to summary
private DoubleProperty quadraticAttenuation The quadratic attenuation coefficient. This is the term `qa` in the attenuation formula: `attn = 1 / (ca + la * dist + qa * dist^2)` where `dist` is the distance between the light source and the pixel. Default Value 0 Since 16

private DoubleProperty quadraticAttenuation

The quadratic attenuation coefficient. This is the term qa in the attenuation formula:

attn = 1 / (ca + la * dist + qa * dist^2)

where dist is the distance between the light source and the pixel.

Default Value: 0
Since: 16

Constructor Detail

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

PointLight back to summary

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

public PointLight(Color color)

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

Parameters

color:Color: the color of the light source

Method Detail

constantAttenuationProperty	back to summary
public final DoubleProperty constantAttenuationProperty()

doCreatePeer	back to summary
private NGNode doCreatePeer()

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

getConstantAttenuation	back to summary
public final double getConstantAttenuation()

getLinearAttenuation	back to summary
public final double getLinearAttenuation()

getMaxRange	back to summary
public final double getMaxRange()

getQuadraticAttenuation	back to summary
public final double getQuadraticAttenuation()

linearAttenuationProperty	back to summary
public final DoubleProperty linearAttenuationProperty()

maxRangeProperty	back to summary
public final DoubleProperty maxRangeProperty()

quadraticAttenuationProperty	back to summary
public final DoubleProperty quadraticAttenuationProperty()

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

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

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

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

public non-sealed Class PointLight

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail