Class BloomBuilder

java.lang.Object
io.github.sosuisen.jfxbuilder.graphics.BloomBuilder
public class BloomBuilder extends Object
The BloomBuilder class constructs instances of the Bloom 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 Bloom constructor and returns an instance of the BloomBuilder.

You can use method chaining to call the builder methods for configuring the Bloom. Finally, invoke the build method to generate an instance of the Bloom 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 Details

    • create

      public static BloomBuilder create()
      Returns an instance of the BloomBuilder.
      Returns:
      an instance of the BloomBuilder.

    • create

      public static BloomBuilder create(double threshold)
      Accepts the constructor arguments of Bloom(double) and returns an instance of BloomBuilder.
      Returns:
      an instance of the BloomBuilder.

    • build

      public Bloom build()
      Builds and returns an instance of the Bloom 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 Bloom class

    • apply

      public BloomBuilder apply(Consumer<Bloom> func)
      Applies a function to the Bloom instance being constructed. Most operations on the instance can be performed using this method.
      Returns:
      builder instance

    • input

      public BloomBuilder input(Effect value)
      A builder method that invokes the setInput method on the instance being constructed.
      Returns:
      builder instance

    • threshold

      public BloomBuilder threshold(double value)
      A builder method that invokes the setThreshold method on the instance being constructed.
      Returns:
      builder instance

    • inputPropertyApply

      public BloomBuilder 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: 

      // Use apply
.apply(obj -> obj.inputProperty().bind(anotherProperty))

// Use shorthand form
.inputPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • thresholdPropertyApply

      public BloomBuilder thresholdPropertyApply(Consumer<DoubleProperty> op)
      Applies a function to the thresholdProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.thresholdProperty().bind(anotherProperty))

// Use shorthand form
.thresholdPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance