javafx.scene

Class SubScene

java.lang.Object

javafx.scene.Node

javafx.scene.SubScene

All Implemented Interfaces:

Styleable, EventTarget

public class SubScene
extends Node

The SubScene class is the container for content in a scene graph. SubScene provides separation of different parts of a scene, each of which can be rendered with a different camera, depth buffer, or scene anti-aliasing. A SubScene is embedded into the main scene or another sub-scene.

An application may request depth buffer support or scene anti-aliasing support at the creation of a SubScene. A sub-scene with only 2D shapes and without any 3D transforms does not need a depth buffer nor scene anti-aliasing support. A sub-scene containing 3D shapes or 2D shapes with 3D transforms may use depth buffer support for proper depth sorted rendering; to avoid depth fighting (also known as Z fighting), disable depth testing on 2D shapes that have no 3D transforms. See depthTest for more information. A sub-scene with 3D shapes may enable scene anti-aliasing to improve its rendering quality.

The depthBuffer and antiAliasing flags are conditional features. With the respective default values of: false and SceneAntialiasing.DISABLED. See ConditionalFeature.SCENE3D for more information.

Possible use cases are:

• Mixing 2D and 3D content
• Overlay for UI controls
• Underlay for background
• Heads-up display

A default headlight will be added to a that contains one or more Shape3D nodes, but no light nodes. This light source is a Color.WHITE PointLight placed at the camera position.

Since:

JavaFX 8.0

Field Summary

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
SubScene(Parent root, double width, double height) Creates a SubScene for a specific root Node with a specific size.
SubScene(Parent root, double width, double height, boolean depthBuffer, SceneAntialiasing antiAliasing) Constructs a SubScene consisting of a root, with a dimension of width and height, specifies whether a depth buffer is created for this scene and specifies whether scene anti-aliasing is requested.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Camera>	cameraProperty()
ObjectProperty<Paint>	fillProperty()
SceneAntialiasing	getAntiAliasing() Return the defined SceneAntialiasing for this SubScene.
Camera	getCamera()
Paint	getFill()
double	getHeight()
Parent	getRoot()
String	getUserAgentStylesheet() Get the URL of the user-agent stylesheet that will be used by this SubScene.
double	getWidth()
DoubleProperty	heightProperty()
protected boolean	impl_computeContains(double localX, double localY) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
BaseBounds	impl_computeGeomBounds(BaseBounds bounds, BaseTransform tx) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
protected NGNode	impl_createPeer() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
protected void	impl_pickNodeLocal(PickRay localPickRay, PickResultChooser result) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
protected void	impl_processCSS(WritableValue<Boolean> unused) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
Object	impl_processMXNode(MXNodeAlgorithm alg, MXNodeAlgorithmContext ctx) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
void	impl_updatePeer() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
boolean	isDepthBuffer() Retrieves the depth buffer attribute for this SubScene.
ObjectProperty<Parent>	rootProperty()
void	setCamera(Camera value)
void	setFill(Paint value)
void	setHeight(double value)
void	setRoot(Parent value)
void	setUserAgentStylesheet(String url) Set the URL of the user-agent stylesheet that will be used by this SubScene in place of the the platform-default user-agent stylesheet.
void	setWidth(double value)
ObjectProperty<String>	userAgentStylesheetProperty()
DoubleProperty	widthProperty()

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, 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, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_computeLayoutBounds, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_notifyLayoutBoundsChanged, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

SubScene

public SubScene(Parent root,
                double width,
                double height)

Creates a SubScene for a specific root Node with a specific size.

Parameters:

root - The root node of the scene graph

width - The width of the sub-scene

height - The height of the sub-scene

Throws:

NullPointerException - if root is null

SubScene

public SubScene(Parent root,
                double width,
                double height,
                boolean depthBuffer,
                SceneAntialiasing antiAliasing)

Constructs a SubScene consisting of a root, with a dimension of width and height, specifies whether a depth buffer is created for this scene and specifies whether scene anti-aliasing is requested.

A sub-scene with only 2D shapes and without any 3D transforms does not need a depth buffer nor scene anti-aliasing support. A sub-scene containing 3D shapes or 2D shapes with 3D transforms may use depth buffer support for proper depth sorted rendering; to avoid depth fighting (also known as Z fighting), disable depth testing on 2D shapes that have no 3D transforms. See depthTest for more information. A sub-scene with 3D shapes may enable scene anti-aliasing to improve its rendering quality.

Parameters:

root - The root node of the scene graph

width - The width of the sub-scene

height - The height of the sub-scene

depthBuffer - The depth buffer flag

antiAliasing - The sub-scene anti-aliasing attribute. A value of null is treated as DISABLED.

The depthBuffer and antiAliasing flags are conditional features. With the respective default values of: false and SceneAntialiasing.DISABLED. See ConditionalFeature.SCENE3D for more information.

Throws:

NullPointerException - if root is null

See Also:

Node.setDepthTest(DepthTest)

Method Detail

getAntiAliasing

public final SceneAntialiasing getAntiAliasing()

Return the defined SceneAntialiasing for this SubScene.

Note: this is a conditional feature. See ConditionalFeature.SCENE3D and SceneAntialiasing for more information.

Since:

JavaFX 8.0

isDepthBuffer

public final boolean isDepthBuffer()

Retrieves the depth buffer attribute for this SubScene.

Returns:

the depth buffer attribute.

setRoot

public final void setRoot(Parent value)

getRoot

public final Parent getRoot()

rootProperty

public final ObjectProperty<Parent> rootProperty()

setCamera

public final void setCamera(Camera value)

getCamera

public final Camera getCamera()

cameraProperty

public final ObjectProperty<Camera> cameraProperty()

setWidth

public final void setWidth(double value)

getWidth

public final double getWidth()

widthProperty

public final DoubleProperty widthProperty()

setHeight

public final void setHeight(double value)

getHeight

public final double getHeight()

heightProperty

public final DoubleProperty heightProperty()

setFill

public final void setFill(Paint value)

getFill

public final Paint getFill()

fillProperty

public final ObjectProperty<Paint> fillProperty()

impl_updatePeer

@Deprecated
public void impl_updatePeer()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

This function is called during synchronization to update the state of the PG Node from the FX Node. Subclasses of Node should override this method and must call super.impl_updatePeer()

Overrides:

impl_updatePeer in class Node

impl_processCSS

@Deprecated
protected void impl_processCSS(WritableValue<Boolean> unused)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

If invoked, will update styles from here on down. This method should not be called directly. If overridden, the overriding method must at some point call super.impl_processCSS() to ensure that this Node's CSS state is properly updated. Note that the difference between this method and Node.impl_processCSS(boolean) is that this method updates styles for this node on down; whereas, impl_processCSS(boolean) invokes Node.applyCss() which will look for the top-most ancestor that needs CSS update and apply styles from that node on down. The WritableValue<Boolean> parameter is no longer used.

Overrides:

impl_processCSS in class Node

userAgentStylesheetProperty

public final ObjectProperty<String> userAgentStylesheetProperty()

Returns:

the userAgentStylesheet property.

Since:

JavaFX 8u20

See Also:

getUserAgentStylesheet(), setUserAgentStylesheet(String)

getUserAgentStylesheet

public final String getUserAgentStylesheet()

Get the URL of the user-agent stylesheet that will be used by this SubScene. If the URL has not been set, the platform-default user-agent stylesheet will be used.

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Returns:

The URL of the user-agent stylesheet that will be used by this SubScene, or null if has not been set.

Since:

JavaFX 8u20

setUserAgentStylesheet

public final void setUserAgentStylesheet(String url)

Set the URL of the user-agent stylesheet that will be used by this SubScene in place of the the platform-default user-agent stylesheet. If the URL does not resolve to a valid location, the platform-default user-agent stylesheet will be used.

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Parameters:

url - The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Since:

JavaFX 8u20

impl_createPeer

@Deprecated
protected NGNode impl_createPeer()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_createPeer in class Node

impl_computeGeomBounds

@Deprecated
public BaseBounds impl_computeGeomBounds(BaseBounds bounds,
                                                     BaseTransform tx)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

Computes the geometric bounds for this Node. This method is abstract and must be implemented by each Node subclass.

Specified by:

impl_computeGeomBounds in class Node

impl_computeContains

@Deprecated
protected boolean impl_computeContains(double localX,
                                                   double localY)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_computeContains in class Node

impl_pickNodeLocal

@Deprecated
protected void impl_pickNodeLocal(PickRay localPickRay,
                                              PickResultChooser result)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Finds a top-most child node that contains the given local coordinates. Returns the picked node, null if no such node was found.

Overrides:

impl_pickNodeLocal in class Node

impl_processMXNode

@Deprecated
public Object impl_processMXNode(MXNodeAlgorithm alg,
                                             MXNodeAlgorithmContext ctx)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

This method is used by Scene-graph JMX bean to obtain the Scene-graph structure.

Specified by:

impl_processMXNode in class Node

Parameters:

alg - current algorithm to process this node

ctx - current context

Returns:

the algorithm specific result for this node