JavaFX 24 · javafx.scene.PerspectiveCamera · APIdia, the JavaDoc alternative

Specifies a perspective camera for rendering a scene.

This camera defines a viewing volume for a perspective projection; a truncated right pyramid. The fieldOfView value can be used to change viewing volume. By default, this camera is located at center of the scene and looks along the positive z-axis. The coordinate system defined by this camera has its origin in the upper left corner of the panel with the Y-axis pointing down and the Z axis pointing away from the viewer (into the screen). If a PerspectiveCamera node is added to the scene graph, the transformed position and orientation of the camera will define the position of the camera and the direction that the camera is looking.

In the default camera, where fixedEyeAtCameraZero is false, the Z value of the eye position is adjusted in Z such that the projection matrix generated using the specified fieldOfView will produce units at Z = 0 (the projection plane), in device-independent pixels, matches that of the ParallelCamera. When the Scene is resized, the objects in the scene at the projection plane (Z = 0) will stay the same size, but more or less content of the scene is viewable.

If fixedEyeAtCameraZero is true, the eye position is fixed at (0, 0, 0) in the local coordinates of the camera. The projection matrix is generated using the specified fieldOfView and the projection volume is mapped onto the viewport (window) such that it is stretched over more or fewer device-independent pixels at the projection plane. When the Scene is resized, the objects in the scene will shrink or grow proportionally, but the visible portion of the content is unchanged.

We recommend setting fixedEyeAtCameraZero to true if you are going to transform (move) the camera. Transforming the camera when fixedEyeAtCameraZero is set to false may lead to results that are not intuitive.

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

Field Summary

Modifier and Type	Field and Description
private DoubleProperty	fieldOfView Specifies the field of view angle of the camera's projection, measured in degrees.
private boolean	fixedEyeAtCameraZero
private static final Affine3D	LOOK_AT_TX
private static final Affine3D	LOOK_AT_TX_FIXED_EYE
private BooleanProperty	verticalFieldOfView Defines whether the `fieldOfView` property will apply to the vertical dimension of the projection.

Constructor Summary

Access	Constructor and Description
public	PerspectiveCamera() Creates an empty instance of PerspectiveCamera.
public	PerspectiveCamera(boolean true if the the eye position is fixed at (0, 0, 0) in the local coordinates of the camera. fixedEyeAtCameraZero) Constructs a PerspectiveCamera with the specified fixedEyeAtCameraZero flag.

Method Summary

Modifier and Type	Method and Description
pack-priv final PickRay	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) Implements abstract javafx.scene.Camera.computePickRay. Computes pick ray for the content rendered by this camera.
pack-priv Vec3d	computePosition(Vec3d Position to be reused. New instance is created in case of null. position) Implements abstract javafx.scene.Camera.computePosition. Computes local position of the camera in the scene.
pack-priv void	computeProjectionTransform(GeneralTransform3D proj) Implements abstract javafx.scene.Camera.computeProjectionTransform.
pack-priv void	computeViewTransform(Affine3D view) Implements abstract javafx.scene.Camera.computeViewTransform.
pack-priv Camera	copy() Overrides javafx.scene.Camera.copy.
private NGNode	doCreatePeer()
private void	doUpdatePeer() Hides javafx.scene.Camera.doUpdatePeer.
public final DoubleProperty	fieldOfViewProperty()
public final double	getFieldOfView()
public final boolean	Returns: a flag indicating whether this camera uses a fixed eye position at the origin of the camera isFixedEyeAtCameraZero() Returns a flag indicating whether this camera uses a fixed eye position at the origin of the camera.
public final boolean	isVerticalFieldOfView()
public final void	setFieldOfView(double value)
public final void	setVerticalFieldOfView(boolean value)
public final BooleanProperty	verticalFieldOfViewProperty()

Inherited from javafx.scene.Camera:: farClipProperty getCameraTransform getFarClip getFarClipInScene getNearClip getNearClipInScene getProjViewTransform getSceneToLocalTransform getViewHeight getViewWidth nearClipProperty pickProjectPlane setFarClip setNearClip setOwnerScene setOwnerSubScene setViewHeight setViewWidth

Field Detail

fieldOfView	back to summary
private DoubleProperty fieldOfView Specifies the field of view angle of the camera's projection, measured in degrees. Default Value 30.0

fieldOfView

back to summary

private DoubleProperty fieldOfView

Specifies the field of view angle of the camera's projection, measured in degrees.

Default Value: 30.0

fixedEyeAtCameraZero	back to summary
private boolean fixedEyeAtCameraZero

LOOK_AT_TX	back to summary
private static final Affine3D LOOK_AT_TX

LOOK_AT_TX_FIXED_EYE	back to summary
private static final Affine3D LOOK_AT_TX_FIXED_EYE

verticalFieldOfView back to summary

verticalFieldOfView	back to summary
private BooleanProperty verticalFieldOfView Defines whether the `fieldOfView` property will apply to the vertical dimension of the projection. If it is false, `fieldOfView` will apply to the horizontal dimension of the projection. Default Value true Since JavaFX 8.0

private BooleanProperty verticalFieldOfView

Defines whether the fieldOfView property will apply to the vertical dimension of the projection. If it is false, fieldOfView will apply to the horizontal dimension of the projection.

Default Value: true
Since: JavaFX 8.0

Constructor Detail

PerspectiveCamera	back to summary
public PerspectiveCamera() Creates an empty instance of PerspectiveCamera.

PerspectiveCamera back to summary

PerspectiveCamera	back to summary
public PerspectiveCamera(boolean fixedEyeAtCameraZero) Constructs a PerspectiveCamera with the specified fixedEyeAtCameraZero flag. In the default camera, where fixedEyeAtCameraZero is false, the Z value of the eye position is adjusted in Z such that the projection matrix generated using the specified `fieldOfView` will produce units at Z = 0 (the projection plane), in device-independent pixels, matches that of the ParallelCamera. When the Scene is resized, the objects in the scene at the projection plane (Z = 0) will stay the same size, but more or less content of the scene is viewable. If fixedEyeAtCameraZero is true, the eye position is fixed at (0, 0, 0) in the local coordinates of the camera. The projection matrix is generated using the specified `fieldOfView` and the projection volume is mapped onto the viewport (window) such that it is stretched over more or fewer device-independent pixels at the projection plane. When the Scene is resized, the objects in the scene will shrink or grow proportionally, but the visible portion of the content is unchanged. We recommend setting fixedEyeAtCameraZero to true if you are going to transform (move) the camera. Transforming the camera when fixedEyeAtCameraZero is set to false may lead to results that are not intuitive. Parameters fixedEyeAtCameraZero:boolean true if the the eye position is fixed at (0, 0, 0) in the local coordinates of the camera. Since JavaFX 8.0

public PerspectiveCamera(boolean fixedEyeAtCameraZero)

Constructs a PerspectiveCamera with the specified fixedEyeAtCameraZero flag.

Parameters

fixedEyeAtCameraZero:boolean: true if the the eye position is fixed at (0, 0, 0) in the local coordinates of the camera.

Since

JavaFX 8.0

Method Detail

computePickRay	back to summary
pack-priv final PickRay computePickRay(double x, double y, PickRay pickRay) Implements abstract javafx.scene.Camera.computePickRay. Doc from javafx.scene.Camera.computePickRay. 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. Annotations @Override

computePickRay

back to summary

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

Implements abstract javafx.scene.Camera.computePickRay.

Doc from javafx.scene.Camera.computePickRay.

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.

Annotations

@Override

computePosition	back to summary
pack-priv Vec3d computePosition(Vec3d position) Implements abstract javafx.scene.Camera.computePosition. Doc from javafx.scene.Camera.computePosition. 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 Annotations @Override

computePosition

back to summary

pack-priv Vec3d computePosition(Vec3d position)

Implements abstract javafx.scene.Camera.computePosition.

Doc from javafx.scene.Camera.computePosition.

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

Annotations

@Override

computeProjectionTransform	back to summary
pack-priv void computeProjectionTransform(GeneralTransform3D proj) Implements abstract javafx.scene.Camera.computeProjectionTransform. Annotations @Override

computeProjectionTransform

back to summary

pack-priv void computeProjectionTransform(GeneralTransform3D proj)

Implements abstract javafx.scene.Camera.computeProjectionTransform.

Annotations

@Override

computeViewTransform	back to summary
pack-priv void computeViewTransform(Affine3D view) Implements abstract javafx.scene.Camera.computeViewTransform. Annotations @Override

computeViewTransform

back to summary

pack-priv void computeViewTransform(Affine3D view)

Implements abstract javafx.scene.Camera.computeViewTransform.

Annotations

@Override

copy	back to summary
pack-priv Camera copy() Overrides javafx.scene.Camera.copy. Annotations @Override

copy

back to summary

pack-priv Camera copy()

Overrides javafx.scene.Camera.copy.

Annotations

@Override

doCreatePeer	back to summary
private NGNode doCreatePeer()

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

fieldOfViewProperty	back to summary
public final DoubleProperty fieldOfViewProperty()

getFieldOfView	back to summary
public final double getFieldOfView()

isFixedEyeAtCameraZero back to summary

isFixedEyeAtCameraZero	back to summary
public final boolean isFixedEyeAtCameraZero() Returns a flag indicating whether this camera uses a fixed eye position at the origin of the camera. If `fixedEyeAtCameraZero` is `true`, the the eye position is fixed at (0, 0, 0) in the local coordinates of the camera. This attribute is immutable. Returns:boolean a flag indicating whether this camera uses a fixed eye position at the origin of the camera Since JavaFX 8.0

public final boolean isFixedEyeAtCameraZero()

Returns a flag indicating whether this camera uses a fixed eye position at the origin of the camera. If fixedEyeAtCameraZero is true, the the eye position is fixed at (0, 0, 0) in the local coordinates of the camera. This attribute is immutable.

Returns:boolean: a flag indicating whether this camera uses a fixed eye position at the origin of the camera
Since: JavaFX 8.0

isVerticalFieldOfView	back to summary
public final boolean isVerticalFieldOfView()

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

setVerticalFieldOfView	back to summary
public final void setVerticalFieldOfView(boolean value)

verticalFieldOfViewProperty	back to summary
public final BooleanProperty verticalFieldOfViewProperty()

public non-sealed Class PerspectiveCamera

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail