Class SnapshotParametersBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.SnapshotParametersBuilder

public class SnapshotParametersBuilder
extends Object

The SnapshotParametersBuilder class constructs instances of the SnapshotParameters class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original SnapshotParameters constructor and returns an instance of the SnapshotParametersBuilder.

You can use method chaining to call the builder methods for configuring the SnapshotParameters. Finally, invoke the build method to generate an instance of the SnapshotParameters class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:

Hidekazu Kubota <hidekazu.kubota@gmail.com>

Method Summary

Modifier and Type	Method	Description
SnapshotParametersBuilder	apply(Consumer<SnapshotParameters> func)	Applies a function to the SnapshotParameters instance being constructed.
SnapshotParameters	build()	Builds and returns an instance of the SnapshotParameters class.
SnapshotParametersBuilder	camera(Camera camera)	A builder method that invokes the setCamera method on the instance being constructed.
static SnapshotParametersBuilder	create()	Returns an instance of the SnapshotParametersBuilder.
SnapshotParametersBuilder	depthBuffer(boolean depthBuffer)	A builder method that invokes the setDepthBuffer method on the instance being constructed.
SnapshotParametersBuilder	fill(Paint fill)	A builder method that invokes the setFill method on the instance being constructed.
SnapshotParametersBuilder	transform(Transform transform)	A builder method that invokes the setTransform method on the instance being constructed.
SnapshotParametersBuilder	viewport(Rectangle2D viewport)	A builder method that invokes the setViewport method on the instance being constructed.

Methods inherited from class java.lang.Object

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

Method Details

create

public static SnapshotParametersBuilder create()

Returns an instance of the SnapshotParametersBuilder.

Returns:

an instance of the SnapshotParametersBuilder.

build

public SnapshotParameters build()

Builds and returns an instance of the SnapshotParameters class.

Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

Returns:

new instance of the SnapshotParameters class

apply

public SnapshotParametersBuilder apply(Consumer<SnapshotParameters> func)

Applies a function to the SnapshotParameters instance being constructed. Most operations on the instance can be performed using this method.

Returns:

builder instance

camera

public SnapshotParametersBuilder camera(Camera camera)

A builder method that invokes the setCamera method on the instance being constructed.

Returns:

builder instance

depthBuffer

public SnapshotParametersBuilder depthBuffer(boolean depthBuffer)

A builder method that invokes the setDepthBuffer method on the instance being constructed.

Returns:

builder instance

fill

public SnapshotParametersBuilder fill(Paint fill)

A builder method that invokes the setFill method on the instance being constructed.

Returns:

builder instance

transform

public SnapshotParametersBuilder transform(Transform transform)

A builder method that invokes the setTransform method on the instance being constructed.

Returns:

builder instance

viewport

public SnapshotParametersBuilder viewport(Rectangle2D viewport)

A builder method that invokes the setViewport method on the instance being constructed.

Returns:

builder instance