Module io.github.sosuisen.api.jfxbuilder.graphics

Package io.github.sosuisen.jfxbuilder.graphics

Class PickResultBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.PickResultBuilder

public class PickResultBuilder
extends Object

The PickResultBuilder class constructs instances of the PickResult 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 PickResult constructor and returns an instance of the PickResultBuilder.

You can use method chaining to call the builder methods for configuring the PickResult. Finally, invoke the build method to generate an instance of the PickResult 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
PickResultBuilder	apply(Consumer<PickResult> func)	Applies a function to the PickResult instance being constructed.
PickResult	build()	Builds and returns an instance of the PickResult class.
static PickResultBuilder	create(EventTarget target, double sceneX, double sceneY)	Accepts the constructor arguments of PickResult(EventTarget, double, double) and returns an instance of PickResultBuilder.
static PickResultBuilder	create(Node node, Point3D point, double distance)	Accepts the constructor arguments of PickResult(Node, Point3D, double) and returns an instance of PickResultBuilder.
static PickResultBuilder	create(Node node, Point3D point, double distance, int face, Point2D texCoord)	Accepts the constructor arguments of PickResult(Node, Point3D, double, int, Point2D) and returns an instance of PickResultBuilder.
static PickResultBuilder	create(Node node, Point3D point, double distance, int face, Point3D normal, Point2D texCoord)	Accepts the constructor arguments of PickResult(Node, Point3D, double, int, Point3D, Point2D) and returns an instance of PickResultBuilder.

Methods inherited from class java.lang.Object

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

Method Details

create

public static PickResultBuilder create(EventTarget target,
 double sceneX,
 double sceneY)

Accepts the constructor arguments of PickResult(EventTarget, double, double) and returns an instance of PickResultBuilder.

Returns:

an instance of the PickResultBuilder.

create

public static PickResultBuilder create(Node node,
 Point3D point,
 double distance)

Accepts the constructor arguments of PickResult(Node, Point3D, double) and returns an instance of PickResultBuilder.

Returns:

an instance of the PickResultBuilder.

create

public static PickResultBuilder create(Node node,
 Point3D point,
 double distance,
 int face,
 Point2D texCoord)

Accepts the constructor arguments of PickResult(Node, Point3D, double, int, Point2D) and returns an instance of PickResultBuilder.

Returns:

an instance of the PickResultBuilder.

create

public static PickResultBuilder create(Node node,
 Point3D point,
 double distance,
 int face,
 Point3D normal,
 Point2D texCoord)

Accepts the constructor arguments of PickResult(Node, Point3D, double, int, Point3D, Point2D) and returns an instance of PickResultBuilder.

Returns:

an instance of the PickResultBuilder.

build

public PickResult build()

Builds and returns an instance of the PickResult 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 PickResult class

apply

public PickResultBuilder apply(Consumer<PickResult> func)

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

Returns:

builder instance