javafx.scene

Class LightBase

java.lang.Object

javafx.scene.Node

javafx.scene.LightBase

Direct Known Subclasses:

AmbientLight, PointLight

public abstract class LightBase
extends Node

The LightBase class provides definitions of common properties for objects that represent a form of Light source. These properties include:

• The color that defines color of the light source.

Note that this is a conditional feature. See ConditionalFeature.SCENE3D for more information.

An application should not extend the LightBase class directly. Doing so may lead to an UnsupportedOperationException being thrown.

Since:

JavaFX 8.0

Property Summary

Type	Property and Description
<any>	color Specifies the color of light source.
BooleanProperty	lightOn Defines the light on or off.

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, showMnemonicsProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, treeShowingProperty, treeVisibleProperty, viewOrderProperty, visibleProperty

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.Node

Node.FocusedProperty, Node.TreeShowingPropertyReadOnly, Node.TreeVisiblePropertyReadOnly

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	color Specifies the color of light source.
private BooleanProperty	lightOn Defines the light on or off.
private Affine3D	localToSceneTx
private <any>	scope

Fields inherited from class javafx.scene.Node

accessibilityProperties, accessible, BASELINE_OFFSET_SAME_AS_HEIGHT, boundsChanged, cssFlag, pseudoClassStates, styleHelper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LightBase() Creates a new instance of LightBase class with a default Color.WHITE light source.
protected	LightBase(Color color) Creates a new instance of LightBase class using the specified color.

Method Summary

Modifier and Type	Method and Description
<any>	colorProperty() Specifies the color of light source.
private boolean	doComputeContains(double localX, double localY)
private BaseBounds	doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)
private void	doMarkDirty(DirtyBits dirtyBit)
private void	doUpdatePeer()
Color	getColor() Gets the value of the property color.
<any>	getScope() Gets the list of nodes that specifies the hierarchical scope of this Light.
boolean	isLightOn() Gets the value of the property lightOn.
BooleanProperty	lightOnProperty() Defines the light on or off.
private void	markChildrenDirty(Node node)
private void	markOwnerDirty()
(package private) void	scenesChanged(Scene newScene, SubScene newSubScene, Scene oldScene, SubScene oldSubScene) Exists for Parent and LightBase
void	setColor(Color value) Sets the value of the property color.
void	setLightOn(boolean value) Sets the value of the property lightOn.

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, almostZero, applyCss, autosize, blendModeProperty, boundedSize, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clearDirty, clipProperty, computeAreaInScreen, computeDerivedDepthTest, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, findStyles, fireEvent, focusedProperty, focusTraversableProperty, getAccessible, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBaselineOffset, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getClipParent, getContentBias, getCSSFlags, getCssMetaData, getCurrentLocalToSceneTransformState, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getGeomBounds, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLeafTransform, getLocalBounds, getLocalToParentTransform, getLocalToParentTransform, getLocalToSceneTransform, getMatchingStyles, 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, getPeer, getPivotX, getPivotY, getPivotZ, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getStyleMap, getSubScene, getTransformedBounds, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasMirroring, hasProperties, hoverProperty, idProperty, indent, inputMethodRequestsProperty, intersects, intersects, intersects, intersectsBounds, isCache, isCanReceiveFocus, isConnected, isDerivedDepthTest, isDirty, isDirtyEmpty, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isShowMnemonics, isTreeShowing, isTreeVisible, isVisible, layoutBoundsChanged, layoutBoundsProperty, layoutXProperty, layoutYProperty, localBoundsChanged, localToParent, localToParent, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, lookupAll, managedProperty, markDirtyLayoutBranch, maxHeight, maxWidth, minHeight, minWidth, mouseTransparentProperty, nodeOrientationProperty, nodeResolvedOrientationChanged, nodeResolvedOrientationInvalidated, notifyAccessibleAttributeChanged, notifyManagedChanged, notifyParentOfBoundsChange, notifyParentsOfInvalidatedCSS, 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, parentResolvedOrientationInvalidated, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickNode, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, processCSS, pseudoClassStateChanged, queryAccessibleAttribute, reapplyCSS, releaseAccessible, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDerivedDepthTest, 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, setParent, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setScenes, setShowMnemonics, setStyle, setStyleMap, setTranslateX, setTranslateY, setTranslateZ, setTreeShowing, setTreeVisible, setUserData, setViewOrder, setVisible, showMnemonicsProperty, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, syncPeer, toBack, toFront, toString, transformedBoundsChanged, translateXProperty, translateYProperty, translateZProperty, traverse, treeShowingProperty, treeVisibleProperty, updateBounds, updateGeomBounds, updateLocalToParentTransform, updateTxBounds, usesMirroring, viewOrderProperty, visibleProperty, wouldCreateCycle

Methods inherited from class java.lang.Object

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

Property Detail

color

public final <any> colorProperty

Specifies the color of light source.

See Also:

getColor(), setColor(Color)

lightOn

public final BooleanProperty lightOnProperty

Defines the light on or off.

See Also:

isLightOn(), setLightOn(boolean)

Field Detail

localToSceneTx

private Affine3D localToSceneTx

color

private <any> color

Specifies the color of light source.

lightOn

private BooleanProperty lightOn

Defines the light on or off.

scope

private <any> scope

Constructor Detail

LightBase

protected LightBase()

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

LightBase

protected LightBase(Color color)

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

Parameters:

color - the color of the light source

Method Detail

setColor

public final void setColor(Color value)

Sets the value of the property color.

getColor

public final Color getColor()

Gets the value of the property color.

colorProperty

public final <any> colorProperty()

Specifies the color of light source.

See Also:

getColor(), setColor(Color)

setLightOn

public final void setLightOn(boolean value)

Sets the value of the property lightOn.

isLightOn

public final boolean isLightOn()

Gets the value of the property lightOn.

lightOnProperty

public final BooleanProperty lightOnProperty()

Defines the light on or off.

See Also:

isLightOn(), setLightOn(boolean)

getScope

public <any> getScope()

Gets the list of nodes that specifies the hierarchical scope of this Light. If the scope list is empty, the Light node has universe scope: all nodes under it's scene are affected by it. If the scope list is non-empty, only those 3D Shape nodes in the scope list and under the Group nodes in the scope list are affected by this Light node.

Returns:

the list of nodes that specifies the hierarchical scope of this Light

scenesChanged

void scenesChanged(Scene newScene,
                   SubScene newSubScene,
                   Scene oldScene,
                   SubScene oldSubScene)

Description copied from class: Node

Exists for Parent and LightBase

Overrides:

scenesChanged in class Node

markOwnerDirty

private void markOwnerDirty()

markChildrenDirty

private void markChildrenDirty(Node node)

doMarkDirty

private void doMarkDirty(DirtyBits dirtyBit)

doUpdatePeer

private void doUpdatePeer()

doComputeGeomBounds

private BaseBounds doComputeGeomBounds(BaseBounds bounds,
                                       BaseTransform tx)

doComputeContains

private boolean doComputeContains(double localX,
                                  double localY)