Class PointLight

javafx.scene.PointLight

All Implemented Interfaces:: Styleable, EventTarget

Direct Known Subclasses:: SpotLight

public class PointLight
extends LightBase

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. Any pixel within the range of the light will be illuminated by it, unless it belongs to a Shape3D outside of its scope.

The light's intensity can be set to decrease over distance by attenuating it. The attenuation formula

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

defines 3 coefficients: ca, la, and qa, which control the constant, linear, and quadratic behaviors of intensity falloff over distance, respectively. The effective color of the light at a given point in space is color * attn. It is possible, albeit unrealistic, to specify negative values to attenuation coefficients. This allows the resulting attenuation factor to be negative, which results in the light's color being subtracted from the material instead of added to it, thus creating a "shadow caster".

For a realistic effect, maxRange should be set to a distance at which the attenuation is close to 0 as this will give a soft cutoff.

Since:: JavaFX 8.0
See Also:: PhongMaterial

Property Summary

Properties
Type	Property	Description
`DoubleProperty`	`constantAttenuation`	The constant attenuation coefficient.
`DoubleProperty`	`linearAttenuation`	The linear attenuation coefficient.
`DoubleProperty`	`maxRange`	The maximum range of this `PointLight`.
`DoubleProperty`	`quadraticAttenuation`	The quadratic attenuation coefficient.

Properties declared in class javafx.scene.LightBase

color, lightOn

Properties declared in class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Field Summary

Fields declared in class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`DoubleProperty`	`constantAttenuationProperty()`	The constant attenuation coefficient.
`double`	`getConstantAttenuation()`	Gets the value of the property constantAttenuation.
`double`	`getLinearAttenuation()`	Gets the value of the property linearAttenuation.
`double`	`getMaxRange()`	Gets the value of the property maxRange.
`double`	`getQuadraticAttenuation()`	Gets the value of the property quadraticAttenuation.
`DoubleProperty`	`linearAttenuationProperty()`	The linear attenuation coefficient.
`DoubleProperty`	`maxRangeProperty()`	The maximum range of this `PointLight`.
`DoubleProperty`	`quadraticAttenuationProperty()`	The quadratic attenuation coefficient.
`void`	`setConstantAttenuation(double value)`	Sets the value of the property constantAttenuation.
`void`	`setLinearAttenuation(double value)`	Sets the value of the property linearAttenuation.
`void`	`setMaxRange(double value)`	Sets the value of the property maxRange.
`void`	`setQuadraticAttenuation(double value)`	Sets the value of the property quadraticAttenuation.

Methods declared in class javafx.scene.LightBase

colorProperty, getColor, getExclusionScope, getScope, isLightOn, lightOnProperty, setColor, setLightOn

Methods declared in class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBaselineOffset, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getContentBias, getCssMetaData, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, maxHeight, maxWidth, minHeight, minWidth, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods declared in class java.lang.Object

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

Methods declared in interface javafx.css.Styleable

getStyleableNode, getStyleClass

Property Details

maxRange

public final DoubleProperty maxRangeProperty

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
See Also:: getMaxRange(), setMaxRange(double)

constantAttenuation

public final DoubleProperty constantAttenuationProperty

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
See Also:: getConstantAttenuation(), setConstantAttenuation(double)

linearAttenuation

public final DoubleProperty linearAttenuationProperty

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
See Also:: getLinearAttenuation(), setLinearAttenuation(double)

quadraticAttenuation

public final DoubleProperty quadraticAttenuationProperty

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
See Also:: getQuadraticAttenuation(), setQuadraticAttenuation(double)

Constructor Details

PointLight

public PointLight()

Creates a new instance of PointLight class with a default Color.WHITE light source.

PointLight

public PointLight(Color color)

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

Parameters:: color - the color of the light source

Method Details

setMaxRange

public final void setMaxRange(double value)

Sets the value of the property maxRange.

Property description:

Default value:

Double.POSITIVE_INFINITY

Since:

getMaxRange

public final double getMaxRange()

Gets the value of the property maxRange.

Property description:

Default value:

Double.POSITIVE_INFINITY

Since:

maxRangeProperty

public final DoubleProperty maxRangeProperty()

Default value:: Double.POSITIVE_INFINITY
Since:: 16
See Also:: getMaxRange(), setMaxRange(double)

setConstantAttenuation

public final void setConstantAttenuation(double value)

Sets the value of the property constantAttenuation.

Property description:

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:

Since:

getConstantAttenuation

public final double getConstantAttenuation()

Gets the value of the property constantAttenuation.

Property description:

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:

Since:

constantAttenuationProperty

public final DoubleProperty constantAttenuationProperty()

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
See Also:: getConstantAttenuation(), setConstantAttenuation(double)

setLinearAttenuation

public final void setLinearAttenuation(double value)

Sets the value of the property linearAttenuation.

Property description:

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:

Since:

getLinearAttenuation

public final double getLinearAttenuation()

Gets the value of the property linearAttenuation.

Property description:

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:

Since:

linearAttenuationProperty

public final DoubleProperty linearAttenuationProperty()

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
See Also:: getLinearAttenuation(), setLinearAttenuation(double)

setQuadraticAttenuation

public final void setQuadraticAttenuation(double value)

Sets the value of the property quadraticAttenuation.

Property description:

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:

Since:

getQuadraticAttenuation

public final double getQuadraticAttenuation()

Gets the value of the property quadraticAttenuation.

Property description:

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:

Since:

quadraticAttenuationProperty

public final DoubleProperty quadraticAttenuationProperty()

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
See Also:: getQuadraticAttenuation(), setQuadraticAttenuation(double)

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.