APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene

public Class SnapshotParameters

extends Object
Class Inheritance
Imports
javafx.application.ConditionalFeature, .Platform, javafx.geometry.Rectangle2D, javafx.scene.paint.Paint, javafx.scene.transform.Transform, com.sun.javafx.logging.PlatformLogger

Parameters used to specify the rendering attributes for Node snapshot.
Since
JavaFX 2.2

Field Summary

Modifier and TypeField and Description
private Camera
pack-priv Camera
private boolean
private Paint
private Transform
private Rectangle2D

Constructor Summary

AccessConstructor and Description
public
SnapshotParameters()

Constructs a new SnapshotParameters object with default values for all rendering attributes.

Method Summary

Modifier and TypeMethod and Description
pack-priv SnapshotParameters

Returns:

a clone
copy
()

Returns a deep clone of this SnapshotParameters

public Camera

Returns:

the camera
getCamera
()

Gets the current camera.

pack-priv Camera
public Paint

Returns:

the fill
getFill
()

Gets the current fill.

public Transform

Returns:

the transform
getTransform
()

Gets the current transform.

public Rectangle2D

Returns:

the viewport
getViewport
()

Gets the current viewport

public boolean

Returns:

the depthBuffer flag
isDepthBuffer
()

Gets the current depthBuffer flag.

pack-priv boolean
public void
setCamera(Camera
the camera to set
camera
)

Sets the camera to the specified value.

public void
setDepthBuffer(boolean
the depthBuffer to set
depthBuffer
)

Sets the depthBuffer flag to the specified value.

public void
setFill(Paint
the fill to set
fill
)

Sets the fill to the specified value.

public void
setTransform(Transform
the transform to set
transform
)

Sets the transform to the specified value.

public void
setViewport(Rectangle2D
the viewport to set
viewport
)

Sets the viewport used for rendering.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cameraback to summary
private Camera camera
defaultCameraback to summary
pack-priv Camera defaultCamera
depthBufferback to summary
private boolean depthBuffer
fillback to summary
private Paint fill
transformback to summary
private Transform transform
viewportback to summary
private Rectangle2D viewport

Constructor Detail

SnapshotParametersback to summary
public SnapshotParameters()

Constructs a new SnapshotParameters object with default values for all rendering attributes.

Method Detail

copyback to summary
pack-priv SnapshotParameters copy()

Returns a deep clone of this SnapshotParameters

Returns:SnapshotParameters

a clone

getCameraback to summary
public Camera getCamera()

Gets the current camera.

Returns:Camera

the camera

getEffectiveCameraback to summary
pack-priv Camera getEffectiveCamera()
getFillback to summary
public Paint getFill()

Gets the current fill.

Returns:Paint

the fill

getTransformback to summary
public Transform getTransform()

Gets the current transform.

Returns:Transform

the transform

getViewportback to summary
public Rectangle2D getViewport()

Gets the current viewport

Returns:Rectangle2D

the viewport

isDepthBufferback to summary
public boolean isDepthBuffer()

Gets the current depthBuffer flag.

Returns:boolean

the depthBuffer flag

isDepthBufferInternalback to summary
pack-priv boolean isDepthBufferInternal()
setCameraback to summary
public void setCamera(Camera camera)

Sets the camera to the specified value. The default value is null, which means a ParallelCamera will be used.

Parameters
camera:Camera

the camera to set

setDepthBufferback to summary
public void setDepthBuffer(boolean depthBuffer)

Sets the depthBuffer flag to the specified value. The default value is false. Note that this is a conditional feature. See ConditionalFeature.SCENE3D

Parameters
depthBuffer:boolean

the depthBuffer to set

setFillback to summary
public void setFill(Paint fill)

Sets the fill to the specified value. This is used to fill the entire image being rendered prior to rendering the node. A value of null indicates that the color white should be used for the fill. The default value is null.

Parameters
fill:Paint

the fill to set

setTransformback to summary
public void setTransform(Transform transform)

Sets the transform to the specified value. This transform is applied to the node being rendered before any local transforms are applied. A value of null indicates that the identity transform should be used. The default value is null.

Parameters
transform:Transform

the transform to set

setViewportback to summary
public void setViewport(Rectangle2D viewport)

Sets the viewport used for rendering. The viewport is specified in the parent coordinate system of the node being rendered. It is not transformed by the transform of this SnapshotParameters. If this viewport is non-null it is used instead of the bounds of the node being rendered and specifies the source rectangle that will be rendered into the image. In this case, the upper-left pixel of the viewport will map to the upper-left pixel (0,0) in the rendered image. If the viewport is null, then the entire area of the node defined by its boundsInParent, after first applying the transform of this SnapshotParameters, will be rendered. The default value is null.

Parameters
viewport:Rectangle2D

the viewport to set