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.

Since:

JavaFX 8

Property Summary

Type	Property and Description
ObjectProperty<Camera>	camera Specifies the type of camera use for rendering this SubScene.
ObjectProperty<Paint>	fill Defines the background fill of this SubScene.
DoubleProperty	height Defines the height of this SubScene
ObjectProperty<Parent>	root Defines the root Node of the SubScene scene graph.
DoubleProperty	width Defines the width of this SubScene

Properties inherited from class javafx.scene.Node

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, visible

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, boolean 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() Specifies the type of camera use for rendering this SubScene.
ObjectProperty<Paint>	fillProperty() Defines the background fill of this SubScene.
Camera	getCamera() Gets the value of the property camera.
Paint	getFill() Gets the value of the property fill.
double	getHeight() Gets the value of the property height.
Parent	getRoot() Gets the value of the property root.
double	getWidth() Gets the value of the property width.
DoubleProperty	heightProperty() Defines the height of this SubScene
boolean	isAntiAliasing() Return true if this SubScene is anti-aliased otherwise false.
ObjectProperty<Parent>	rootProperty() Defines the root Node of the SubScene scene graph.
void	setCamera(Camera value) Sets the value of the property camera.
void	setFill(Paint value) Sets the value of the property fill.
void	setHeight(double value) Sets the value of the property height.
void	setRoot(Parent value) Sets the value of the property root.
void	setWidth(double value) Sets the value of the property width.
DoubleProperty	widthProperty() Defines the width of this SubScene

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, 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, 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, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, maxHeight, maxWidth, minHeight, minWidth, 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, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, 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

Property Detail

root

public final ObjectProperty<Parent> rootProperty

Defines the root Node of the SubScene scene graph. If a Group is used as the root, the contents of the scene graph will be clipped by the SubScene's width and height. SubScene doesn't accept null root.

See Also:

getRoot(), setRoot(Parent)

camera

public final ObjectProperty<Camera> cameraProperty

Specifies the type of camera use for rendering this SubScene. If camera is null, a parallel camera is used for rendering. It is illegal to set a camera that belongs to other Scene or SubScene.

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

See Also:

getCamera(), setCamera(Camera)

Default value:

null

width

public final DoubleProperty widthProperty

Defines the width of this SubScene

See Also:

getWidth(), setWidth(double)

height

public final DoubleProperty heightProperty

Defines the height of this SubScene

See Also:

getHeight(), setHeight(double)

fill

public final ObjectProperty<Paint> fillProperty

Defines the background fill of this SubScene. Both a null value meaning paint no background and a Paint with transparency are supported. The default value is null.

See Also:

getFill(), setFill(Paint)

Default value:

null

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 scene

height - The height of the scene

Throws:

java.lang.IllegalStateException - if this constructor is called on a thread other than the JavaFX Application Thread.

java.lang.NullPointerException - if root is null

SubScene

public SubScene(Parent root,
                double width,
                double height,
                boolean depthBuffer,
                boolean 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.

Parameters:

root - The root node of the scene graph

width - The width of the scene

height - The height of the scene

depthBuffer - The depth buffer flag

antiAliasing - The sub-scene anti-aliasing flag

The depthBuffer and antiAliasing flags are conditional feature and the default value for both are false. See ConditionalFeature.SCENE3D for more information.

Throws:

java.lang.IllegalStateException - if this constructor is called on a thread other than the JavaFX Application Thread.

java.lang.NullPointerException - if root is null

See Also:

Node.setDepthTest(DepthTest)

Method Detail

isAntiAliasing

public boolean isAntiAliasing()

Return true if this SubScene is anti-aliased otherwise false.

setRoot

public final void setRoot(Parent value)

Sets the value of the property root.

Property description:

Defines the root Node of the SubScene scene graph. If a Group is used as the root, the contents of the scene graph will be clipped by the SubScene's width and height. SubScene doesn't accept null root.

getRoot

public final Parent getRoot()

Gets the value of the property root.

Property description:

Defines the root Node of the SubScene scene graph. If a Group is used as the root, the contents of the scene graph will be clipped by the SubScene's width and height. SubScene doesn't accept null root.

rootProperty

public final ObjectProperty<Parent> rootProperty()

Defines the root Node of the SubScene scene graph. If a Group is used as the root, the contents of the scene graph will be clipped by the SubScene's width and height. SubScene doesn't accept null root.

See Also:

getRoot(), setRoot(Parent)

setCamera

public final void setCamera(Camera value)

Sets the value of the property camera.

Property description:

Specifies the type of camera use for rendering this SubScene. If camera is null, a parallel camera is used for rendering. It is illegal to set a camera that belongs to other Scene or SubScene.

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

Default value:

null

getCamera

public final Camera getCamera()

Gets the value of the property camera.

Property description:

Specifies the type of camera use for rendering this SubScene. If camera is null, a parallel camera is used for rendering. It is illegal to set a camera that belongs to other Scene or SubScene.

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

Default value:

null

cameraProperty

public final ObjectProperty<Camera> cameraProperty()

Specifies the type of camera use for rendering this SubScene. If camera is null, a parallel camera is used for rendering. It is illegal to set a camera that belongs to other Scene or SubScene.

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

See Also:

getCamera(), setCamera(Camera)

Default value:

null

setWidth

public final void setWidth(double value)

Sets the value of the property width.

Property description:

Defines the width of this SubScene

getWidth

public final double getWidth()

Gets the value of the property width.

Property description:

Defines the width of this SubScene

widthProperty

public final DoubleProperty widthProperty()

Defines the width of this SubScene

See Also:

getWidth(), setWidth(double)

setHeight

public final void setHeight(double value)

Sets the value of the property height.

Property description:

Defines the height of this SubScene

getHeight

public final double getHeight()

Gets the value of the property height.

Property description:

Defines the height of this SubScene

heightProperty

public final DoubleProperty heightProperty()

Defines the height of this SubScene

See Also:

getHeight(), setHeight(double)

setFill

public final void setFill(Paint value)

Sets the value of the property fill.

Property description:

Defines the background fill of this SubScene. Both a null value meaning paint no background and a Paint with transparency are supported. The default value is null.

Default value:

null

getFill

public final Paint getFill()

Gets the value of the property fill.

Property description:

Defines the background fill of this SubScene. Both a null value meaning paint no background and a Paint with transparency are supported. The default value is null.

Default value:

null

fillProperty

public final ObjectProperty<Paint> fillProperty()

Defines the background fill of this SubScene. Both a null value meaning paint no background and a Paint with transparency are supported. The default value is null.

See Also:

getFill(), setFill(Paint)

Default value:

null