Spec-Zone.ru › OpenJavaFX 21

Класс SpotLight

java.lang.Object
javafx.scene.Node
javafx.scene.LightBase
javafx.scene.PointLight
javafx.scene.SpotLight
Все реализованные интерфейсы:
Styleable, EventTarget
public class SpotLight extends PointLight
Источник света, испускающий свет в конусе в определенном направлении от себя. Направление определяется вектором свойства направления direction.

В дополнение к факторам затухания затухания, контролирующим интенсивность света на расстоянии, у SpotLight есть фактор затухания конуса света, spot, который определяется 3 свойствами:

  • innerAngle: угол внутреннего конуса (см. изображение ниже)
  • outerAngle: угол внешнего конуса (см. изображение ниже)
  • falloff: фактор, контролирующий падение интенсивности света внутри внешнего конуса
Допустимые диапазоны для этих свойств - 0 <= innerAngle <= outerAngle <= 180 и falloff >= 0; значения вне этих диапазонов могут привести к неожиданным результатам.

Угол от точки до источника света определяется как угол между вектором от этой точки до позиции источника света и направлением света. Для такого угла theta, если

  • theta < innerAngle, то spot = 1
  • theta > outerAngle, то spot = 0
  • innerAngle <= theta <= outerAngle, то
    spot = pow((cos(theta) - cos(outer)) / (cos(inner) - cos(outer)), falloff)
    , что представляет собой падение интенсивности от внутреннего угла до внешнего.
В результате, 0 <= spot <= 1. Общая интенсивность света - I = lambert * atten * spot.

SpotLight могут представлять точечные источники света с направленностью. Фонарики и прожекторы являются распространенными источниками света, которые можно смоделировать с помощью этого типа света.

Image of the Spotlight

С момента:
17
См. также:
  • PhongMaterial

Краткое описание свойств

Тип Свойство Описание
final ObjectProperty<Point3D> direction
Вектор направления прожектора.
final DoubleProperty falloff
Коэффициент затухания интенсивности внешнего конуса прожектора.
final DoubleProperty innerAngle
Угол внутреннего конуса прожектора в градусах.
final DoubleProperty outerAngle
Угол внешнего конуса прожектора в градусах (как показано на изображении документации класса).

Свойства, объявленные в классе javafx.scene.PointLight

constantAttenuation, linearAttenuation, maxRange, quadraticAttenuation

Свойства, объявленные в классе javafx.scene.LightBase

color, lightOn

Свойства, объявленные в классе javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, 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

Краткое описание полей

Поля, объявленные в классе javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Краткое описание конструкторов

Конструктор Описание
SpotLight()
Создает новый экземпляр класса SpotLight с источником света по умолчанию Color.WHITE.
SpotLight(Color color)
Создает новый экземпляр класса SpotLight, используя указанный цвет.

Краткое описание методов

Модификатор и тип Метод Описание
final ObjectProperty<Point3D> directionProperty()
Вектор направления прожектора.
final DoubleProperty falloffProperty()
Коэффициент затухания интенсивности внешнего конуса прожектора.
final Point3D getDirection()
Возвращает значение свойства direction.
final double getFalloff()
Возвращает значение свойства falloff.
final double getInnerAngle()
Возвращает значение свойства innerAngle.
final double getOuterAngle()
Возвращает значение свойства outerAngle.
final DoubleProperty innerAngleProperty()
Угол внутреннего конуса прожектора в градусах.
final DoubleProperty outerAngleProperty()
Угол внешнего конуса прожектора в градусах (как показано на изображении документации класса).
final void setDirection(Point3D value)
Устанавливает значение свойства direction.
final void setFalloff(double value)
Устанавливает значение свойства falloff.
final void setInnerAngle(double value)
Устанавливает значение свойства innerAngle.
final void setOuterAngle(double value)
Устанавливает значение свойства outerAngle.

Методы, объявленные в классе javafx.scene.PointLight

constantAttenuationProperty, getConstantAttenuation, getLinearAttenuation, getMaxRange, getQuadraticAttenuation, linearAttenuationProperty, maxRangeProperty, quadraticAttenuationProperty, setConstantAttenuation, setLinearAttenuation, setMaxRange, setQuadraticAttenuation

Методы, объявленные в классе javafx.scene.LightBase

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

Методы, объявленные в классе 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, focusVisibleProperty, focusWithinProperty, 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, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, 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

Методы, объявленные в классе java.lang.Object

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

Методы, объявленные в интерфейсе javafx.css.Styleable

getStyleableNode

Подробности свойства

direction

public final ObjectProperty<Point3D> directionProperty
Вектор направления прожектора. Его можно повернуть, задав преобразование вращения для SpotLight. Вектор не обязательно должен быть нормированным.
Значение по умолчанию:
Point3D(0, 0, 1)
См. также:
  • getDirection()
  • setDirection(Point3D)
  • directionProperty()

innerAngle

public final DoubleProperty innerAngleProperty
Угол внутреннего конуса прожектора в градусах. Точка, угол которой до источника света меньше этого угла, не ослабляется фактором прожектора (spot = 1). При больших углах интенсивность света начинает снижаться. Подробнее см. документацию по классу.

Допустимый диапазон значений 0 <= innerAngle <= outerAngle; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
0
См. также:
  • getInnerAngle()
  • setInnerAngle(double)
  • innerAngleProperty()

outerAngle

public final DoubleProperty outerAngleProperty
Угол внешнего конуса прожектора в градусах (как показано на изображении в документации к классу). Точка, угол которой до источника света больше этого угла, не получает света (spot = 0). Точка, угол которой меньше внешнего угла, но больше внутреннего, получает частичную интенсивность, определяемую фактором затухания. Подробнее см. документацию по классу.

Допустимый диапазон значений innerAngle <= outerAngle <= 180; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
30
См. также:
  • getOuterAngle()
  • setOuterAngle(double)
  • outerAngleProperty()

falloff

public final DoubleProperty falloffProperty
Коэффициент затухания интенсивности внешнего конуса прожектора. Точка, угол которой до источника света больше внутреннего, но меньше внешнего угла, получает частичную интенсивность, определяемую этим фактором. Чем больше затухание, тем резче падение интенсивности от внутреннего конуса. Коэффициент затухания 1 даёт линейное падение интенсивности, значения больше 1 дают выпуклое падение, а значения меньше 1 дают вогнутое падение. Подробнее см. документацию по классу.

Допустимый диапазон значений 0 <= falloff; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
1
См. также:
  • getFalloff()
  • setFalloff(double)
  • falloffProperty()

Подробности конструкторов

SpotLight

public SpotLight()
Создаёт новый экземпляр класса SpotLight со стандартным источником света.

SpotLight

public SpotLight(Color color)
Создаёт новый экземпляр класса SpotLight с использованием указанного цвета.
Параметры:
color - цвет источника света

Подробности методов

setDirection

public final void setDirection(Point3D value)
Устанавливает значение свойства direction.
Описание свойства:
Вектор направления прожектора. Его можно повернуть, задав преобразование вращения для SpotLight. Вектор не обязательно должен быть нормированным.
Значение по умолчанию:
Point3D(0, 0, 1)
Параметры:
value - значение для свойства direction
См. также:
  • getDirection()
  • directionProperty()

getDirection

public final Point3D getDirection()
Получает значение свойства direction.
Описание свойства:
Вектор направления прожектора. Его можно повернуть, задав преобразование вращения для SpotLight. Вектор не обязательно должен быть нормированным.
Значение по умолчанию:
Point3D(0, 0, 1)
Возвращает:
значение свойства direction
См. также:
  • setDirection(Point3D)
  • directionProperty()

directionProperty

public final ObjectProperty<Point3D> directionProperty()
Вектор направления прожектора. Его можно повернуть, задав преобразование вращения для SpotLight. Вектор не обязательно должен быть нормированным.
Значение по умолчанию:
Point3D(0, 0, 1)
Возвращает:
свойство direction
См. также:
  • getDirection()
  • setDirection(Point3D)

setInnerAngle

public final void setInnerAngle(double value)
Устанавливает значение свойства innerAngle.
Описание свойства:
Угол внутреннего конуса прожектора в градусах. Точка, угол которой до источника света меньше этого угла, не ослабляется фактором прожектора (spot = 1). При больших углах интенсивность света начинает снижаться. Подробнее см. документацию по классу.

Допустимый диапазон значений 0 <= innerAngle <= outerAngle; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
0
Параметры:
value - значение для свойства innerAngle
См. также:
  • getInnerAngle()
  • innerAngleProperty()

getInnerAngle

public final double getInnerAngle()
Получает значение свойства innerAngle.
Описание свойства:
Угол внутреннего конуса прожектора в градусах. Точка, угол которой до источника света меньше этого угла, не ослабляется фактором прожектора (spot = 1). При больших углах интенсивность света начинает снижаться. Подробнее см. документацию по классу.

Допустимый диапазон значений 0 <= innerAngle <= outerAngle; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
0
Возвращает:
значение свойства innerAngle
См. также:
  • setInnerAngle(double)
  • innerAngleProperty()

innerAngleProperty

public final DoubleProperty innerAngleProperty()
Угол внутреннего конуса прожектора в градусах. Точка, угол которой до источника света меньше этого угла, не ослабляется фактором прожектора (spot = 1). При больших углах интенсивность света начинает снижаться. Подробнее см. документацию по классу.

Допустимый диапазон значений 0 <= innerAngle <= outerAngle; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
0
Возвращает:
свойство innerAngle
См. также:
  • getInnerAngle()
  • setInnerAngle(double)

setOuterAngle

public final void setOuterAngle(double value)
Устанавливает значение свойства outerAngle.
Описание свойства:
Угол внешнего конуса прожектора в градусах (как показано на изображении в документации к классу). Точка, угол которой до источника света больше этого угла, не получает света (spot = 0). Точка, угол которой меньше внешнего угла, но больше внутреннего, получает частичную интенсивность, определяемую фактором затухания. Подробнее см. документацию по классу.

Допустимый диапазон значений innerAngle <= outerAngle <= 180; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
30
Параметры:
value - значение для свойства outerAngle
См. также:
  • getOuterAngle()
  • outerAngleProperty()

getOuterAngle

public final double getOuterAngle()
Получает значение свойства outerAngle.
Описание свойства:
Угол внешнего конуса прожектора в градусах (как показано на изображении в документации к классу). Точка, угол которой до источника света больше этого угла, не получает света (spot = 0). Точка, угол которой меньше внешнего угла, но больше внутреннего, получает частичную интенсивность, определяемую фактором затухания. Подробнее см. документацию по классу.

Допустимый диапазон значений innerAngle <= outerAngle <= 180; значения вне этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
30
Возвращает:
значение свойства outerAngle
См. также:
  • setOuterAngle(double)
  • outerAngleProperty()

outerAngleProperty

public final DoubleProperty outerAngleProperty()
Угол внешнего конуса прожектора в градусах (как показано на изображении в документации класса). Точка, угол которой до света больше этого угла, не получает света (spot = 0). Точка, угол которой до света меньше внешнего угла, но больше внутреннего угла, получает частичную интенсивность, определяемую коэффициентом затухания. Смотрите документацию класса для получения дополнительной информации.

Допустимый диапазон значений innerAngle <= outerAngle <= 180; значения за пределами этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
30
Возвращает:
свойство outerAngle
См. также:
  • getOuterAngle()
  • setOuterAngle(double)

setFalloff

public final void setFalloff(double value)
Устанавливает значение свойства falloff.
Описание свойства:
Коэффициент затухания интенсивности внешнего конуса прожектора. Точка, угол которой до света больше внутреннего угла, но меньше внешнего угла, получает частичную интенсивность, определяемую этим коэффициентом. Чем больше коэффициент затухания, тем резче падает интенсивность от внутреннего конуса. Коэффициент затухания 1 даёт линейное падение интенсивности, значения больше 1 дают выпуклое падение, а значения меньше 1 — вогнутое падение. Смотрите документацию класса для получения дополнительной информации.

Допустимый диапазон значений 0 <= falloff; значения за пределами этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
1
Параметры:
value - значение для свойства falloff
См. также:
  • getFalloff()
  • falloffProperty()

getFalloff

public final double getFalloff()
Получает значение свойства falloff.
Описание свойства:
Коэффициент затухания интенсивности внешнего конуса прожектора. Точка, угол которой до света больше внутреннего угла, но меньше внешнего угла, получает частичную интенсивность, определяемую этим коэффициентом. Чем больше коэффициент затухания, тем резче падает интенсивность от внутреннего конуса. Коэффициент затухания 1 даёт линейное падение интенсивности, значения больше 1 дают выпуклое падение, а значения меньше 1 — вогнутое падение. Смотрите документацию класса для получения дополнительной информации.

Допустимый диапазон значений 0 <= falloff; значения за пределами этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
1
Возвращает:
значение свойства falloff
См. также:
  • setFalloff(double)
  • falloffProperty()

falloffProperty

public final DoubleProperty falloffProperty()
Коэффициент затухания интенсивности внешнего конуса прожектора. Точка, угол которой до света больше внутреннего угла, но меньше внешнего угла, получает частичную интенсивность, определяемую этим коэффициентом. Чем больше коэффициент затухания, тем резче падает интенсивность от внутреннего конуса. Коэффициент затухания 1 даёт линейное падение интенсивности, значения больше 1 дают выпуклое падение, а значения меньше 1 — вогнутое падение. Смотрите документацию класса для получения дополнительной информации.

Допустимый диапазон значений 0 <= falloff; значения за пределами этого диапазона могут привести к непредсказуемым результатам.

Значение по умолчанию:
1
Возвращает:
свойство falloff
См. также:
  • getFalloff()
  • setFalloff(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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API