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

Package io.github.sosuisen.jfxbuilder.graphics

Class DisplacementMapBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.DisplacementMapBuilder

public class DisplacementMapBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the DisplacementMap. Finally, invoke the build method to generate an instance of the DisplacementMap 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
DisplacementMapBuilder	apply(Consumer<DisplacementMap> func)	Applies a function to the DisplacementMap instance being constructed.
DisplacementMap	build()	Builds and returns an instance of the DisplacementMap class.
static DisplacementMapBuilder	create()	Returns an instance of the DisplacementMapBuilder.
static DisplacementMapBuilder	create(FloatMap mapData)	Accepts the constructor arguments of DisplacementMap(FloatMap) and returns an instance of DisplacementMapBuilder.
static DisplacementMapBuilder	create(FloatMap mapData, double offsetX, double offsetY, double scaleX, double scaleY)	Accepts the constructor arguments of DisplacementMap(FloatMap, double, double, double, double) and returns an instance of DisplacementMapBuilder.
DisplacementMapBuilder	input(Effect value)	A builder method that invokes the setInput method on the instance being constructed.
DisplacementMapBuilder	inputPropertyApply(Consumer<ObjectProperty<Effect>> op)	Applies a function to the inputProperty of the instance being constructed.
DisplacementMapBuilder	mapData(FloatMap value)	A builder method that invokes the setMapData method on the instance being constructed.
DisplacementMapBuilder	mapDataPropertyApply(Consumer<ObjectProperty<FloatMap>> op)	Applies a function to the mapDataProperty of the instance being constructed.
DisplacementMapBuilder	offsetX(double value)	A builder method that invokes the setOffsetX method on the instance being constructed.
DisplacementMapBuilder	offsetXPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the offsetXProperty of the instance being constructed.
DisplacementMapBuilder	offsetY(double value)	A builder method that invokes the setOffsetY method on the instance being constructed.
DisplacementMapBuilder	offsetYPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the offsetYProperty of the instance being constructed.
DisplacementMapBuilder	scaleX(double value)	A builder method that invokes the setScaleX method on the instance being constructed.
DisplacementMapBuilder	scaleXPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the scaleXProperty of the instance being constructed.
DisplacementMapBuilder	scaleY(double value)	A builder method that invokes the setScaleY method on the instance being constructed.
DisplacementMapBuilder	scaleYPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the scaleYProperty of the instance being constructed.
DisplacementMapBuilder	wrap(boolean value)	A builder method that invokes the setWrap method on the instance being constructed.
DisplacementMapBuilder	wrapPropertyApply(Consumer<BooleanProperty> op)	Applies a function to the wrapProperty of 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 DisplacementMapBuilder create()

Returns an instance of the DisplacementMapBuilder.

Returns:

an instance of the DisplacementMapBuilder.

create

public static DisplacementMapBuilder create(FloatMap mapData)

Accepts the constructor arguments of DisplacementMap(FloatMap) and returns an instance of DisplacementMapBuilder.

Returns:

an instance of the DisplacementMapBuilder.

create

public static DisplacementMapBuilder create(FloatMap mapData,
 double offsetX,
 double offsetY,
 double scaleX,
 double scaleY)

Accepts the constructor arguments of DisplacementMap(FloatMap, double, double, double, double) and returns an instance of DisplacementMapBuilder.

Returns:

an instance of the DisplacementMapBuilder.

build

public DisplacementMap build()

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

apply

public DisplacementMapBuilder apply(Consumer<DisplacementMap> func)

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

Returns:

builder instance

input

public DisplacementMapBuilder input(Effect value)

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

Returns:

builder instance

mapData

public DisplacementMapBuilder mapData(FloatMap value)

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

Returns:

builder instance

offsetX

public DisplacementMapBuilder offsetX(double value)

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

Returns:

builder instance

offsetY

public DisplacementMapBuilder offsetY(double value)

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

Returns:

builder instance

scaleX

public DisplacementMapBuilder scaleX(double value)

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

Returns:

builder instance

scaleY

public DisplacementMapBuilder scaleY(double value)

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

Returns:

builder instance

wrap

public DisplacementMapBuilder wrap(boolean value)

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

Returns:

builder instance

inputPropertyApply

public DisplacementMapBuilder inputPropertyApply(Consumer<ObjectProperty<Effect>> op)

Applies a function to the inputProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

mapDataPropertyApply

public DisplacementMapBuilder mapDataPropertyApply(Consumer<ObjectProperty<FloatMap>> op)

Applies a function to the mapDataProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

offsetXPropertyApply

public DisplacementMapBuilder offsetXPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the offsetXProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

offsetYPropertyApply

public DisplacementMapBuilder offsetYPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the offsetYProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

scaleXPropertyApply

public DisplacementMapBuilder scaleXPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the scaleXProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

scaleYPropertyApply

public DisplacementMapBuilder scaleYPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the scaleYProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

wrapPropertyApply

public DisplacementMapBuilder wrapPropertyApply(Consumer<BooleanProperty> op)

Applies a function to the wrapProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance