JavaFX 27 · javafx.scene.Camera · APIdia, the JavaDoc alternative

Base class for a camera used to render a scene. The camera defines the mapping of the scene coordinate space onto the window. Camera is an abstract class with two concrete subclasses: ParallelCamera and PerspectiveCamera.

The default camera is positioned in the scene such that its projection plane in the scene coordinate space is at Z = 0, and it is looking into the screen in the positive Z direction. The distance in Z from the camera to the projection plane is determined by the width and height of the Scene to which it is attached and its fieldOfView.

The nearClip and farClip of this camera are specified in the eye coordinate space. This space is defined such that the eye is at its origin and the projection plane is one unit in front of the eye in the positive Z direction.

The following pseudo code is the math used to compute the near and far clip distances in the scene coordinate space:

final double tanOfHalfFOV = Math.tan(Math.toRadians(FOV) / 2.0);
final double halfHeight = HEIGHT / 2;
final double focalLenght = halfHeight / tanOfHalfFOV;
final double eyePositionZ = -1.0 * focalLenght;
final double nearClipDistance = focalLenght * NEAR + eyePositionZ;
final double farClipDistance = focalLenght * FAR + eyePositionZ;

where FOV is fieldOfView in degrees, NEAR is nearClip specified in eye space, and FAR is farClip specified in eye space.

Note

Since the ParallelCamera class has no fieldOfView property, a 30 degrees vertical field of view is used.

Note

For the case of a PerspectiveCamera where the fixedEyeAtCameraZero attribute is true, the scene coordinate space is normalized in order to fit into the view frustum (see PerspectiveCamera for more details). In this mode, the eye coordinate space is the same as this Camera node's local coordinate space. Hence the conversion formula mentioned above is not used.

Field Summary

Modifier and Type	Field and Description
private boolean	clipInSceneValid
private DoubleProperty	farClip Specifies the distance from the eye of the far clipping plane of this `Camera` in the eye coordinate space.
private double	farClipInScene
private Affine3D	localToSceneTx
private boolean	localToSceneValid
private DoubleProperty	nearClip Specifies the distance from the eye of the near clipping plane of this `Camera` in the eye coordinate space.
private double	nearClipInScene
private Scene	ownerScene
private SubScene	ownerSubScene
private Vec3d	position
private GeneralTransform3D	projTx
private GeneralTransform3D	projViewTx
private boolean	projViewTxValid
private Affine3D	sceneToLocalTx An affine transform that holds the computed scene-to-local transform.
private boolean	sceneToLocalValid
private double	viewHeight
private Affine3D	viewTx
private double	viewWidth

Inherited from javafx.scene.Node:: accessibilityProperties accessible BASELINE_OFFSET_SAME_AS_HEIGHT boundsChanged cssFlag focusVisible pseudoClassStates styleHelper

Constructor Summary

Access	Constructor and Description
protected	Camera() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
pack-priv abstract PickRay	Returns: The PickRay instance computed based on this camera and the given arguments. computePickRay(double horizontal coordinate of the pick ray in the projected view, usually mouse cursor position x, double vertical coordinate of the pick ray in the projected view, usually mouse cursor position y, PickRay pick ray to be reused. New instance is created in case of null. pickRay) Computes pick ray for the content rendered by this camera.
pack-priv abstract Vec3d	Returns: The position of the camera in the scene in camera local coords computePosition(Vec3d Position to be reused. New instance is created in case of null. position) Computes local position of the camera in the scene.
pack-priv abstract void	computeProjectionTransform(GeneralTransform3D proj)
pack-priv abstract void	computeViewTransform(Affine3D view)
pack-priv Camera	copy()
private boolean	doComputeContains(double localX, double localY)
private BaseBounds	doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)
private void	doMarkDirty(DirtyBits dirtyBit) Hides javafx.scene.Node.doMarkDirty. Mark the specified bit as dirty, and add this node to the scene's dirty list.
private void	doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.
public final DoubleProperty	farClipProperty()
pack-priv Affine3D	getCameraTransform() Returns the local-to-scene transform of this camera.
public final double	getFarClip()
pack-priv double	getFarClipInScene()
public final double	getNearClip()
pack-priv double	getNearClipInScene()
pack-priv GeneralTransform3D	getProjViewTransform() Returns the projView transform of this camera.
pack-priv Affine3D	getSceneToLocalTransform()
pack-priv double	getViewHeight()
pack-priv double	getViewWidth()
private void	markOwnerDirty()
public final DoubleProperty	nearClipProperty()
private Point2D	pickNodeXYPlane(Node node, double x, double y) Computes intersection point of the pick ray cast by the given coordinates and the node's local XY plane.
pack-priv Point3D	pickProjectPlane(double x, double y) Computes intersection point of the pick ray cast by the given coordinates and the projection plane.
private Point2D	project(Point3D p) Transforms the given 3D point to the flat projected coordinates.
private static double	safeSize(double size)
public final void	setFarClip(double value)
public final void	setNearClip(double value)
pack-priv void	setOwnerScene(Scene s)
pack-priv void	setOwnerSubScene(SubScene s)
pack-priv void	setViewHeight(double height)
pack-priv void	setViewWidth(double width)
private void	updateClipPlane()

Inherited from javafx.scene.Node:: accessibleHelpProperty accessibleRoleDescriptionProperty accessibleRoleProperty accessibleTextProperty addEventFilter addEventHandler almostZero applyCss autosize blendModeProperty boundedSize boundsInLocalProperty boundsInParentProperty buildEventDispatchChain cacheHintProperty cacheProperty clearDirty clearInitialCssStateFlag clipProperty completeTransitionTimers computeAreaInScreen computeDerivedDepthTest contains contains cursorProperty depthTestProperty disabledProperty disableProperty effectiveNodeOrientationProperty effectProperty eventDispatcherProperty executeAccessibleAction findStyles fireEvent focusedProperty focusTraversableProperty focusVisibleProperty focusWithinProperty 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 getOnMouseDragDone 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 getTransitionDefinitions getTransitionTimers getTranslateX getTranslateY getTranslateZ getTypeSelector getUserData getViewOrder hasMirroring hasProperties hoverProperty idProperty indent inputMethodRequestsProperty intersects intersects intersects intersectsBounds isCache isCanReceiveFocus isConnected isDerivedDepthTest isDirty isDisable isDisabled isFocused isFocusTraversable isFocusVisible isFocusWithin 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 notifyFocusListeners notifyManagedChanged notifyParentOfBoundsChange notifyParentsOfInvalidatedCSS onContextMenuRequestedProperty onDragDetectedProperty onDragDoneProperty onDragDroppedProperty onDragEnteredProperty onDragExitedProperty onDragOverProperty onInputMethodTextChangedProperty onKeyPressedProperty onKeyReleasedProperty onKeyTypedProperty onMouseClickedProperty onMouseDragDoneProperty 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 recalculateRelativeSizeProperties releaseAccessible relocate removeEventFilter removeEventHandler requestFocus requestFocusTraversal resize resizeRelocate rotateProperty rotationAxisProperty scaleXProperty scaleYProperty scaleZProperty sceneProperty scenesChanged 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 setFocusQuietly setFocusTraversable setHover setId setInputMethodRequests setLayoutX setLayoutY setManaged setMouseTransparent setNodeOrientation setOnContextMenuRequested setOnDragDetected setOnDragDone setOnDragDropped setOnDragEntered setOnDragExited setOnDragOver setOnInputMethodTextChanged setOnKeyPressed setOnKeyReleased setOnKeyTyped setOnMouseClicked setOnMouseDragDone 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 setTreeVisible setUserData setViewOrder setVisible showMnemonicsProperty snapshot snapshot startDragAndDrop startFullDrag styleProperty syncPeer toBack toFront toString transformedBoundsChanged translateXProperty translateYProperty translateZProperty traverse treeVisibleProperty updateBounds updateGeomBounds updateLocalToParentTransform updateTxBounds usesMirroring viewOrderProperty visibleProperty wouldCreateCycle

Field Detail

clipInSceneValid	back to summary
private boolean clipInSceneValid

farClip back to summary

farClip	back to summary
private DoubleProperty farClip Specifies the distance from the eye of the far clipping plane of this `Camera` in the eye coordinate space. Objects farther away from the eye than `farClip` are not drawn. `farClip` is specified as a value greater than `nearClip`. A value less than or equal to `nearClip` is treated as `nearClip` plus a very small positive number. Default Value 100.0 Since JavaFX 8.0

private DoubleProperty farClip

Specifies the distance from the eye of the far clipping plane of this Camera in the eye coordinate space. Objects farther away from the eye than farClip are not drawn. farClip is specified as a value greater than nearClip. A value less than or equal to nearClip is treated as nearClip plus a very small positive number.

Default Value: 100.0
Since: JavaFX 8.0

farClipInScene	back to summary
private double farClipInScene

localToSceneTx	back to summary
private Affine3D localToSceneTx

localToSceneValid	back to summary
private boolean localToSceneValid

nearClip back to summary

nearClip	back to summary
private DoubleProperty nearClip Specifies the distance from the eye of the near clipping plane of this `Camera` in the eye coordinate space. Objects closer to the eye than `nearClip` are not drawn. `nearClip` is specified as a value greater than zero. A value less than or equal to zero is treated as a very small positive number. Default Value 0.1 Since JavaFX 8.0

private DoubleProperty nearClip

Specifies the distance from the eye of the near clipping plane of this Camera in the eye coordinate space. Objects closer to the eye than nearClip are not drawn. nearClip is specified as a value greater than zero. A value less than or equal to zero is treated as a very small positive number.

Default Value: 0.1
Since: JavaFX 8.0

nearClipInScene	back to summary
private double nearClipInScene

ownerScene	back to summary
private Scene ownerScene

ownerSubScene	back to summary
private SubScene ownerSubScene

position	back to summary
private Vec3d position

projTx	back to summary
private GeneralTransform3D projTx

projViewTx	back to summary
private GeneralTransform3D projViewTx

projViewTxValid	back to summary
private boolean projViewTxValid

sceneToLocalTx	back to summary
private Affine3D sceneToLocalTx An affine transform that holds the computed scene-to-local transform. It is used to convert node to camera coordinate when rotation is involved.

sceneToLocalValid	back to summary
private boolean sceneToLocalValid

viewHeight	back to summary
private double viewHeight

viewTx	back to summary
private Affine3D viewTx

viewWidth	back to summary
private double viewWidth

Constructor Detail

Camera	back to summary
protected Camera() Constructor for subclasses to call.

Method Detail

computePickRay	back to summary
pack-priv abstract PickRay computePickRay(double x, double y, PickRay pickRay) Computes pick ray for the content rendered by this camera. Parameters x:double horizontal coordinate of the pick ray in the projected view, usually mouse cursor position y:double vertical coordinate of the pick ray in the projected view, usually mouse cursor position pickRay:PickRay pick ray to be reused. New instance is created in case of null. Returns:PickRay The PickRay instance computed based on this camera and the given arguments.

computePickRay

back to summary

pack-priv abstract PickRay computePickRay(double x, double y, PickRay pickRay)

Computes pick ray for the content rendered by this camera.

Parameters

x:double: horizontal coordinate of the pick ray in the projected view, usually mouse cursor position
y:double: vertical coordinate of the pick ray in the projected view, usually mouse cursor position
pickRay:PickRay: pick ray to be reused. New instance is created in case of null.

Returns:PickRay

The PickRay instance computed based on this camera and the given arguments.

computePosition	back to summary
pack-priv abstract Vec3d computePosition(Vec3d position) Computes local position of the camera in the scene. Parameters position:Vec3d Position to be reused. New instance is created in case of null. Returns:Vec3d The position of the camera in the scene in camera local coords

computePosition

back to summary

pack-priv abstract Vec3d computePosition(Vec3d position)

Computes local position of the camera in the scene.

Parameters

position:Vec3d: Position to be reused. New instance is created in case of null.

Returns:Vec3d

The position of the camera in the scene in camera local coords

computeProjectionTransform	back to summary
pack-priv abstract void computeProjectionTransform(GeneralTransform3D proj)

computeViewTransform	back to summary
pack-priv abstract void computeViewTransform(Affine3D view)

copy	back to summary
pack-priv Camera copy()

doComputeContains	back to summary
private boolean doComputeContains(double localX, double localY)

doComputeGeomBounds	back to summary
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)

doMarkDirty	back to summary
private void doMarkDirty(DirtyBits dirtyBit) Hides javafx.scene.Node.doMarkDirty. Doc from javafx.scene.Node.doMarkDirty. Mark the specified bit as dirty, and add this node to the scene's dirty list. Note This method MUST only be called via its accessor method.

doMarkDirty

back to summary

private void doMarkDirty(DirtyBits dirtyBit)

Hides javafx.scene.Node.doMarkDirty.

Doc from javafx.scene.Node.doMarkDirty.

Mark the specified bit as dirty, and add this node to the scene's dirty list.

Note

This method MUST only be called via its accessor method.

doUpdatePeer	back to summary
private void doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.

farClipProperty	back to summary
public final DoubleProperty farClipProperty()

getCameraTransform	back to summary
pack-priv Affine3D getCameraTransform() Returns the local-to-scene transform of this camera. Package private, for use in our internal subclasses. Returns directly the internal instance, it must not be altered.

getFarClip	back to summary
public final double getFarClip()

getFarClipInScene	back to summary
pack-priv double getFarClipInScene()

getNearClip	back to summary
public final double getNearClip()

getNearClipInScene	back to summary
pack-priv double getNearClipInScene()

getProjViewTransform	back to summary
pack-priv GeneralTransform3D getProjViewTransform() Returns the projView transform of this camera. Package private, for internal use. Returns directly the internal instance, it must not be altered.

getSceneToLocalTransform	back to summary
pack-priv Affine3D getSceneToLocalTransform()

getViewHeight	back to summary
pack-priv double getViewHeight()

getViewWidth	back to summary
pack-priv double getViewWidth()

markOwnerDirty	back to summary
private void markOwnerDirty()

nearClipProperty	back to summary
public final DoubleProperty nearClipProperty()

pickNodeXYPlane	back to summary
private Point2D pickNodeXYPlane(Node node, double x, double y) Computes intersection point of the pick ray cast by the given coordinates and the node's local XY plane.

pickProjectPlane	back to summary
pack-priv Point3D pickProjectPlane(double x, double y) Computes intersection point of the pick ray cast by the given coordinates and the projection plane.

project	back to summary
private Point2D project(Point3D p) Transforms the given 3D point to the flat projected coordinates.

safeSize	back to summary
private static double safeSize(double size)

setFarClip	back to summary
public final void setFarClip(double value)

setNearClip	back to summary
public final void setNearClip(double value)

setOwnerScene	back to summary
pack-priv void setOwnerScene(Scene s)

setOwnerSubScene	back to summary
pack-priv void setOwnerSubScene(SubScene s)

setViewHeight	back to summary
pack-priv void setViewHeight(double height)

setViewWidth	back to summary
pack-priv void setViewWidth(double width)

updateClipPlane	back to summary
private void updateClipPlane()

public abstract sealed Class Camera

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail